我们在开发过程中,难免会有些自定义的配置文件需要与程序交互,在程序中获取配置文件
常用的获取方式:
- 自定义工具类PropertyUtil,并在该类的static静态代码块中读取properties文件内容保存在static属性中以供别的程序使用
/**
*自定义工具类PropertyUtil,并在该类的static静态代码块中读取properties文件内容保存在static属性中以供别的程序使用
*/
public class PropertyUtil {
private static final Logger logger = LoggerFactory.getLogger(PropertyUtil.class);
private static Properties props;
static{
loadProps();
}
synchronized static private void loadProps(){
logger.info("开始加载properties文件内容.......");
props = new Properties();
InputStream in = null;
try {
/**第一种,通过类加载器进行获取properties文件流*/
in = PropertyUtil.class.getClassLoader().getResourceAsStream("application.properties");
/**第二种,通过类进行获取properties文件流*/
//in = PropertyUtil.class.getResourceAsStream("/jdbc.properties");
props.load(in);
} catch (FileNotFoundException e) {
logger.error("jdbc.properties文件未找到");
} catch (IOException e) {
logger.error("出现IOException");
} finally {
try {
if(null != in) {
in.close();
}
} catch (IOException e) {
logger.error("jdbc.properties文件流关闭出现异常");
}
}
logger.info("加载properties文件内容完成...........");
logger.info("properties文件内容:" + props);
}
public static String getProperty(String key){
if(null == props) {
loadProps();
}
return props.getProperty(key);
}
public static String getProperty(String key, String defaultValue) {
if(null == props) {
loadProps();
}
return props.getProperty(key, defaultValue);
}
}
- 使用
@Value
获取灵活方便
public class Person {
@Value("person.userName")
private String userName;
@Value("person.age")
private String age;
@Value("person.isWoman")
private boolean isWoman;
public String toString() {
return "Person{" +
"userName='" + userName + '\'' +
", age='" + age + '\'' +
", isWoman=" + isWoman +
'}';
}
}
使用SpringBoot的
@ConfigurationProperties
自动获取pom.xml配置
<!--导入配置文件处理器,配置文件进行绑定就会有提示--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
java:
@Component @ConfigurationProperties(prefix = "person") //开启JSR303 @Validated public class Person { @Email //该注解表示配置值必须为email格式不然会报相应异常 private String userName; private String age; private boolean isWoman; private Map pet; private List<Person> friends; public String toString() { return "Person{" + "userName='" + userName + '\'' + ", age='" + age + '\'' + ", isWoman=" + isWoman + ", pet=" + pet + ", friends=" + friends + '}'; } }
@ConfigurationProperties
和@Value
比较
@ConfigurationProperties | @Value |
---|---|
功能 | 批量注入配置文件中的属性 |
松散绑定(松散语法) | 支持 |
SpEL | 不支持 |
JSR303数据校验 | 支持 |
复杂类型封装 | 支持 |
- 无论配置文件是yml还是properties他们都能获取到值;
- 如果说,我们只是在某个业务逻辑中需要临时获取一下配置文件中的某项值,使用@Value;
- 如果说,我们专门编写了一个javaBean来和大量配置文件或者含有复杂数据类型的配置进行映射,我们就直接使用@ConfigurationProperties;