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; /** * 配置类 * @description 读取自定义yml格式配置文件 * @date 2021/3/15 10:40 * @created by lsh */@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).使用方法
直接用调用配置类的静态属性即可获取配置信息,不限于常规方法,静态方法,静态代码块,其实相当于时使用一个配置类迂回一下间接获取配置信息。
以上就是springboot读取yml配置文件的方法有哪些的详细内容。
