Spring Boot 核心配置文件

• 1、application.properties
• 2、application.yml
• • 使用建议
• 3、常用配置项
• • 服务器配置
  • 数据库配置
  • 日志配置
  • 其他配置
• 4、配置文件的加载顺序
• 5、配置文件的占位符
• 6、配置文件的动态刷新
• 7、配置文件的属性分组
• • 定义属性分组
  • 绑定属性分组
  • 使用属性分组
• 总结

Spring Boot 是一个基于 Spring 框架的快速开发、简化配置、约定优于配置的框架。在 Spring Boot 应用中，核心配置文件是 application.properties或 application.yml，这两个文件都可以用来配置应用程序的属性和环境。

1、application.properties

application.properties 是基于属性文件的配置格式，支持 key-value 形式的键值对。在 Spring Boot 中，可以在 application.properties 文件中配置各种应用程序属性，如端口号、数据库连接、日志级别等等。

以下是 application.properties 的一个示例：

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root
logging.level.org.springframework=DEBUG

上面的示例中，配置了应用程序的端口号为 8080，数据库连接为 MySQL 数据库，日志级别为 DEBUG 等。

2、application.yml

application.yml 是基于 YAML 格式的配置文件，支持层级结构的配置形式，可以更加清晰地表达配置项之间的关系。与 application.properties 相比，application.yml 更易读、易维护，也更加灵活。

以下是 application.yml 的一个示例：

server:port: 8080
spring:datasource:url: jdbc:mysql://localhost:3306/mydbusername: rootpassword: root
logging:level:org.springframework: DEBUG

上面的示例中，与 application.properties 的示例配置项相同，但是使用了 YAML 格式的层级结构。在 YAML 中，使用缩进来表示层级关系，比如 spring.datasource.url 就是 spring 的子级，datasource 是 spring 的子级，url 是 datasource 的子级。

使用建议

尽量使用 application.yml，因为它更加灵活、易读、易维护；对于简单的配置项，可以使用 application.properties；在编写配置文件时，注意缩进和空格的使用，这是 YAML 格式的重要特点；在配置文件中，可以使用 @Value 注解来注入配置属性，也可以使用 @ConfigurationProperties 来批量注入配置属性。

3、常用配置项

以下是一些常用的 Spring Boot 配置项：

服务器配置

server.port：应用程序监听的端口号，默认为 8080；
server.servlet.context-path：应用程序的上下文路径，默认为空；
server.tomcat.access-log-enabled：是否开启访问日志，默认为 false。

数据库配置

spring.datasource.url：数据库连接 URL；
spring.datasource.username：数据库用户名；
spring.datasource.password：数据库密码；
spring.datasource.driver-class-name：数据库驱动类名；
spring.datasource.hikari.*：Hikari 连接池的配置项。

日志配置

logging.level.*：设置日志级别，可以针对不同的包设置不同的日志级别；
logging.file.name：指定日志文件名；
logging.file.path：指定日志文件路径；
logging.pattern.console：设置控制台日志输出格式；
logging.pattern.file：设置文件日志输出格式。

其他配置

spring.profiles.active：指定应用程序的活动配置文件，如 dev、prod 等；
spring.main.allow-bean-definition-overriding：是否允许 Bean 覆盖，默认为 false；
spring.main.banner-mode：设置启动时显示的 Banner 模式，如 off、console、log 等。

4、配置文件的加载顺序

在 Spring Boot 中，配置文件有多种加载方式，包括：

• classpath:/ 下的 application.properties 或 application.yml；
• classpath:/config/ 下的 application.properties 或 application.yml；
• 外部配置文件，如 /etc/myapp/application.properties 或 file:///opt/myapp/application.yml。

这些配置文件的加载顺序是：

• classpath:/config/application.yml（或 .properties）；
• classpath:/application.yml（或 .properties）；
• 外部配置文件。

其中，1 和 2 的顺序可以颠倒，即先加载 classpath:/application.yml（或 .properties），再加载 classpath:/config/application.yml（或 .properties）。

如果同时存在多个配置文件，会按照上述顺序进行合并，后面的配置会覆盖前面的配置。

5、配置文件的占位符

在配置文件中，可以使用 ${…} 形式的占位符来引用其他配置属性的值。例如：

server:port: 8080
myapp:name: myappversion: 1.0greeting: Hello, ${myapp.name} ${myapp.version}!

上面的示例中，myapp.greeting 属性使用了 ${myapp.name} 和 ${myapp.version} 占位符来引用其他属性的值。

6、配置文件的动态刷新

在 Spring Boot 应用程序中，如果想要动态地刷新配置文件，可以使用 @RefreshScope 注解。该注解会在配置文件变化时，自动更新注入该注解的 Bean。

@RestController
@RefreshScope
public class MyController {@Value("${myapp.greeting}")private String greeting;@GetMapping("/greeting")public String greeting() {return greeting;}
}

上面的示例中，使用了 @RefreshScope 注解来动态刷新 greeting 属性的值。当 myapp.name 或 myapp.version 属性变化时，greeting 属性的值也会随之变化。

7、配置文件的属性分组

在实际开发中，应用程序的配置文件可能会变得非常复杂，属性的数量也会很多。为了更好地组织和管理属性，可以使用 Spring Boot 的属性分组功能。

定义属性分组

在配置文件中，可以使用 @ConfigurationProperties 注解来定义属性分组。例如：

@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {private String name;private String version;// getters and setters
}

上面的示例中，使用 @ConfigurationProperties 注解定义了一个名为 myapp 的属性分组，并声明了 name 和 version 两个属性。在 application.yml 文件中，可以通过 myapp.name 和 myapp.version 来访问这两个属性的值。

绑定属性分组

在 Spring Boot 中，可以通过 @EnableConfigurationProperties 或 @ConfigurationPropertiesScan 注解来绑定属性分组。例如：

@SpringBootApplication
@EnableConfigurationProperties(MyAppProperties.class)
public class MyAppApplication {// ...
}

上面的示例中，使用 @EnableConfigurationProperties 注解来绑定了 MyAppProperties 属性分组。

使用属性分组

在应用程序中，可以使用 @Autowired 或 @Inject 注解来注入属性分组。例如：

@RestController
public class MyController {@Autowiredprivate MyAppProperties myAppProperties;@GetMapping("/info")public MyAppProperties info() {return myAppProperties;}
}

上面的示例中，使用 @Autowired 注解注入了 MyAppProperties 属性分组，并在 info 接口中返回了该属性分组的值。

总结

在 Spring Boot 中，可以通过属性分组来组织和管理配置文件中的属性。使用 @ConfigurationProperties 解定义属性分组，使用 @EnableConfigurationProperties 或 @ConfigurationPropertiesScan 注解来绑定属性分组，在应用程序中使用 @Autowired 或 @Inject 注解注入属性分组。通过合理地使用属性分组，可以使应用程序的配置更加清晰、易维护、易扩展。