Spring Boot配置文件properties值的获取
前言:之前在开发的时候接触到springboot,但是并不是很懂他的原理,也就是照葫芦画瓢进行开发,但是近期学习到springboot的自动配置原理,于是就整理一下,从最开始的获取properties值开始,因为boot内部的原理就是运用到了这个。
1.准备
因为获取properties值是用java bean进行获取的,boot也是有相关的依赖来进行在写入配置文件的时候进行提示
<!--进行文件绑定实体类-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
但是这个依赖要产生效果呢,要先进行项目的启动,也就是说要启动一次才会生效
2.编写java bean
我们首先要进行编写java bean ,然后根据java bean去编写properties的属性
首先编写一个dog类
package com.zlsoft.controller;
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;
}
}
再编写一个person类
这里需要注意一点,@ConfigurationProperties这个注解必须要在spring容器里面才会有效果
所以要进行使用@Component把person注入到容器里面
@ConfigurationProperties 的属性prefix是指再properties里面的以person为前缀的属性
package com.zlsoft.controller;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import javax.xml.crypto.Data;
import java.util.List;
import java.util.Map;
/**
* 将配置文件中配置的每一个属性的值,映射到这个组件中
* @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
* prefix = "person":配置文件中哪个下面的所有属性进行一一映射
*
* 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
*
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Data 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 Data getBirth() {
return birth;
}
public void setBirth(Data 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;
}
}
2.编写properties
先前我们导入了一个依赖,可以在编写properties的时候有进行提示,但是记得要启动一次项目才会有用,并且要有java bean的存在
properties代码
# properties的编写
person.last-name=zhangsan
person.age=17
person.boss=true
#person.birth=2019/12/12 这里会报错,我就先注释,大噶意思就是不符合Data格式
person.lists=aa,bb,cc
# map 集合就是这样子进行键值对配置
person.maps.k1 = v1
person.maps.k2 = v2
# dog实体类
person.dog.name=dog
person.dog.age=2
3.进行测试
在springboot里面呢,有配置好的测试类,在test包里面,这个类可以进行注入,比较方便。我们就在这个类里面进行测试
测试代码
package com.test.springboot;
import com.test.springboot.bean.Person;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootTest01ApplicationTests {
@Autowired
Person person;
@Test
public void contextLoads() {
System.out.println(person);
}
}
4.运行结果
这里
这里就可以看出,person类已经获得了这个配置文件的内容。