Spring 配置解析之Properties
http://www.cnblogs.com/dragonfei/archive/2016/10/09/5906474.html
********************************************
1.简单示例:
SpringBoot中的的配置简单属性类支持ConfigurationProperties方式,看一个简单的示例。
1 @ConfigurationProperties(prefix = "org.dragonfei.demo")
2 public class DemoProperties {
3 private String name;
4 private String password;
5 private String test;
6
7 public String getName() {
8 return name;
9 }
10
11 public void setName(String name) {
12 this.name = name;
13 }
14
15 public String getPassword() {
16 return password;
17 }
18
19 public void setPassword(String password) {
20 this.password = password;
21 }
22
23 public String getTest() {
24 return test;
25 }
26
27 public void setTest(String test) {
28 this.test = test;
29 }
30
31 @Override
32 public String toString() {
33 return "DemoProperties{" +
34 "name='" + name + '\'' +
35 ", password='" + password + '\'' +
36 ", test='" + test + '\'' +
37 '}';
38 }
39 }
1 org.dragonfei.demo.name=dragonfei
2 org.dragonfei.demo.password=password
3 org.dragonfei.demo.test=test
1 @Configuration
2 @EnableConfigurationProperties({DemoProperties.class})
3 public class DemoConfiguration {
4 }
1 @RunWith(SpringJUnit4ClassRunner.class)
2 @SpringApplicationConfiguration(classes = DemoConfiguration.class)
3 @EnableAutoConfiguration
4 public class DemoPropertiesTest {
5
6 @Autowired
7 private DemoProperties properties;
8 @Test
9 public void testProperties(){
10 System.out.println(properties.toString());
11 }
12 }
1 DemoProperties{name='dragonfei', password='password', test='test'}
DemoProperties神奇的注入到Spring容器中了。有没有跟我一样很兴奋,这样的 一大好处,将配置文件的属性以类的形式展现,在需要使用的时候只需要,autowire需要的类就可以了,避免大片重复的的${a.b.c}
2.Properties属性自动装配实现
DemoProperties这么神奇注入到容器中,天下没有什么是莫名奇妙的,引出了两个关键问题:
- DemoProperties是怎样注入到容器中?
- DemoProperties中的各个属性是怎么被赋值的呢?
要回答上面的问题,必须对@Configuration如何注入bean做一个简单的回顾:
- 在解析@Congiguraion的时候,会调用@Import中引入的类
- 如果@Import中是ImportBeanDefinitionegistar的子类,会直接调用registerBeanDefinitions
- 如果@Import中是ImportSelector类型,会调用selectImports()返回的bean的registerBeanDefinitions方法。
- registerBeanDefinitions方法会向BeanFactory中添加新的bean。
回到正题。打开EnableConfigurationProperties
1 @Target(ElementType.TYPE)
2 @Retention(RetentionPolicy.RUNTIME)
3 @Documented
4 @Import(EnableConfigurationPropertiesImportSelector.class)
5 public @interface EnableConfigurationProperties {
6
7 /**
8 * Convenient way to quickly register {@link ConfigurationProperties} annotated beans
9 * with Spring. Standard Spring Beans will also be scanned regardless of this value.
10 * @return {@link ConfigurationProperties} annotated beans to register
11 */
12 Class<?>[] value() default {};
13
14 }
注意@Imoport里面的类
1 public String[] selectImports(AnnotationMetadata metadata) {
2 MultiValueMap<String, Object> attributes = metadata.getAllAnnotationAttributes(
3 EnableConfigurationProperties.class.getName(), false);
4 Object[] type = attributes == null ? null
5 : (Object[]) attributes.getFirst("value");
6 if (type == null || type.length == 0) {
7 return new String[] {
8 ConfigurationPropertiesBindingPostProcessorRegistrar.class
9 .getName() };
10 }
11 return new String[] { ConfigurationPropertiesBeanRegistrar.class.getName(),
12 ConfigurationPropertiesBindingPostProcessorRegistrar.class.getName() };
13 }
然后,会调用ConfigurationPropertiesBeanRegistar和ConfigurationPropertiesBindingPostProcessorRegistar的registerBeanDefinitions方法,前者是为了注入配置properties类,后者为属性绑定值
1 @Override
2 public void registerBeanDefinitions(AnnotationMetadata metadata,
3 BeanDefinitionRegistry registry) {
4 MultiValueMap<String, Object> attributes = metadata
5 .getAllAnnotationAttributes(
6 EnableConfigurationProperties.class.getName(), false);
7 List<Class<?>> types = collectClasses(attributes.get("value"));
8 for (Class<?> type : types) {
9 String prefix = extractPrefix(type);
10 String name = (StringUtils.hasText(prefix) ? prefix + "-" + type.getName()
11 : type.getName());
12 if (!registry.containsBeanDefinition(name)) {
13 registerBeanDefinition(registry, type, name);
14 }
15 }
16 }
1 public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
2 BeanDefinitionRegistry registry) {
3 if (!registry.containsBeanDefinition(BINDER_BEAN_NAME)) {
4 BeanDefinitionBuilder meta = BeanDefinitionBuilder
5 .genericBeanDefinition(ConfigurationBeanFactoryMetaData.class);
6 BeanDefinitionBuilder bean = BeanDefinitionBuilder.genericBeanDefinition(
7 ConfigurationPropertiesBindingPostProcessor.class);
8 bean.addPropertyReference("beanMetaDataStore", METADATA_BEAN_NAME);
9 registry.registerBeanDefinition(BINDER_BEAN_NAME, bean.getBeanDefinition());
10 registry.registerBeanDefinition(METADATA_BEAN_NAME, meta.getBeanDefinition());
11 }
12 }
注意这里注入了ConfigurationPropertiesBindingPostProcessor,这才是属性赋值的关键。查看类图
注意到ConfigurationPropertiesBindingPostProcessor继承自BeanPostProcessor,他会在bean初始化前后调用before和after后置处理,这里,在Properties属性初始化完成后,会对绑定属性,
1 private void postProcessBeforeInitialization(Object bean, String beanName,
2 ConfigurationProperties annotation) {
3 Object target = bean;
4 PropertiesConfigurationFactory<Object> factory = new PropertiesConfigurationFactory<Object>(
5 target);
6 if (annotation != null && annotation.locations().length != 0) {
7 factory.setPropertySources(
8 loadPropertySources(annotation.locations(), annotation.merge()));
9 }
10 else {
11 factory.setPropertySources(this.propertySources);
12 }
13 factory.setValidator(determineValidator(bean));
14 // If no explicit conversion service is provided we add one so that (at least)
15 // comma-separated arrays of convertibles can be bound automatically
16 factory.setConversionService(this.conversionService == null
17 ? getDefaultConversionService() : this.conversionService);
18 if (annotation != null) {
19 factory.setIgnoreInvalidFields(annotation.ignoreInvalidFields());
20 factory.setIgnoreUnknownFields(annotation.ignoreUnknownFields());
21 factory.setExceptionIfInvalid(annotation.exceptionIfInvalid());
22 factory.setIgnoreNestedProperties(annotation.ignoreNestedProperties());
23 if (StringUtils.hasLength(annotation.prefix())) {
24 factory.setTargetName(annotation.prefix());
25 }
26 }
27 try {
28 factory.bindPropertiesToTarget();
29 }
30 catch (Exception ex) {
31 String targetClass = ClassUtils.getShortName(target.getClass());
32 throw new BeanCreationException(beanName, "Could not bind properties to "
33 + targetClass + " (" + getAnnotationDetails(annotation) + ")", ex);
34 }
35 }
至于真实的数据绑定,会从propertySources中获取,敬请期待....Spring 的数据绑定,这简单提一下关键的地方:
1 Set<String> names = getNames(relaxedTargetNames);
2 PropertyValues propertyValues = getPropertyValues(names, relaxedTargetNames);
请注意getNames,是获取prefix+属性构成的key值,prefix_property和prefix.property都会获取到
1 private Set<String> getNames(Iterable<String> prefixes) {
2 Set<String> names = new LinkedHashSet<String>();
3 if (this.target != null) {
4 PropertyDescriptor[] descriptors = BeanUtils
5 .getPropertyDescriptors(this.target.getClass());
6 for (PropertyDescriptor descriptor : descriptors) {
7 String name = descriptor.getName();
8 if (!name.equals("class")) {
9 RelaxedNames relaxedNames = RelaxedNames.forCamelCase(name);
10 if (prefixes == null) {
11 for (String relaxedName : relaxedNames) {
12 names.add(relaxedName);
13 }
14 }
15 else {
16 for (String prefix : prefixes) {
17 for (String relaxedName : relaxedNames) {
18 names.add(prefix + "." + relaxedName);
19 names.add(prefix + "_" + relaxedName);
20 }
21 }
22 }
23 }
24 }
25 }
26 return names;
27 }
getPropertyValues会获取到满足上述条件的propertyValues,最后调用spring框架提供数据绑定策略进行数据绑定。
Spring 配置解析之Properties的更多相关文章
- spring配置中,properties文件以及xml文件配置问题
spring方便我们的项目快速搭建,功能强大,自然也会是体系复杂! 这里说下配置文件properties管理的问题. 一些不涉及到代码逻辑,仅仅只是配置数据,可以放在xxxx.properties文件 ...
- spring配置中引入properties
<context:property-placeholder location="classpath*:db.properties" />
- spring 配置多个properties
复制多份,保证有效的配置文件,属性时true就行 <bean class="org.springframework.beans.factory.config.PropertyPlace ...
- Spring源码情操陶冶-PropertyPlaceholderBeanDefinitionParser注解配置解析器
本文针对spring配置的context:property-placeholder作下简单的分析,承接前文Spring源码情操陶冶-自定义节点的解析 spring配置文件应用 <context: ...
- JdbcTemplae使用入门&&Spring三种连接池配置&&Spring配置文件引用外部properties文件
JdbcTemplate的使用 Spring为了各种支持的持久化技术,都提供了简单操作的模版和回调. JdbcTemplate 简化 JDBC 操作HibernateTemplate 简化 Hiber ...
- Spring多资源文件properties的配置
Spring简化了加载资源文件的配置,可以通过<context:property-placeholder去加载,这个元素的写法如下: <context:property-placehold ...
- spring+mybaits xml配置解析----转
一.项目中spring+mybaits xml配置解析 一般我们会在datasource.xml中进行如下配置,但是其中每个配置项原理和用途是什么,并不是那么清楚,如果不清楚的话,在使用时候就很有可能 ...
- 使用import简化spring的配置 spring import 标签的解析 使用import或加载spring配置时,报错误There is no ID/IDREF 多个Spring配置文件import resource路径配置
spring-import 标签的解析.使用案例: 对于spring配置文件的编写,我想,对于经历过庞大项目的人,都有那种恐惧的心理,太多的配置文件.不过,分模块都是大多数人能想到的方法,但是,怎么分 ...
- spring 配置文件中使用properties文件 配置
配置Bean载入properties文件: <bean id="propertyPlaceholderConfigurer" class="org.springfr ...
随机推荐
- 常用git命令总结
这些命令是最常用的,一般的提交代码.拉取代码.合并代码.分支切换等等操作用这些命令就足够了. 1.git init 把一个目录初始化成git仓库 2.git add test.txt 把文 ...
- Linux 环境变量PS1设置
新建用户不显示IP和机器名 CentOS下新增加一个用户,登录进去会发现shell脚本信息没有显示用户名和主机名,反而显示的是user1@202.173.1.12 解决方案: 1.在新建用户的-目录下 ...
- 夺命雷公狗-----React_native---5---初步读懂代码模式
我们的代码一般导出会用两种方式,如下所示: 这两种方法都是可以的.... 引入方式其实也是很简单的,如下所示: 这样即可...
- web分享QQ好友、QQ空间、新浪微博的api接口
QZone: "http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url={{URL}}&title={{TITL ...
- 自定义子tabBar
基本设置 设置APPIcon(直接拖图片) 设置启动图片 将launch Screen File里的LaunchScreen.xib给删掉 点击launch image source框内的Use As ...
- 头疼:为什么chrome不能访问本地文件(带--disable-web-security --allow-file-access-from-files )
如题,寻求帮助! chrome 带参数启动 --disable-web-security --allow-file-access-from-files 照理应该可以加载本地文件,找遍google和英 ...
- Lucene.net应用
1.加入盘古分词方法 /// <summary> /// 对输入的搜索的条件进行分词 /// </summary> /// <param name="str&q ...
- wex5 实战 登陆帐号更换与用户id一致性
一 前言 关于用户登陆,注册,页面跳转,我讲了很多,都是页面框架级别的.有人问到这个问题,索性总结一下,今天是收尾最后一篇. 以往初学时的设计是: 1 注册 2 登陆 3 进入页面. 这种很简单,没有 ...
- 基于bootstrap 的datatable插件的使用(php版)
Datatables是一款jquery表格插件.它是一个高度灵活的工具,可以将任何HTML表格添加高级的交互功能.详细学习请参考其官网:http://datatables.net/中文网:http:/ ...
- php就业网版本已改版成功
php就业网简介:www.php91.net,专注于Thinkphp框架教程的php框架学习中心.同时也有小崔老师自学php的教程,与你一起成长哦 同时,php就业网教程部分:http://www.p ...