Spring Boot读取配置的几种方式
Spring Boot可以通过@Value、@PropertySource、@ConfigurationProperties注解和Environment来读取配置文件
一、创建配置文件application.properties或者application.yml
本文选择properties文件
project.name=springboot
project.user=admin
二、使用注解进行读取
1、@Value
@Component
public class Info {
@Value("${project.name}")
private String name;
@Value("${project.user}")
private String user;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getUser() {
return user;
}
public void setUser(String user) {
this.user = user;
}
@Override
public String toString() {
return "Info [name=" + name + ", user=" + user + "]";
}
}
编写简单的测试类
@Autowired
private Info info;
@Test
public void info() {
System.out.println(info);
}
运行测试类，查看控制台输出
Info [name=springboot, user=admin]
@Value注解也可以放在实例变量的set方法上
@Component
public class Info {
private String name;
private String user;
public String getName() {
return name;
}
@Value("${project.name}")
public void setName(String name) {
this.name = name;
}
public String getUser() {
return user;
}
@Value("${project.user}")
public void setUser(String user) {
this.user = user;
}
@Override
public String toString() {
return "Info [name=" + name + ", user=" + user + "]";
}
}
测试类输出结果一致。
当@Value注解为静态变量赋值时，需要将@Value放在set方法上，注意：静态变量的set方法需要删除static关键字。
在配置文件中增加属性
project.prefix=spring
Info类
private static String prefix;
public static String getPrefix() {
return prefix;
}
@Value("${project.prefix}")
public void setPrefix(String prefix) {
Info.prefix = prefix;
}
在测试类中输出Info.getPrefix()，结果为spring。
2、@ConfigurationProperties
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "project")
public class Info {
private String name;
private String user;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getUser() {
return user;
}
public void setUser(String user) {
this.user = user;
}
@Override
public String toString() {
return "Info [name=" + name + ", user=" + user + "]";
}
}
使用@ConfigurationProperties注解时，需要注意Info类中的name、user字段要跟配置文件中的相关字段名称必须一致，与大小写无关。
运行测试类，查看控制台输出
Info [name=springboot, user=admin]
3、@PropertySource
@PropertySource 可以读取指定properties文件中的内容，但不支持yml文件读取。
新建db.properties文件，内容为：
db.name=MySQL
db.user=root
（1）@PropertySource 和 @Value 配合读取指定文件中的内容
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@PropertySource("classpath:db.properties")
public class Info {
@Value("${db.name}")
private String name;
@Value("${db.user}")
private String user;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getUser() {
return user;
}
public void setUser(String user) {
this.user = user;
}
@Override
public String toString() {
return "Info [name=" + name + ", user=" + user + "]";
}
}
@PropertySource(“classpath:db.properties”) 也可写成 @PropertySource(value = {“classpath:db.properties”})
运行测试类，查看控制台输出
Info [name=MySQL, user=root]
（2）@PropertySources 注解
Spring还提供了@PropertySources 注解，从名字可以看出它是为多配置文件而准备的。
创建db2.properties文件，内容为
db.password=123456
改动Info类：
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.annotation.PropertySources;
import org.springframework.stereotype.Component;
@Component
@PropertySources({
@PropertySource("classpath:db.properties"),
@PropertySource("classpath:db2.properties")
})
public class Info {
@Value("${db.name}")
private String name;
@Value("${db.user}")
private String user;
@Value("${db.password}")
private String password;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getUser() {
return user;
}
public void setUser(String user) {
this.user = user;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
@Override
public String toString() {
return "Info [name=" + name + ", user=" + user + ", password=" + password + "]";
}
}
运行测试类，查看控制台结果为
Info [name=MySQL, user=root, password=123456]
当db.properties和db2.properties中含有相同的属性时，使用@Value 注入属性值时，会根据@PropertySource 的顺序选择，有“后来居上”的行为。
在两个properties增加相同的属性db.name，其中db.properties中name的值为MySQL，db2.properties中name值为Oracle
第一种情况：
@PropertySources({
@PropertySource("classpath:db.properties"),
@PropertySource("classpath:db2.properties")
})
程序运行结果显示
Info [name=Oracle, user=root, password=123456]
其中name值为db2.properties中db.name的值
第二种情况：
@PropertySources({
@PropertySource("classpath:db2.properties"),
@PropertySource("classpath:db.properties")
})
程序运行结果显示
Info [name=MySQL, user=root, password=123456]
其中name值为db.properties中db.name的值
（3）@PropertySource 、@ConfigurationProperties 组合使用
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "db")
@PropertySource("classpath:db.properties")
public class Info {
private String name;
private String user;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getUser() {
return user;
}
public void setUser(String user) {
this.user = user;
}
@Override
public String toString() {
return "Info [name=" + name + ", user=" + user + "]";
}
}
输入结果为
Info [name=MySQL, user=root]
三、使用Environment类进行读取
Environment类可以获取项目属性配置文件中的值。以application.properties文件为例
project.name=springboot
project.user=admin
编写测试类
@Autowired
private Environment env;
@Test
public void env() {
System.out.println(
"name:" + env.getProperty("project.name") + ", user:" + env.getProperty("project.user"));
}
控制台输出
name:springboot, user:admin
读取成功