SpringBoot從配置文件中獲取屬性的四種方法總結
更新時間：2022年02月26日 08:41:32 作者：ManaphyChen
這篇文章主要介紹了SpringBoot從配置文件中獲取屬性的四種方法總結，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
方式一: @Value
基本類型屬性注入，直接在字段上添加@Value("${xxx.xxx}")即可．注意這里用的是$,而不是＃．@Value注入的屬性，一般其他屬性沒有關聯(lián)關系．
配置文件
user: name: Manaphy age: 19 sex: male
方式二: @ConfigurationProperties
配置文件
@RestController
public class ConfigPropertiesController {
@Value("${user.name}")
private String name;
@Value("${user.age}")
private Integer age;
@Value("${user.sex}")
private String sex;
@GetMapping("/user")
public String getUser() {
return "{name:" + name + ",age:" + age + ",sex:" + sex + "}";
}
}
JavaBean
/**
* 將配置文件中配置的每一個屬性的值，映射到這個組件中
* @ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定;
* prefix = "person"：配置文件中哪個下面的所有屬性進行一一映射
* 只有這個組件是容器中的組件，才能容器提供的@ConfigurationProperties功能
*/
@Component
@ConfigurationProperties(prefix = "person")
@Data
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String, Object> maps;
private List<Object> lists;
private Dog dog;
}
@Data
class Dog {
private String name;
private Integer age;
}
Controller層
@RestController
public class PersonController {
@Autowired
private Person person;
@GetMapping("/person")
public Person getPerson() {
return person;
}
}
運行結果如下
我們可以導入配置文件處理器，以后編寫配置就有提示了
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
@Value和@ConfigurationProperties比較
| @ConfigurationProperties | @Value | |
|---|---|---|
| 功能 | 批量注入配置文件中的屬性 | 一個個指定 |
| 松散綁定（松散語法） | 支持 | 不支持 |
| SpEL | 不支持 | 支持 |
| JSR303數(shù)據(jù)校驗 | 支持 | 不支持 |
| 復雜類型封裝 | 支持 | 不支持 |
配置文件yml還是properties他們都能獲取到值；
如果說，我們只是在某個業(yè)務邏輯中需要獲取一下配置文件中的某項值，使用@Value；
如果說，我們專門編寫了一個javaBean來和配置文件進行映射，我們就直接使用@ConfigurationProperties；
方式三: @PropertySource
配置文件
person.lastName=chen person.age=22 person.boss=false person.birth=2017/12/12 person.map1.k1=v1 person.map1.k2=v2 person.map2[k1]=v1 person.map2[k2]=v2 person.list[0]=zhang person.list[1]=wang person.list2=zhao,qian,sun,li person.dog.name=小狗 person.dog.age=12
JavaBean
@Component
@ConfigurationProperties(prefix = "person")
//如果只有一個主配置類文件，@PropertySource可以不寫
@PropertySource("classpath:person.properties")
@Data
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String, Object> map1;
private Map<String, Object> map2;
private List<Object> list;
private List<Object> list2;
private Dog dog;
}
@Data
class Dog {
private String name;
private Integer age;
}
測試同方式二
方式四: 使用工具類 無需注入獲取.yml中的值
新建 BeanConfiguration 類，用于項目啟動構造我們的工具類
@Configuration
@Slf4j
public class BeanConfiguration {
@Bean
public YamlConfigurerUtil ymlConfigurerUtil() {
//1:加載配置文件
Resource app = new ClassPathResource("application.yml");
Resource appDev = new ClassPathResource("application-dev.yml");
Resource appProd = new ClassPathResource("application-prod.yml");
YamlPropertiesFactoryBean yamlPropertiesFactoryBean = new YamlPropertiesFactoryBean();
// 2:將加載的配置文件交給 YamlPropertiesFactoryBean
yamlPropertiesFactoryBean.setResources(app);
// 3：將yml轉換成 key：val
Properties properties = yamlPropertiesFactoryBean.getObject();
String active = null;
if (properties != null) {
active = properties.getProperty("spring.profiles.active");
}
if (StringUtils.isEmpty(active)) {
log.error("未找到spring.profiles.active配置！");
} else {
//判斷當前配置是什么環(huán)境
if ("dev".equals(active)) {
yamlPropertiesFactoryBean.setResources(app, appDev);
} else if ("prod".equals(active)) {
yamlPropertiesFactoryBean.setResources(app, appProd);
}
}
// 4: 將Properties 通過構造方法交給我們寫的工具類
return new YamlConfigurerUtil(yamlPropertiesFactoryBean.getObject());
}
}
工具類實現(xiàn)
public class YamlConfigurerUtil {
? ? private static Properties ymlProperties = new Properties();
? ? public YamlConfigurerUtil(Properties properties) {
? ? ? ? ymlProperties = properties;
? ? }
? ? public static String getStrYmlVal(String key) {
? ? ? ? return ymlProperties.getProperty(key);
? ? }
? ? public static Integer getIntegerYmlVal(String key) {
? ? ? ? return Integer.valueOf(ymlProperties.getProperty(key));
? ? }
}調用示例
@RestController
public class PersonController {
? ? @GetMapping("/msg")
? ? public String getMessage() {
? ? ? ? return YamlConfigurerUtil.getStrYmlVal("person.lastName");
? ? }
}以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
Java?圖片處理庫提供了豐富的功能,用于處理和增強圖像,在Java生態(tài)系統(tǒng)中,有幾個流行的開源庫可以用于圖片處理,這些庫提供了豐富的功能,如圖像縮放、裁剪、顏色調整、格式轉換等,本文介紹開源的Java圖片處理庫介紹,感興趣的朋友一起看看吧2024-03-03
SpringCloud:feign對象傳參和普通傳參及遇到的坑解決
這篇文章主要介紹了SpringCloud:feign對象傳參和普通傳參及遇到的坑解決，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-03-03
這篇文章主要為大家詳細介紹了Spring Boot發(fā)送郵件的相關資料，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-11-11
這篇文章主要介紹了Java程序執(zhí)行cmd命令全過程,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01
這篇文章主要介紹了Java實現(xiàn)復制文件并命名的超簡潔寫法，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-11-11
Mybatis collection查詢集合屬性報錯的解決方案
這篇文章主要介紹了Mybatis collection查詢集合屬性報錯的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要為大家詳細介紹了Java實現(xiàn)簡易學生管理系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-07-07
SpringMVC五種類型參數(shù)傳遞及json傳遞參數(shù)
本文主要介紹了SpringMVC五種類型參數(shù)傳遞及json傳遞參數(shù)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-07-07
SpringBoot整合RabbitMQ及生產(chǎn)全場景高級特性實戰(zhàn)
本文主要介紹了SpringBoot整合RabbitMQ及生產(chǎn)全場景高級特性實戰(zhàn)，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-10-10
SpringBoot線上環(huán)境徹底關閉Swagger-UI的方式
這篇文章主要給大家介紹了SpringBoot線上環(huán)境徹底關閉Swagger-UI的方式,文中給出了詳細的代碼示例供大家參考,對大家的學習或工作有一定的幫助,需要的朋友可以參考下2023-12-12