快捷導(dǎo)航

Springboot中如何通過(guò)yml為實(shí)體類(lèi)注入屬性

更新時(shí)間：2022年05月05日 10:08:50 作者：一個(gè)小年輕

這篇文章主要介紹了Springboot中如何通過(guò)yml為實(shí)體類(lèi)注入屬性，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

1.編寫(xiě)實(shí)體類(lèi)

@Component
@ConfigurationProperties(prefix = "person")
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;
    @Override
    public String toString() {
        return "Person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", dog=" + dog +
                '}';
    }
    public String getLastName() {
        return lastName;
    }
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public Boolean getBoss() {
        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, Object> getMaps() {
        return maps;
    }
    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }
    public List<Object> getLists() {
        return lists;
    }
    public void setLists(List<Object> lists) {
        this.lists = lists;
    }
    public Dog getDog() {
        return dog;
    }
    public void setDog(Dog dog) {
        this.dog = dog;
    }
}

@Component 表示將當(dāng)前類(lèi)的創(chuàng)建工作交給Spring容器管理

@ConfigurationProperties(prefix = “person”)

用于表示該類(lèi)需要讀取的配置信息，prefix用于指示讀取哪一個(gè)配置信息

Person類(lèi)依賴(lài)了一個(gè)Dog類(lèi)，如下：

public class Dog {
    private String name;
    private Integer age;
    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
}

2.編寫(xiě)yml文件

@ConfigurationProperties(prefix = “person”)

Person類(lèi)的這個(gè)注解就會(huì)去找yml中對(duì)應(yīng)的配置信息

person:
? lastName: zhangsan
? age: 18
? boss: false
? birth: 2017/12/12
? maps: {k1: v1,k2: v2}
? lists:
? ? - lisi
? ? - zhaoliu
? ? - wangwu
? dog:
? ? name: 小狗
? ? age: 2

3.測(cè)試

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootQuickStartApplicationTests {
? ? @Autowired
? ? Person person;
? ? @Test
? ? public void demo1() {
? ? ? ? System.out.println(person);
? ? }
}

4.結(jié)果

注意：有可能中文在這個(gè)地方打印會(huì)出現(xiàn)亂碼，原因是yml的編碼和java文件的編碼不一樣導(dǎo)致，我們需要將其配成一致的編碼，如都設(shè)置成utf-8。

5.可以不用@ConfigurationProperties(prefix = “person”)注解方式

使用@Value的方式注入屬性值

@Value注解等價(jià)于：

以三個(gè)屬性字段為例

我們既可以從配置文件取值，也可以通過(guò)字面量直接賦值，當(dāng)屬性值少的時(shí)候這種方式特別方便。

    @Value("${person.lastName}")
    private String lastName;
    @Value("${person.age}")
    private Integer age;
    @Value("true")
    private Boolean boss;

效果如下，由于只注入了三個(gè)屬性，其余屬性則為空

6.@ConfigurationProperties(prefix = “person”)

默認(rèn)是從主配置文件中讀取相關(guān)信息，我們可以使用

@PropertySource(value = {“配置文件的路徑”})

來(lái)指定需要讀取的配置文件

6.1寫(xiě)一個(gè)dog.properties配置Dog類(lèi)的相關(guān)配置信息

dog.name=puppy
dog.age=24

6.2為Dog類(lèi)注入屬性

@PropertySource(value = {"classpath:dog.properties"})
@Component
@ConfigurationProperties(prefix = "dog")
public class Dog {
    private String name;
    private Integer age;

6.3效果