SpringBoot常用讀取配置文件的3種方法小結

更新時間：2023年10月18日 16:48:39 作者：Bruce1801

本文主要介紹了SpringBoot常用讀取配置文件的3種方法小結,主要包括@Value讀取配置文件,@ConfigurationProperties 讀取配置文件和讀取配置文件中的List,具有一定的參考價值,感興趣的可以了解一下

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

注：這種方法適用于對象的參數(shù)比較少的情況
使用方法：

在類上添加@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>

注：適用于對象的參數(shù)比較多情況下，如果對象的參數(shù)比較多情況下。

在類上添加@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;
    
    @RequestMapping("/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")
public class TestConfig {
   private List<UserTest>users;
}

List中的對象：

對象中的屬性對應配置文件中配置對象的屬性

@Data
public class UserTest {
    private String 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());
        }
    }
}

結果：