一、Spring Boot配置文件中的“陷阱”
Spring Boot的配置文件是指导Spring Boot Application运行的重要文件，是一个全局的配置文件；相比较Spring Spring MVC MyBatis框架的配置文件更加简化，底层默认做了很多配置。Spring Boot的配置文件默认放在resources目录下，且文件名必须为application。
Spring Boot存在两种形式的配置文件分别是properties和yml形式，两种配置文件同时存在的情况下，properties格式的配置文件优先级更高，相比之下yml格式配置文件更加简洁明了紧凑且可读性高，Spring Boot支持并推荐使用yml格式配置文件。
工程搭建
新建一个Maven工程spring-boot-traps，在pom.xml文件中添加依赖以及maven插件，完整的pom.xml文件如下
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.6.3</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.citi</groupId> <artifactId>spring-boot-traps</artifactId> <version>0.0.1-SNAPSHOT</version> <name>spring-traps</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- apache 的一些工具类 --> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.8.1</version> </dependency> </dependencies> <build> <!--指定打成JAR包的名字--> <finalName>${artifactId}</finalName> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <excludes> <exclude> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </exclude> </excludes> </configuration> </plugin> </plugins> </build> </project> 复制代码
在com.citi.spring.traps包下新增主启动类TrapsApplication
@SpringBootApplication public class TrapsApplication { public static void main(String[] args) { SpringApplication.run(TrapsApplication.class,args); } } 复制代码
在test包的相同路径下增加主启动类的测试类TrapsApplicationTest
@SpringBootTest public class TrapsApplicationTest { @Test public void context(){ ApplicationContext context = new AnnotationConfigApplicationContext("com.citi.spring.traps"); String[] beanDefinitionNames = context.getBeanDefinitionNames(); for (String beanDefinitionName : beanDefinitionNames) { System.out.println("容器中的对象:" + beanDefinitionName); } } } 复制代码
执行测试
Spring 容器可以正常运行
配置文件加载顺序的“陷阱”
使用配置文件给实体类赋值
在entity包下新增UserProperties
@Data @Component @ConfigurationProperties(prefix = "traps.user") public class UserProperties { private String name; private Integer age; } 复制代码
@ConfigurationProperties注解可以指定配置文件中配置项的前缀
在application.yml中增加配置
traps: user: name: stark age: 41 复制代码
增加UserProperties的测试类
public class UserPropertiesTest extends TrapsApplicationTest { @Autowired private UserProperties userProperties; @Test public void getProperty(){ System.out.println(userProperties); } } 复制代码
执行测试
根据控制台打印日志，可以看出UserProperties被成功赋值
配置文件优先级
- 工程目录下/config/application.yml，优先级最高
- 工程目录下/application.yml，优先级第二
- resources/config/application.yml，优先级第三
- resources/application.yml，优先级第四
不同位置都放置了配置文件，高优先级的配置会覆盖低优先级的配置，多个配置文件是互补的，即取多个文件的并集
验证配置文件优先级
在resource目录下新建config文件夹，增加application.yml
traps: user: name: stark in resources/config/ age: 41 复制代码
执行测试
根据控制台打印出的日志，可以确定resources目录下的application.yml被config目录下的application.yml覆盖了
在工程下目录下新增application.yml
traps: user: name: stark in root/ age: 41 复制代码
执行测试
根据控制台日志打印，可以确定工程根目录下的配置文件覆盖了resource目录下的两个配置文件
在工程根目录下新建config目录，在config目录下新增application.yml
traps: user: name: stark in root/config/ age: 41 复制代码
执行测试
根据控制台日志打印，可以确定工程根目录下config文件下的配置文件的优先级是最高的
