利用Java注解特性加载属性文件(properties)的值到Java类

在此之前我都是写个PropertyUtil类来加载配置文件,然后通过get方法,把key对应的值取出来.

Spring提供一个PropertyPlaceholderConfigurer类,可以读取配置文件,然后在Spring配置文件通过${hibernate.dialect}这种方式注入到JavaBean中,有个不好的地方就是,要在代码中取的时候不是很方便.

然后在接触到Java注解特注解技术以后,感觉这个东东很好,hibernate映射,WebService都可以通过注解来完成,方便的很多,然后就在想能不能通过Java注解特性加载属性文件(properties)的值到Java类里面呢?

其实上面一篇写在Spring中JavaBean的初始化顺序就是为现在写这个做准备的,要实现现在说的这个功能,大体方案有如下:

1.定义一个注解类

2.在需要加载属性的JavaBean的属性set方法上写注解,注解的参数就是key

3.在Spring启动的时候,去读取属性文件,然后把值赋给JavaBean

我们在上一篇写在Spring中JavaBean的初始化顺序提到了,如果一个JavaBean实现了BeanPostProcessor接口,那么其他Bean初始化以后都会交给这个Bean来处理.这样我们就可以写一个JavaBean实现BeanPostProcessor接口,这个Bean有个属性,它指向属性文件路径,在这个Bean初始化的时候读取属性文件内容,然后在postProcessBeforeInitialization方法里面对写了注解的Bean进行赋值.这样一个实现思路似乎很顺其自然,都是自己觉得不是很好,Spring通过PropertyPlaceholderConfigurer这样类来加载属性文件,而我们有写了另外一个类,这样一是不够统一,二是不够可能会造成多个属性文件.解决办法就是扩展PropertyPlaceholderConfigurer类.写一个类继承PropertyPlaceholderConfigurer类.然后在PropertyPlaceholderConfigurer初始化完成以后,获取加载的属性文件内容,在postProcessBeforeInitialization里面把写过注解的类属性进行赋值.那么怎么确定什么时候PropertyPlaceholderConfigurer加载完成呢,根据Spring中JavaBean的初始化顺序,我们知道一个JavaBean如果实现了InitializingBean接口,那么Spring容器会在这个Bean初始化以后调用afterPropertiesSet方法,现在我写个类继承PropertyPlaceholderConfigurer类,实现BeanPostProcessor, InitializingBean 这个两个接口那么刚刚提到的问题就可以解决了,下面是实现代码

1. packagecom.test.annotation;
3. importjava.lang.reflect.Method;
5. importorg.springframework.beans.BeansException;
6. importorg.springframework.beans.factory.InitializingBean;
7. importorg.springframework.beans.factory.config.BeanPostProcessor;
8. importorg.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
9. importorg.springframework.util.ReflectionUtils;
11. publicclassAnnotationBeanPostProcessorextendsPropertyPlaceholderConfigurerimplementsBeanPostProcessor,InitializingBean{
13. privatejava.util.Propertiespros;
15. @Override
16. publicObjectpostProcessAfterInitialization(Objectbean,StringbeanName)
17. throwsBeansException{
18. //TODOAuto-generatedmethodstub
19. returnbean;
20. }
22. @Override
23. publicObjectpostProcessBeforeInitialization(Objectbean,StringbeanName)
24. throwsBeansException{
25. if(bean.getClass().getAnnotation(Property.class)!=null){
26. Method[]methods=bean.getClass().getDeclaredMethods();
27. for(Methodmethod:methods){
28. Propertyp=method.getAnnotation(Property.class);
29. if(p!=null){
30. //这里进行参数类型转换
31. Objectpara=pros.getProperty(p.name());
32. if((method.getParameterTypes()[0]).getName().equals("java.lang.Integer")){
33. para=newInteger(para.toString());
34. }
35. ReflectionUtils.invokeMethod(method,bean,newObject[]{para});
36. }
37. }
38. }
39. returnbean;
40. }
42. @Override
43. publicvoidafterPropertiesSet()throwsException{
44. pros=mergeProperties();
46. }
48. }

