Spring核心——资源数据管理

为什么80%的码农都做不了架构师&＃xff1f;>>>

在Profile管理环境一文中介绍了环境的概念以及Spring Profile特性控制Bean的添加。本文将进一步介绍Spring管理和控制操作系统变量、JVM变量和Java标准资源&＃xff08;properties文件&＃xff09;的相关功能。

文章的代码仅仅用于说明问题&＃xff0c;可执行代码请到我的gitee库clone&＃xff0c;本文的代码在chkui.springcore.example.hybrid.propertsource包中。

PropertySource与优先级

在整个Jvm运行期间&＃xff0c;我们可以随时随地获取到2个与环境相关的参数&＃xff1a;

package chkui.springcore.example.hybrid.propertsource;//env是与操作系统相关的参数 Map env &＃61; System.getenv(); //properties中是Jvm相关的参数 Properties p &＃61; System.getProperties(); System.out.println("env :" &＃43; env); System.out.println("properties :" &＃43; p);

如果没有人为的添加额外信息&＃xff0c;System::getEnv获取的数据都与当前的操作系统相关&＃xff08;以下称为“操作系统参数”&＃xff09;&＃xff0c;而System::getProperties获取的内容都与Jvm相关&＃xff08;以下称为“JVM参数”&＃xff09;。

Spring会将操作系统参数和Jvm参数都整合到自己的环境管理接口Environment中&＃xff0c;例如下面的代码&＃xff1a;

package chkui.springcore.example.hybrid.propertsource;//向系统级的properties设置一个参数 System.setProperty("wow", "World of Warcraft"); ApplicationContext ctx &＃61; new AnnotationConfigApplicationContext(PropertySourcesApp.class); //通过spring的Environment获取参数 Environment springEnv &＃61; ctx.getEnvironment(); System.out.println(springEnv.getProperty("wow")); System.out.println(springEnv.getProperty("PATH"));

除了我们自定义的"wow"&＃xff0c;操作系统参数"PATH"也可以在Spring的Environment中获取。

通常情况下&＃xff0c;在Environment内部维护了2个PropertySources的实例&＃xff1a;一个是操作系统参数&＃xff0c;另外一个是JVM参数。如果2者有同样的参数&＃xff0c;那么我们在调用Environment::getProperty方法时&＃xff0c;得到的是JVM参数&＃xff08;System::getProperties&＃xff09;,也就是说 Jvm参数具有更高的优先级。

除了通过外部设置&＃xff0c;我们也可以直接使用Spring提供的接口来设置&＃xff1a;

package chkui.springcore.example.hybrid.propertsource;//我们要对环境进行配置&＃xff0c;需要使用ConfigurableApplicationContext接口 ConfigurableApplicationContext configAbleCtx &＃61; new AnnotationConfigApplicationContext(PropertySourcesApp.class);//ConfigurableApplicationContext接口提供对应的可编辑Environment和PropertySources MutablePropertySources ps &＃61; configAbleCtx.getEnvironment().getPropertySources(); Map map &＃61; new HashMap(); map.put("wow", "Origin &＃61; World of Warcraft!But Edit it already!"); //添加到Spring的环境参数中 ps.addFirst(new MapPropertySource("myPropertySource", map)); System.out.println(springEnv.getProperty("wow"));

代码添加到PropertySource中&＃xff0c;Environment会额外维护一个PropertySources&＃xff0c;而自己添加的PropertySources优先级是最高的&＃xff0c;所以最后Environment::getProperty获取到的值是最后设置的值。

如果需要添加多个PropertySources&＃xff0c;可以通过MutablePropertySources::addFirst或MutablePropertySources::addLast方法来控制他们之间的优先级。

引入资源文件

*.properties是Java的标准资源文件&＃xff0c;在Java的各种项目中常用来记录各种配置参数。Spring提供了注解和XML配置将*.properties文件中的数据整合到Spring的环境参数&＃xff08;Environment&＃xff09;中。

&＃64;PropertySource

在&＃64;Configuration标记的类上使用&＃64;PropertySource注解可以引入0~n个*.properties配置文件。如下面的例子&＃xff1a;

