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

目录

• 1、使用 @Value 读取配置文件
• 2、 使用 @ConfigurationProperties 读取配置文件
• 3、读取配置文编程件中的List

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

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

使用方法：

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

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

application.yml

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

ValueConfig.Java

@Configuration
@Data
public class ValueConfig {
    @Value("${spring.test.name}")
    private String name;

    @Value("${spring.test.age}")
    private int age;

    @Value("${spring.test.phone}")
    private String phone;

}

BasicController.java

@Controller
public class BasicController {

	@Autowired编程客栈
    private ValueConfig valueConfig;

    @RequestMapping("/test_valueConfig")
    @ResponseBody
    public String valueConfig(){
        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>

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

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

配置文件同上；

TestConfig.java

@Data
@Configuration
@ConfigurationProperties(prefix = "spring.test")
public class TestConfig {

    private String name;

    private int age;

    private String phone;
}

BasicController.java

@Controller
public class BasicController {

    @Autowired
    private TestConfig testConfig;
    
    @RequestMpythonapping("/test_config")
    @ResponseBody
    public String testConfig(){
        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: 17
      phone: 123456
    - name: bruce
      age: 18
      phone: 456789

配置类：

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

@Data
@Configuration
@ConfigurationProperties(prefix = "spring.test")
pubwww.devze.comlic class TestConfig {
   private List<UserTest>users;
}

List中的对象：

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

@Data
public class UserTest {
    private StrqhBbBZXing name;

    private int age;

    private String phone;
}

测试：

@Controller
public class BasicController {

    @Autowired
    private TestConfig testConfig;

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

结果：

到此这篇关于SpringBoot常用读取配置文件的3种方法小结的文章就介绍到这了,更多相关SpringBoot 读取配置文件内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！