简述:
项目开发中难免要读取配置文件,本文结合开发经验介绍几种使用过的读取配置文件的方法。
1.基础用法,使用注解@Autowired注入Environment类
这种方式比较常见,就像注入service或者dao一样,声明一个Environment类变量,加上@Autowire注解。如下:
import org.springframework.core.env.Environment;@Autowiredprivate Environment environment;
使用方法就是通过getProperty(key)方法读取配置文件中的信息,代码如下:
1).Yml中的配置
heycloud: jobInfo: http://www.baidu.com
2).获取配置
//获取url(注意:key一定要写完整,有几层就写几层,每层的名字用点分隔。)String resultUrl = environment.getProperty("heycloud.jobInfo");
注:该方式读取配置信息有一定的局限性,包括如下:
局限1:
如果要在静态方法中读取配置信息,不能简单的将Environment定义成static就完了,由于注入机制,注入一个静态的bean只会得到一个空的bean,即变量的值为null,一旦使用该bean对象就会报空指针异常。
错误写法:
@Autowired private static Environment environment;//这是错误写法,environment只会是null public void test(){ //获取url String resultUrl = environment.getProperty("heycloud.jobInfo");//一旦使用environment变量就会报空指针异常 }
正确写法:
1.将Environment定义成static;
2.加上environment的getter/setter方;
3.将@Autowire注解加到set方法上。
这样就可以有效注入了,值得注意的是,只需要get方法是静态的即可,set方法不要静态,否则得到的environment还是null。
正确代码如下:
private static Environment environment; @Autowired public void setEnvironment(Environment environment) { this.environment = environment; } public static Environment getEnvironment() { return environment; }
局限2:
Environment 无法直接读取自定义的Yml配置文件,需要通过增加一个配置类,将自定义的Yml文件暴露到spring environment中。
解决方法:
定义一个配置类,将自定义的Yml文件内容加载到Environment中,代码如下:
import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;import org.springframework.context.annotation.Bean;import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;import org.springframework.core.io.ClassPathResource;import org.springframework.stereotype.Component;@Componentpublic class SqlConfig { @Bean public PropertySourcesPlaceholderConfigurer getSqlConfigurer() { PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer(); YamlPropertiesFactoryBean sqlConfigBean = new YamlPropertiesFactoryBean(); sqlConfigBean.setResources(new ClassPathResource("sql-properties.yml")); configurer.setProperties(sqlConfigBean.getObject()); return configurer; }}
写好配置类,就可以通过注解@Autowired注入Environment类来读取自定义配置信息了。简言之,遇到局限2的问题,只是需要多写一个配置类而已。
局限3:
由于加载顺序的原因,使用注解的方法不适用于在静态代码块(static{})中读取配置,即便用了局限1的解决方法也不行,目前还没找出解决方法,欢迎路过的大佬指点。
其实也可以在静态块中手写加载类通过读取Yml文件的路径去加载配置,但这样不够简洁,如果多个类都存在这种需求,每个都要写一堆加载类,所以没有深究。不过不止一种方法可以读取配置文件,没必要认准一棵树。
2.基础用法,使用@Value注解直接注入配置信息
使用方法很简单,声明类成员属性,使用@Value注解直接将配置信息放入成员属性中,格式为:@Value("${xxx.xxx.xxx}")。
代码如下:
@Value("${sql.newrest.CAS_GRID}") private String CAS_GRID;
注意:
1.同第一个方法一样,key要写完整,有几层就写几层,每一层用点分开。
2.该方法同第一种方法的局限性一样。
3.进阶方法
定义一个工具类,使用@Component注解成为配置类,再继承ApplicationRunner 重写run(),再注入Environment 类获取配置,可以做到在任何地方随时随地获取配置信息。
代码如下:
1).定义配置类,声明一些静态属性,用于接收配置信息
@Slf4j@Componentpublic class BaseConfig implements ApplicationRunner { @Autowired private Environment environment; public static String pro1; public static String pro2; public static String pro3; @Override public void run(ApplicationArguments args){ pro1=environment.getProperty("pro1"); pro2=environment.getProperty("pro2"); pro3=environment.getProperty("pro3"); }}
2).使用方法
直接用调用配置类的静态属性即可获取配置信息,不限于常规方法,静态方法,静态代码块,其实相当于时使用一个配置类迂回一下间接获取配置信息。
来源地址:https://blog.csdn.net/zlfjavahome/article/details/128610161