1. packagecom.test.annotation;
3. importjava.lang.annotation.Retention;
4. importjava.lang.annotation.RetentionPolicy;
5. importjava.lang.annotation.Target;
6. importjava.lang.annotation.ElementType;
8. @Retention(RetentionPolicy.RUNTIME)
9. @Target({ElementType.TYPE,ElementType.METHOD})
10. public@interfaceProperty{
11. Stringname()default"";
13. }

1. packagecom.test;
3. importcom.test.annotation.Property;
4. @Property
5. publicclassBean{
6. privateStringname;
7. privateIntegerage;
8. privateStringaddress;
10. publicStringgetName(){
11. returnname;
12. }
13. publicvoidsetName(Stringname){
14. this.name=name;
15. }
17. publicStringgetAddress(){
18. returnaddress;
19. }
20. @Property(name="com.test.Bean.address")
21. publicvoidsetAddress(Stringaddress){
22. this.address=address;
23. }
24. publicIntegergetAge(){
25. returnage;
26. }
27. @Property(name="com.test.Bean.age")
28. publicvoidsetAge(Integerage){
29. this.age=age;
30. }
32. }

1. packagecom.test;
3. importcom.test.annotation.Property;
5. @Property
6. publicclassJavaBean{
9. privateStringname;
11. privateStringaddress;
14. publicStringgetName(){
15. returnname;
16. }
17. @Property(name="com.test.JavaBean.name")
18. publicvoidsetName(Stringname){
19. this.name=name;
20. }
22. publicStringgetAddress(){
23. returnaddress;
24. }
25. publicvoidsetAddress(Stringaddress){
26. this.address=address;
27. }
29. }

1. packagecom.test;
3. importorg.springframework.context.ApplicationContext;
4. importorg.springframework.context.support.ClassPathXmlApplicationContext;
7. publicclassTest{
9. /**
10. *@paramargs
11. */
12. publicstaticvoidmain(String[]args){
14. ApplicationContextcontext=
15. newClassPathXmlApplicationContext("spring.xml");
16. System.out.println("加载配置文件结束");
17. System.out.println("--------------------------------------------");
18. JavaBeanjavaBean=(JavaBean)context.getBean("javaBean");
19. System.out.println(javaBean.getName());
20. System.out.println(javaBean.getAddress());
21. System.out.println("--------------------------------------------");
22. Beanbean=(Bean)context.getBean("bean");
23. System.out.println(bean.getName());
24. System.out.println(bean.getAddress());
25. System.out.println(bean.getAge());
26. System.out.println("--------------------------------------------");
28. }
30. }

1. <?xmlversion="1.0"encoding="UTF-8"?>
2. <!DOCTYPEbeansPUBLIC"-//SPRING//DTDBEAN//EN""http://www.springframework.org/dtd/spring-beans.dtd">
3. <beans>
4. <beanid="propertyConfigurer"class="com.test.annotation.AnnotationBeanPostProcessor">
5. <propertyname="locations">
6. <list>
7. <value>classpath*:system.properties</value>
8. </list>
9. </property>
10. </bean>
11. <beanid="javaBean"class="com.test.JavaBean">
12. <propertyname="address"value="${com.test.JavaBean.address}"></property>
13. </bean>
14. <beanid="bean"class="com.test.Bean">
15. <propertyname="name"value="${com.test.Bean.name}"></property>
16. </bean>
17. </beans>

ps:之所以要继承PropertyPlaceholderConfigurer类,还有一个原因就是,原来通过${}注入值的方式还可以用

BeanPostProcessor有两个方法,为什么要写在postProcessBeforeInitialization里面,而不是postProcessAfterInitialization里面,原因在于postProcessBeforeInitialization方法是在Bean的init方法之前执行,在init方法里面可能会用到类的属性,所以必须在init方法执行之前先赋值好.