涿州做软件和网站的,锐捷网络公司排名,阿里域名注册查询,织梦网站必须下载地址文章目录 前言一、配置文件的作用二、配置文件的格式2.1 Spring Boot 配置文件格式2.2 properties 和 yml 的区别 三、properties 配置文件3.1 properties 基本语法3.2 配置文件的读取3.3 properties 优缺点分析 四、yml 配置文件说明4.1 yml 基本语法4.2 yml 使用案例4.3 yml … 文章目录 前言一、配置文件的作用二、配置文件的格式2.1 Spring Boot 配置文件格式2.2 properties 和 yml 的区别 三、properties 配置文件3.1 properties 基本语法3.2 配置文件的读取3.3 properties 优缺点分析 四、yml 配置文件说明4.1 yml 基本语法4.2 yml 使用案例4.3 yml 优缺点分析 五、设置不同环境中的配置文件 前言
配置文件在软件开发中扮演着重要的角色它允许我们在不改变源代码的情况下对应用程序的行为进行调整和配置。对于 Spring Boot 这样的现代框架而言配置文件更是其灵活性和易用性的关键所在。通过合理配置我们可以将应用程序从开发环境无缝迁移到测试和生成环境同时为不同的部署环境提供特定的配置。
本文将深入探讨 Spring Boot 配置文件的各个方面从基本语法到不同环境下的设置帮助读者全面理解和灵活应用配置文件的相关知识。接下来我将逐步介绍配置文件的不同方面让我们一起踏上这趟关于 Spring Boot 配置的探索之旅。
一、配置文件的作用
配置文件是一种外部化配置的方式用于存储应用程序的参数、选项和设置等信息。配置文件的主要作用如下 灵活性和可配置性通过将配置信息从代码中分离出来应用程序变得更加灵活和可配置。这意味着我们可以在不修改代码的情况下通过简单地修改配置文件来调整应用程序的行为从而满足不同的业务需求和环境要求。 降低耦合度将配置信息外部化后应用程序的不同组件之间的依赖性减少。这样当需要更改某个配置时只需修改配置文件而不会影响到其他部分的代码降低了代码之间的耦合度使代码更易于维护和扩展。 方便部署和管理通过配置文件我们可以将应用程序的设置与代码分离这样在部署时只需替换或更新配置文件而无需重新编译整个代码。同时不同环境中的配置可以通过不同的配置文件来管理从而简化了应用程序在不同环境中的部署和管理。 安全性敏感信息如数据库密码、API密钥等通常不应该硬编码在代码中而是存储在配置文件中。这样可以避免将敏感信息暴露在代码仓库或发布的应用程序中提高了应用程序的安全性。 国际化和本地化配置文件可以用于存储不同语言版本的文字和本地化信息。这样应用程序可以根据用户的语言环境读取相应的配置文件从而实现国际化和本地化的需求。
二、配置文件的格式
2.1 Spring Boot 配置文件格式
Spring Boot 支持多种配置文件格式常见的有 properties 和 ymlYAML两种格式。不同的格式适用于不同的场景开发人员可以根据实际需求选择适合自己的配置文件格式。
1. properties 格式
properties 是一种键值对的文本格式每一行包含一个属性和对应的值。它的格式类似于keyvalue。在 Spring Boot 中可以使用 properties 格式配置各种属性。例如
spring.datasource.urljdbc:mysql://localhost:3306/mydb
spring.datasource.usernamemyusername
spring.datasource.passwordmypassword
server.port80802. ymlYAML格式
YAML 是一种简洁、易读的数据序列化格式它的全称 Yet Another Markup Language翻译成中文就是 “另⼀种标记语言”。它是以缩进的形式来表示层级关系同时支持列表和映射等数据结构。在 Spring Boot 中yml 格式的配置文件通常以 .yml 或者 .yaml为后缀。与 properties 格式相比yml 格式更加灵活和易于书写。例如
spring:datasource:url: jdbc:mysql://localhost:3306/mydbusername: myusernamepassword: mypassword
server:port: 8080在 Spring Boot 项目中理论上可以同时使用 properties 和 yml 格式的配置文件它们可以共存于同一个项目中。当 properties 和 yml 配置文件同时存在且有相同的配置项时properties 文件中的配置将具有优先级即会覆盖 yml 文件中的同名配置。 这种配置优先级的机制使得开发人员可以更灵活地选择使用 properties 或 yml 格式来配置不同的参数而且可以在不同的配置文件中组织和管理不同类型的配置信息。例如可以将常规的、较为简单的配置项放在 properties 文件中而将复杂的、结构化的配置项放在 yml 文件中以提高可读性和维护性。 然而尽管理论上允许使用两种格式的配置文件但在实际项目中通常会选择一种统一的配置文件格式。这样做有以下好处 统一维护使用统一的配置文件格式可以降低维护成本减少混乱和错误。所有的配置信息都集中在同一种格式中更便于开发团队统一维护和管理。 降低故障率统一的配置文件格式避免了不同格式之间的转换和适配问题减少了潜在的错误和故障。 易读性使用统一的配置文件格式可以提高团队成员之间的沟通和理解减少因格式差异带来的困扰。 规范化统一的配置文件格式有助于形成规范和最佳实践提高项目的可维护性和稳定性。
2.2 properties 和 yml 的区别
在选择配置文件格式时可以根据以下几个方面来进行考虑 语法结构properties 格式使用简单的键值对结构适合简单的配置场景。而 yml 格式使用缩进表示层级关系可以更清晰地展现复杂的配置结构适合处理较为复杂的配置。 易读性yml 格式由于其缩进结构更易读和维护。相比之下properties 格式可能在配置较多或嵌套较深时显得冗长和不够直观。 扩展性yml 格式支持更丰富的数据结构如列表和映射这使得它在处理复杂配置时更加灵活。而 properties 格式只能表示简单的键值对。 键名约束properties 格式中的键名不能包含空格且需要遵循一定的命名规范。而 yml 格式中的键名可以包含空格更加灵活。
总体而言对于简单的配置properties 格式可能更加直观和方便而对于复杂的配置yml 格式的可读性和灵活性使其成为更好的选择。在实际应用中根据项目的需求和团队的偏好选择合适的配置文件格式是很重要的决策。Spring Boot 提供了对两种格式的全面支持可以根据项目的实际情况进行选择和使用。
三、properties 配置文件
3.1 properties 基本语法
properties 配置文件是一种简单的键值对文本格式每一行都包含一个属性和对应的值使用等号 “” 来连接键名和键值。基本语法如下
# 配置项目的端口号
server.port8084
spring.datasource.urljdbc:mysql://127.0.0.1:3306/testdb?characterEncoding
utf8
spring.datasource.usernameroot
spring.datasource.passwordrootPS: 在配置文件中使用 “#” 来添加注释信息。 3.2 配置文件的读取
Value 和 ConfigurationProperties 是 Spring Boot 中用于读取配置值的两种常用方式它们都可以用于将配置文件中的属性值绑定到 Java 对象中方便在代码中使用。
1. Value 注解
Value 是 Spring 框架中的一个注解它可以直接用于将配置文件中的属性值注入到 Spring Bean 中的属性上。通过在属性上使用 Value 注解并指定属性的键名如 ${key}Spring Boot 将会自动从配置文件中读取对应的值并赋值给属性。
假设我们有一个 application.properties 配置文件内容如下
app.nameMy Application
app.version1.0.0然后我们可以在 Spring Bean 中使用 Value 注解来读取这些配置项
Component
public class MyBean {Value(${app.name})private String appName;Value(${app.version})private String appVersion;PostConstructpublic void doPostConstruct(){System.out.println(appName: appName);System.out.println(appVersion: appVersion);}
}上述代码表示创建一个 MyBean它使用Value注解来读取配置文件中的属性值并在 PostConstruct 注解标注的方法中打印出读取到的属性值。运行启动类就可以看到控制台打印出相关的配置信息
2. ConfigurationProperties 注解
ConfigurationProperties 是 Spring Boot 提供的专用于读取配置文件属性的注解。它可以将配置文件中的属性值绑定到 Java 对象中的对应属性上并提供了更加灵活的配置项绑定功能。需要注意的是使用 ConfigurationProperties 注解时需要提供一个 prefix 参数用于指定配置文件中属性的前缀以便进行属性的匹配。
假设我们有一个 application.properties 配置文件内容如下
app.nameMy Application
app.version1.0.0然后我们可以创建一个 Java 类并使用 ConfigurationProperties 注解来读取这些配置项
Component
Setter
ConfigurationProperties(app)
public class AppConfig {private String name;private String version;PostConstructpublic void init() {System.out.println(appName: name);System.out.println(appVersion: version);}
}在上述示例中ConfigurationProperties(prefix app) 指定了配置文件中的属性前缀为 “app”Spring Boot 将会自动读取以 “app” 为前缀的配置项并将对应的值赋值给 AppConfig 类的相应属性。 注意此时一定要提供 Setter 方法才行此处我使用的是Lombok工具中的 Setter 注解为我提供 Setter 方法。 运行启动类
二者的区别
Value 注解用于直接将配置文件中的某个属性值注入到一个 Spring Bean 的属性上。适用于简单的配置项读取。ConfigurationProperties 注解用于将配置文件中的多个属性值绑定到一个 Java 对象中的多个属性上提供了更灵活的配置项绑定功能支持复杂数据结构的配置。适用于复杂的配置项读取。
综上所述Value 和 ConfigurationProperties 都是常用的读取配置值的方式选择使用哪种方式取决于实际需求和配置项的复杂程度。
3.3 properties 优缺点分析
3.3 properties 优缺点分析
优点 简单直观properties 配置文件采用简单的键值对格式易于书写和阅读对于简单的配置项非常直观和方便。 广泛支持properties 格式是一种通用的配置文件格式在绝大多数编程语言和框架中都得到支持因此适用于各种应用场景。 配置清晰由于 properties 配置文件以键值对的形式表示配置项和配置值的对应关系使得配置清晰明了易于维护和修改。 快速读取properties 配置文件的格式简单读取速度较快对于快速获取配置信息较为高效。
缺点 缺乏结构properties 配置文件只支持简单的键值对结构无法表示复杂的数据结构如嵌套对象和列表等。当配置项较为复杂时可能不够灵活。 键名限制properties 配置文件中的键名不能包含空格等特殊字符且需要遵循一定的命名规范不够灵活。 不支持多行值properties 配置文件中的值必须写在一行中不支持跨行表示配置值这在配置较长的文本时可能显得不够便捷。
综上所述properties 配置文件是一种简单实用的配置格式适用于简单的配置场景。然而properties 格式有一些明显的缺点如缺乏结构、键名限制、冗余等这些缺点在配置项较为复杂时可能会限制其使用。在实际开发中根据项目的配置复杂性和需求可以选择更为灵活的配置文件格式如 yml 格式来满足更复杂的配置需求。
四、yml 配置文件说明
4.1 yml 基本语法
yml 格式使用缩进表示层级关系支持列表和映射等数据结构以及注释和多行文本等特性。基本语法如下
键值对
key1: value1
key2: value2列表
key3:- item1- item2嵌套映射
key4:subkey1: value1subkey2: value2多行文本
key5: |This is a multiline text.It can span multiple lines without escaping special characters.注释
# This is a comment.
key6: value6 # This is another comment.yml 配置文件的读取和 properties 配置文件读取方法一致。
4.2 yml 使用案例
假设我们有一个 application.yml 配置文件内容如下
app:name: My Applicationversion: 1.0.0author: 张三server:port: 8080database:url: jdbc:mysql://localhost:3306/mydbusername: myusernamepassword: mypassword在上述案例中yml 格式的配置文件展示了多种常用的配置方式。app 部分是一个映射包含了应用程序的名称、版本和作者等属性。server 部分是一个简单的键值对指定了项目的启动端口。database 部分是一个嵌套映射包含了数据库连接的相关属性。
4.3 yml 优缺点分析
优点 灵活易读yml 格式使用缩进表示层级关系易于阅读和书写。支持列表、映射和多行文本等特性能够更清晰地展现复杂的配置结构提高了配置文件的可读性和可维护性。 支持复杂数据结构yml 格式支持列表和嵌套映射可以表示更为复杂的数据结构适用于处理复杂的配置项。 支持注释yml 格式允许添加注释可以在配置文件中添加解释性的注释信息便于理解和说明配置项的含义。 不受键名限制yml 格式中的键名可以包含空格等特殊字符不需要遵循特定的命名规范更加灵活。
缺点 学习成本相对于 properties 格式yml 格式的语法可能较为复杂对于初学者需要花费一些时间来适应和学习。 易出错由于 yml 格式依赖于缩进表示层级关系如果缩进不正确可能会导致配置解析错误增加了出错的可能性。
综上所述yml 配置文件是一种灵活、易读的配置格式适用于复杂的配置场景。它的优点在于灵活易读、支持复杂数据结构、支持注释和不受键名限制能够提高配置文件的可读性和维护性。然而yml 格式也有一些缺点如学习成本较高和易出错需要开发
五、设置不同环境中的配置文件
在 Spring Boot 中可以通过不同的配置文件来区分不同的环境如开发环境、测试环境和生产环境。Spring Boot 默认会加载 application.yml或 application.properties作为主配置文件但可以根据不同的环境加载不同的配置文件。通过命名规则可以让 Spring Boot 自动识别并加载对应的环境配置文件。 在 Spring Boot 中设置不同环境中的 yml 配置文件可以通过命名规则来实现。以下是针对开发环境、测试环境和生产环境的配置文件命名规则。 开发环境配置文件application-{profile}.yml 命名示例application-dev.yml{profile} 部分为环境名称例如devdevelopment等等。 测试环境配置文件application-{profile}.yml 命名示例application-test.yml{profile} 部分为环境名称例如testtesting等等。 生产环境配置文件application-{profile}.yml 命名示例application-prod.yml{profile} 部分为环境名称例如prodproduction等等。 根据上述命名规则当启动 Spring Boot 应用程序时可以通过设置 spring.profiles.active 属性来指定当前激活的环境配置。例如设置 spring.profiles.activedev 将加载 application-dev.yml 中的配置而设置 spring.profiles.activeprod 将加载 application-prod.yml 中的配置。 假设我们有三个环境开发环境、测试环境和生产环境。我们可以按照以下方式创建对应的配置文件
application-dev.yml开发环境配置文件application-test.yml测试环境配置文件application-prod.yml生产环境配置文件
在这些配置文件中可以针对不同的环境设置相应的配置项。例如
application-dev.yml
app:name: My Dev Applicationserver:port: 8080debug: true
application-test.yml
app:name: My Test Applicationserver:port: 8081debug: true
application-prod.yml
app:name: My Production Applicationserver:port: 8082debug: false
主配置文件 application.yml
app:name: My Applicationversion: 1.0.0spring:profiles:default: dev这样在不同的环境中启动 Spring Boot 应用程序时Spring Boot 会自动根据 spring.profiles.active 的值加载对应的配置文件。例如设置为 dev 时会加载 application-dev.yml 中的配置设置为 test 时会加载 application-test.yml 中的配置设置为 prod 时会加载 application- prod.yml 中的配置。 在实际部署和运行应用程序时只需要修改 spring.profiles.active 的值为对应的环境名称就可以使用相应的配置。这种方式使得应用程序的配置在不同环境中更加灵活和方便切换。
