SpringBoot 如何從配置文件讀取值到對象中
一、實(shí)現(xiàn)方式
@ConfigurationProperties 注解
（最好加上前綴prefix=“person”,標(biāo)明是和配置文件中哪個開頭的屬性匹配）
推薦使用用在類上，從配置文件讀取屬性值，放到對象里面，復(fù)雜的結(jié)構(gòu)也適用例如map,list，對象。支持校驗(yàn):@Validated
@Valid注解
用在屬性上，需要每個屬性逐個綁定通過@value注解獲取配置文件的值,不適合做復(fù)雜類型（map,list ,對象）值得獲取不支持@Validated
二、兩者區(qū)別
三、代碼演示
使用@ConfigurationProperties注解
package com.wx.springboot20190911.demo.model;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 1.ConfigurationProperties注解 從配置文件讀取屬性值，放到對象里面
* 2.通過@value注解獲取配置文件的值
*/
@Component//perosn 需要納入spring ioc 容器里
@ConfigurationProperties(prefix = "person")//使用前綴標(biāo)明具體的屬性
@Validated
public class Person {
@Email
String email;
String hello;
String name;
int age;
boolean boss;
Date birth;
Map<String,String> maps;
List<String> list;
Dog dog;
@Override
public String toString() {
return "Person{" +
"email='" + email + '\'' +
", hello='" + hello + '\'' +
", name='" + name + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", list=" + list +
", dog=" + dog +
'}';
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public String getHello() {
return hello;
}
public void setHello(String hello) {
this.hello = hello;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public boolean isBoss() {
return boss;
}
public void setBoss(boolean boss) {
this.boss = boss;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public Map<String, String> getMaps() {
return maps;
}
public void setMaps(Map<String, String> maps) {
this.maps = maps;
}
public List<String> getList() {
return list;
}
public void setList(List<String> list) {
this.list = list;
}
}
package com.wx.springboot20190911.demo.model;
public class Dog {
String name;
String color;
int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getColor() {
return color;
}
public void setColor(String color) {
this.color = color;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
public String toString() {
return "Dog{" +
"name='" + name + '\'' +
", color='" + color + '\'' +
", age=" + age +
'}';
}
}
使用@Value注解
package com.wx.springboot20190911.demo.model;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 1.ConfigurationProperties注解 從配置文件讀取屬性值，放到對象里面，推薦使用，復(fù)雜的結(jié)構(gòu)也適用例如map,list對象,
* 支持 校驗(yàn)@Validated
* 2.通過@value注解獲取配置文件的值,不適合做復(fù)雜類型值得獲取,不支持@Validated，支持
*/
@Component//perosn 需要納入spring ioc 容器里
//@ConfigurationProperties(prefix = "person")
@Validated
public class Person1 {
@Email
@Value("${person1.email}")
String email;
@Value("${person1.hello}")
String hello;
@Value("${person1.name}")
String name;
@Value("#{12*3}")//支持計算
int age;
@Value("${person1.boss}")
boolean boss;
@Value("${person1.birth}")
Date birth;
Map<String,String> maps;
List<String> list;
Dog dog;
public String getHello() {
return hello;
}
public void setHello(String hello) {
this.hello = hello;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public boolean isBoss() {
return boss;
}
public void setBoss(boolean boss) {
this.boss = boss;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public Map<String, String> getMaps() {
return maps;
}
public void setMaps(Map<String, String> maps) {
this.maps = maps;
}
public List<String> getList() {
return list;
}
public void setList(List<String> list) {
this.list = list;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
@Override
public String toString() {
return "Person1{" +
"email='" + email + '\'' +
", hello='" + hello + '\'' +
", name='" + name + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", list=" + list +
", dog=" + dog +
'}';
}
}
配置類（application.properties）代碼
person.hello=luck person.name=吳 #亂碼的話 就setting設(shè)置下file encoding person.list=ww,xx,rr person.maps.k1=v1 person.maps.k2=v2 person.dog.name=cat person.dog.color=red person.dog.age=1 person.age=12 person.birth=2019/01/11 person.boss=false person.email=www@qq.com person1.hello=luck person1.name=吳 #亂碼的話 就setting設(shè)置下file encoding person1.list=ww,xx,rr person1.age=12 person1.birth=2019/01/11 person1.boss=false person1.email=www
配置類(application.yml)代碼:這種方式更加結(jié)構(gòu)化
person:
name: 霞
age: 16
boss : false
birth: 2012/09/12
maps: {k1: v1,k2: v2}
list: [dog,cat ,house,rabbits]
dog:
name: ${person.hello}
age: ${random.int(10)}
color: white
hello: yula
打印結(jié)果：使用第一種方式時，如果email不是"www@qq.com"這種格式，是不能運(yùn)行成功的，但是使用@Value 不會校驗(yàn)，如下面是"www",一樣能運(yùn)行成功
Person{email='www@qq.com', hello='luck', name='吳', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}
Person1{email='www', hello='luck', name='吳', age=36, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps=null, list=null, dog=null}
四、@PropertySource 讀取指定配置文件
package com.wx.springboot20190911.demo.model;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 1.ConfigurationProperties注解 從配置文件讀取屬性值，放到對象里面
* 2.通過@value注解獲取配置文件的值
*/
@PropertySource(value={"classpath:person.properties"})//指定讀取person.properties配置文件
@Component//perosn 需要納入spring ioc 容器里
@ConfigurationProperties(prefix = "person")//使用前綴標(biāo)明具體的屬性
@Validated
public class Person2 {
@Email
String email;
String hello;
String name;
int age;
boolean boss;
Date birth;
Map<String,String> maps;
List<String> list;
Dog dog;
@Override
public String toString() {
return "Person{" +
"email='" + email + '\'' +
", hello='" + hello + '\'' +
", name='" + name + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", list=" + list +
", dog=" + dog +
'}';
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public String getHello() {
return hello;
}
public void setHello(String hello) {
this.hello = hello;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public boolean isBoss() {
return boss;
}
public void setBoss(boolean boss) {
this.boss = boss;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public Map<String, String> getMaps() {
return maps;
}
public void setMaps(Map<String, String> maps) {
this.maps = maps;
}
public List<String> getList() {
return list;
}
public void setList(List<String> list) {
this.list = list;
}
}
這里雖然指定了讀取person.properties配置文件，但是由于prefix=“person”,導(dǎo)致還是讀取了application.properties配置文件，因?yàn)閍pplication.properties權(quán)限最高，要想讀取person.properties配置文件，就得改前綴名，例如改成prefix=“person2” person.properties配置文件的內(nèi)容如下：
沒改前綴名的結(jié)果演示：
Person{email='www@qq.com', hello='luck', name='吳', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}
Person1{email='www', hello='luck', name='吳', age=36, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps=null, list=null, dog=null}
Person{email='www@qq.com', hello='luck', name='吳', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}
改前綴名的代碼演示：
改了前綴名的結(jié)果演示：這時候讀取的就是指定的配置文件的值
Person{email='www@qq.com', hello='luck', name='吳', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}
Person1{email='www', hello='luck', name='吳', age=36, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps=null, list=null, dog=null}
Person{email='12345@qq.com', hello='springboot', name='指定讀取配置文件', age=12, boss=false, birth=Wed Sep 11 00:00:00 CST 2019, maps={k2=v2, k1=v1}, list=[@Value, @PropertySource], dog=Dog{name='cat', color='red', age=1}}
注：只能讀取 .properties 文件，無法讀取 .yml 文件
五、@ImportResource:導(dǎo)入Spring配置文件
讓配置文件里面的內(nèi)容生效
Springboot 里沒有Spring 的配置文件，我們自己編寫的配置文件，也不能自動識別；
想讓Spring的配置文件生效，加載進(jìn)來，需使用該注解
寫一個Person3 類，如圖所示：
自定義一個Spring配置文件，如圖所示：
在啟動類上注解
測試：自定義的這個配置文件是否生效
演示結(jié)果：生效了
2019-09-11 22:15:12.247 INFO 7824 --- [ main] c.w.s.demo.DemoApplicationTests : Started DemoApplicationTests in 8.558 seconds (JVM running for 10.882)
Person{email='null', hello='null', name='null', age=0, boss=false, birth=null, maps=null, list=null, dog=null}
六、思維導(dǎo)圖
以上為個人經(jīng)驗(yàn)，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot 使用WebSocket功能(實(shí)現(xiàn)步驟)
本文通過詳細(xì)步驟介紹了SpringBoot 使用WebSocket功能,首先需要導(dǎo)入WebSocket坐標(biāo),編寫WebSocket配置類,用于注冊WebSocket的Bean,結(jié)合示例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧2024-02-02
Struts2中ognl遍歷數(shù)組,list和map方法詳解
這篇文章主要介紹了Struts2中ognl遍歷數(shù)組，list和map方法詳解，需要的朋友可以參考下。2017-09-09
Java使用@EnableEurekaServer實(shí)現(xiàn)自動裝配詳解
這篇文章主要介紹了Java使用@EnableEurekaServer實(shí)現(xiàn)自動裝配過程，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)吧2022-10-10
這篇文章主要介紹了LinkedHashMap如何保證有序問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-11-11
本文主要介紹了Java創(chuàng)建List常用幾種方法,主要介紹了9種方法,具有一定的參考價值,感興趣的可以了解一下2023-09-09
idea創(chuàng)建springboot項目(版本只能選擇17和21)的解決方法
idea2023創(chuàng)建spring boot項目時,java版本無法選擇11,本文主要介紹了idea創(chuàng)建springboot項目(版本只能選擇17和21),下面就來介紹一下解決方法,感興趣的可以了解一下2024-01-01
在本篇文章里小編給大家整理的是關(guān)于SpringBoot使用Log4j的知識點(diǎn)，需要的朋友們可以參考學(xué)習(xí)下。2020-02-02
這篇文章主要為大家詳細(xì)介紹了Java經(jīng)典排序算法之希爾排序，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-04-04
這篇文章主要介紹了IDEA Debug模式下改變各類型變量值的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-04-04
SpringBoot Tomcat漏洞修復(fù)的解決方法
本文主要介紹了SpringBoot Tomcat漏洞修復(fù)的解決方法,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2025-04-04