总结SpringBoot常用读取配置文件的3种方法

文章目录

1、使用 @Value 读取配置文件

注：这种方法适用于对象的参数比较少的情况

使用方法：

1. 在类上添加@configuration注解，将这个配置对象注入到容器中。哪里需要用到，通过 @Autowired 注入进去就可以获取属性值了。
2. 在对象的属性上添加@Value注解，以 ${} 的形式传入配置文件中对应的属性

添加@Data注解是为了方便测试有没有读取到
application.yml

spring:
  test:
    name: yuanhaozhe
    age:18
    phone:1763173xxxx

ValueConfig.java

@Configuration@DatapublicclassValueConfig{@Value("${spring.test.name}")privateString name;@Value("${spring.test.age}")privateint age;@Value("${spring.test.phone}")privateString phone;}

BasicController.java

@ControllerpublicclassBasicController{@AutowiredprivateValueConfig valueConfig;@RequestMapping("/test_valueConfig")@ResponseBodypublicStringvalueConfig(){return"name:".concat(valueConfig.getName()).concat(";age:").concat(String.valueOf(valueConfig.getAge())).concat(";phone:").concat(valueConfig.getPhone());}}

结果：

2、 使用 @ConfigurationProperties 读取配置文件

在pom文件中添加相应注解：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional></dependency>

注：适用于对象的参数比较多情况下，如果对象的参数比较多情况下。

1. 在类上添加@ConfigurationProperties注解，声明当前类为配置读取类
2. 在注解的括号中，设置要读取属性的前缀：prefix
3. 添加@Configuration注解，将这个配置对象注入到容器中。（或者@Controller、@RestController、@Service、@Componet等注解）

配置文件同上；
TestConfig.java

@Data@Configuration@ConfigurationProperties(prefix ="spring.test")publicclassTestConfig{privateString name;privateint age;privateString phone;}

BasicController.java

@ControllerpublicclassBasicController{@AutowiredprivateTestConfig testConfig;@RequestMapping("/test_config")@ResponseBodypublicStringtestConfig(){return"name:".concat(testConfig.getName()).concat(";age:").concat(String.valueOf(testConfig.getAge())).concat(";phone:").concat(testConfig.getPhone());}}

结果：

3、读取配置文件中的List

如何配置List：

spring:test:users:-name: yuanhaoz
      age:17phone:123456-name: bruce
      age:18phone:456789

配置类：

类中的users对应配置文件中的users，可以理解为在配置文件对应前缀下按名字获取属性

@Data@Configuration@ConfigurationProperties(prefix ="spring.test")publicclassTestConfig{privateList<UserTest>users;}

List中的对象：

对象中的属性对应配置文件中配置对象的属性

@DatapublicclassUserTest{privateString name;privateint age;privateString phone;}

测试：

@ControllerpublicclassBasicController{@AutowiredprivateTestConfig testConfig;@RequestMapping("/test_config")@ResponseBodypublicvoidtestConfig(){List<UserTest> users = testConfig.getUsers();for(UserTest user:users){System.out.println(user.toString());}}}

结果：