package chkui.springcore.example.hybrid.propertsource;&＃64;Configuration &＃64;PropertySource("classpath:/hybrid/propertysource/config.properties") public class PropertySourcesApp {public static void main(String[] args) {ApplicationContext ctx &＃61; new AnnotationConfigApplicationContext(PropertySourcesApp.class); System.out.println("Properties file params: " &＃43; springEnv.getProperty("Gdi"));} }

对应的config.properties文件&＃xff1a;

#hybrid.propertysource.config.propertiesGdi&＃61;StarCraft

同一个工程中支持使用多个&＃64;PropertySource注解来引入配置文件&＃xff0c;也支持Ant风格&＃xff08;Ant-style&＃xff0c;例如"classpath:a/b/**/config.properties"&＃xff09;以及Spring扩展的&＃xff08;比如"classpath*:"&＃xff09;的路径规则&＃xff0c;资源路径控制会在后续的文章中介绍。

XML配置

XML配置在之前介绍容器后置处理器——BeanFactoryPostProcessor的文章中已经介绍了&＃xff0c;他就是 PropertyPlaceholderConfigurer &＃xff0c;我们在XML配置文件中进行一下设置即可。

引入Bean&＃xff1a;

直接使用context进行全局设置&＃xff1a;

占位符替换

PropertyPlaceholderConfigurer继承了抽象类PropertyPlaceholderConfigurer&＃xff0c;而*.properties文件的读写就是在PropertyResourceConfigurer类中实现的。PropertyPlaceholderConfigurer进一步实现了配置文件中占位符&＃xff08;${...}&＃xff09;替换功能。

在Spring IoC容器执行Bean的扫描、加载之前添加一个环境变量&＃xff08;也可以动态添加然后再执行ConfigurableApplicationContext::refresh方法&＃xff09;&＃xff0c;就可以在很多资源路径的位置使用这个占位符&＃xff0c;对上面的例子进行一些修改&＃xff1a;

&＃64;Configuration //通过占位符来设置路径 &＃64;PropertySource("classpath:${resource.propertiesPath}/config.properties") public class PropertySourcesApp {public static void main(String[] args) {//容器启动之前设置环境变量System.setProperty("resource.propertiesPath", "/hybrid/propertysource");ApplicationContext ctx &＃61; new AnnotationConfigApplicationContext(PropertySourcesApp.class);//获取环境对象实例Environment springEnv &＃61; ctx.getEnvironment();System.out.println("Properties : " &＃43; springEnv.getProperty("Gdi"));} }

同样的&＃xff0c;只要环境变量存在&＃xff0c;也可以使用占位符替换配置文件中的数据&＃xff0c;例如&＃xff1a;

XML中的占位符使用的格式是${resource.propertiesPath:/config}&＃xff0c;它表示使用环境变量resource.propertiesPath进行替换&＃xff0c;如果resource.propertiesPath不存在则使用值"/config"。

&＃64;Value

我们可以在任何Bean中使用&＃64;Value注解来获取环境变量。如下面的例子&＃xff1a;

package chkui.springcore.example.hybrid.propertsource;&＃64;Configuration public class PropertySourcesApp {&＃64;Value("${resource.propertiesPath}")private String value;&＃64;Value("#{systemProperties[&＃39;resource.propertiesPath&＃39;]}")private String elValue;&＃64;Value("Resource PropertiesPath")private String staticValue;public static void main(String[] args) {System.setProperty("resource.propertiesPath", "/hybrid/propertysource");ApplicationContext ctx &＃61; new AnnotationConfigApplicationContext(PropertySourcesApp.class);PropertySourcesApp app &＃61; ctx.getBean(PropertySourcesApp.class);System.out.println("Value: " &＃43; app.value);System.out.println("EL Value: " &＃43; app.elValue);System.out.println("Static Value: " &＃43; app.staticValue);} }

&＃64;Value可以注入一个纯字面量&＃xff0c;如上面示例代码中的staticValue&＃xff0c;也可以使用占位符使用环境变量中的任何值。除了使用占位符${}&＃xff0c;&＃64;Value还支持"#{systemProperties[&＃39;resource.propertiesPath&＃39;]}"这样具备代码执行功能的复杂表达式来获取数据&＃xff0c;这部分功能会在后续介绍EL表达式的文章中进行分享。