Java注解的基本概念和原理及其简单实用

 

一、注解的基本概念和原理及其简单实用

注解（Annotation）提供了一种安全的类似注释的机制，为我们在代码中添加信息提供了一种形式化得方法，使我们可以在稍后某个时刻方便的使用这些数据（通过解析注解来使用这些数据），用来将任何的信息或者元数据与程序元素（类、方法、成员变量等）进行关联。其实就是更加直观更加明了的说明，这些说明信息与程序业务逻辑没有关系，并且是供指定的工具或框架使用的。Annotation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的申明语句中。

Annotation其实是一种接口。通过Java的反射机制相关的API来访问Annotation信息。相关类（框架或工具中的类）根据这些信息来决定如何使用该程序元素或改变它们的行为。Java语言解释器在工作时会忽略这些Annotation，因此在JVM中这些Annotation是“不起作用”的，只能通过配套的工具才能对这些Annotation类型的信息进行访问和处理。

Annotation和interface的异同：

1、 annotition的类型使用关键字@interface而不是interface。它继承了java.lang.annotition.Annotition接口，并非申明了一个interface。

2、 Annotation类型、方法定义是独特的、受限制的。Annotation类型的方法必须申明为无参数、无异常抛出的。这些方法定义了Annotation的成员：方法名称为了成员名，而方法返回值称为了成员的类型。而方法返回值必须为primitive类型、Class类型、枚举类型、Annotation类型或者由前面类型之一作为元素的一位数组。方法的后面可以使用default和一个默认数值来申明成员的默认值，null不能作为成员的默认值，这与我们在非Annotation类型中定义方法有很大不同。Annotation类型和他的方法不能使用Annotation类型的参数，成员不能是generic。只有返回值类型是Class的方法可以在Annotation类型中使用generic，因为此方法能够用类转换将各种类型转换为Class。

参考链接：https://blog.csdn.net/u010987379/article/details/52152795

3、 Annotation类型又与接口有着近似之处。它们可以定义常量、静态成员类型（比如枚举类型定义）。Annotation类型也可以如接口一般被实现或者继承。

* 元注解@Target,@Retention,@Documented,@Inherited 
* 
* @Target 表示该注解用于什么地方，可能的 ElemenetType 参数包括： 
* ElemenetType.CONSTRUCTOR 构造器声明 
* ElemenetType.FIELD 域声明（包括 enum 实例） 
* ElemenetType.LOCAL_VARIABLE 局部变量声明 
* ElemenetType.METHOD 方法声明 
* ElemenetType.PACKAGE 包声明 
* ElemenetType.PARAMETER 参数声明 
* ElemenetType.TYPE 类，接口（包括注解类型）或enum声明 
* 
* @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括： 
* RetentionPolicy.SOURCE 注解将被编译器丢弃 
* RetentionPolicy.CLASS 注解在class文件中可用，但会被VM丢弃 
* RetentionPolicy.RUNTIME VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。 
* 
* @Documented 将此注解包含在 javadoc 中 
* 
* @Inherited 允许子类继承父类中的注解

@Target(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented 
@Inherited

下面的示例来简单的讲述spring注解原理：

本例实现了在set方法上和在字段属性上注解的处理解析。

1、定义注解

Java代码  

1. package com.yt.annotation;  
2.   
3. import java.lang.annotation.ElementType;  
4. import java.lang.annotation.Retention;  
5. import java.lang.annotation.RetentionPolicy;  
6. import java.lang.annotation.Target;  
7.   
8. /** 
9.  * @Description:定义注解 
10.  * @ClassName: ZxfResource 
11.  * @Project: spring-aop 
12.  * @Author: zxf 
13.  * @Date: 2011-6-7 
14.  */  
15. // 在运行时执行  
16. @Retention(RetentionPolicy.RUNTIME)  
17. // 注解适用地方(字段和方法)  
18. @Target({ ElementType.FIELD, ElementType.METHOD })  
19. public @interface ZxfResource {  
20.   
21.     //注解的name属性  
22.     public String name() default "";  
23. }  

 2、带有注解的服务类

Java代码  

1. package com.yt.annotation;  
2.   
3. /** 
4.  * @Description: 带有注解的服务 
5.  * @ClassName: UserDaoImpl 
6.  * @Project: spring-aop 
7.  * @Author: zxf 
8.  * @Date: 2011-6-7 
9.  */  
10. public class UserServiceImpl {  
11.   
12.     public UserDaoImpl userDao;  
13.     public User1DaoImpl user1Dao;  
14.   
15.     // 字段上的注解,可以配置name属性  
16.     @ZxfResource  
17.     public User2DaoImpl user2Dao;  
18.   
19.     // set方法上的注解，带有name属性  
20.     @ZxfResource(name = "userDao")  
21.     public void setUserDao(UserDaoImpl userDao) {  
22.         this.userDao = userDao;  
23.     }  
24.   
25.     // set方法上的注解，没有配置name属性  
26.     @ZxfResource  
27.     public void setUser1Dao(User1DaoImpl user1Dao) {  
28.         this.user1Dao = user1Dao;  
29.     }  
30.   
31.     public void show() {  
32.         userDao.show();  
33.         user1Dao.show1();  
34.         user2Dao.show2();  
35.         System.out.println("这里是Service方法........");  
36.     }  
37. }  

 3、要注入的DAO

Java代码  

1. package com.yt.annotation;  
2.   
3. /** 
4.  * @Description: 要注入的DAo类 
5.  * @ClassName: UserDaoImpl 
6.  * @Project: spring-aop 
7.  * @Author: zxf 
8.  * @Date: 2011-6-7 
9.  */  
10. public class UserDaoImpl {  
11.       
12.     String name ;  
13.       
14.     public void show(){  
15.         System.out.println("这里是dao方法........");  
16.     }  
17. }  

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans>  
3.     <bean id = "userDao" class="com.yt.annotation.UserDaoImpl" />  
4.     <bean id = "user1Dao" class="com.yt.annotation.User1DaoImpl" />  
5.     <bean id = "user2Dao" class="com.yt.annotation.User2DaoImpl" />  
6.     <bean id = "userService" class = "com.yt.annotation.UserServiceImpl" />  
7. </beans>  

 

 4、注解处理器

Java代码  

1. package com.yt.annotation;  
2.   
3. import java.beans.Introspector;  
4. import java.beans.PropertyDescriptor;  
5. import java.lang.reflect.Field;  
6. import java.lang.reflect.Method;  
7. import java.util.ArrayList;  
8. import java.util.HashMap;  
9. import java.util.Iterator;  
10. import java.util.List;  
11. import java.util.Map;  
12. import org.apache.log4j.Logger;  
13. import org.dom4j.Document;  
14. import org.dom4j.DocumentException;  
15. import org.dom4j.Element;  
16. import org.dom4j.io.SAXReader;  
17.   
18. /** 
19.  * @Description: spring中的注解原理 
20.  * @ClassName: ClassPathXMLApplicationContext 
21.  * @Project: spring-aop 
22.  * @Author: zxf 
23.  * @Date: 2011-6-3 
24.  */  
25. public class ClassPathXMLApplicationContext {  
26.   
27.     Logger log = Logger.getLogger(ClassPathXMLApplicationContext.class);  
28.   
29.     List<BeanDefine> beanList = new ArrayList<BeanDefine>();  
30.     Map<String, Object> sigletions = new HashMap<String, Object>();  
31.   
32.     public ClassPathXMLApplicationContext(String fileName) {  
33.         //读取配置文件中管理的bean  
34.         this.readXML(fileName);  
35.         //实例化bean  
36.         this.instancesBean();  
37.         //注解处理器  
38.         this.annotationInject();  
39.     }  
40.   
41.     /** 
42.      * 读取Bean配置文件 
43.      * @param fileName 
44.      * @return 
45.      */  
46.     @SuppressWarnings("unchecked")  
47.     public void readXML(String fileName) {  
48.         Document document = null;  
49.         SAXReader saxReader = new SAXReader();  
50.         try {  
51.             ClassLoader classLoader =   
52.                 Thread.currentThread().getContextClassLoader();  
53.             document = saxReader.read(classLoader.getResourceAsStream(fileName));  
54.             Element beans = document.getRootElement();  
55.             for (Iterator<Element> beansList = beans.elementIterator();   
56.                 beansList.hasNext();) {  
57.                 Element element = beansList.next();  
58.                 BeanDefine bean = new BeanDefine(  
59.                         element.attributeValue("id"),  
60.                         element.attributeValue("class"));  
61.                 beanList.add(bean);  
62.             }  
63.         } catch (DocumentException e) {  
64.             log.info("读取配置文件出错....");  
65.         }  
66.     }  
67.       
68.     /** 
69.      * 实例化Bean 
70.      */  
71.     public void instancesBean() {  
72.         for (BeanDefine bean : beanList) {  
73.             try {  
74.                 sigletions.put(bean.getId(),   
75.                         Class.forName(bean.getClassName()).newInstance());  
76.             } catch (Exception e) {  
77.                 log.info("实例化Bean出错...");  
78.             }  
79.         }  
80.     }  
81.       
82.     /** 
83.      * 注解处理器 
84.      * 如果注解ZxfResource配置了name属性，则根据name所指定的名称获取要注入的实例引用， 
85.      * 如果注解ZxfResource;没有配置name属性，则根据属性所属类型来扫描配置文件获取要 
86.      * 注入的实例引用 
87.      *  
88.      */  
89.     public void annotationInject(){  
90.         for(String beanName:sigletions.keySet()){  
91.             Object bean = sigletions.get(beanName);  
92.             if(bean!=null){  
93.                 this.propertyAnnotation(bean);  
94.                 this.fieldAnnotation(bean);  
95.             }  
96.         }  
97.     }  
98.       
99.     /** 
100.      * 处理在set方法加入的注解 
101.      * @param bean 处理的bean 
102.      */  
103.     public void propertyAnnotation(Object bean){  
104.         try {  
105.             //获取其属性的描述  
106.             PropertyDescriptor[] ps =   
107.                 Introspector.getBeanInfo(bean.getClass()).getPropertyDescriptors();  
108.             for(PropertyDescriptor proderdesc : ps){  
109.                 //获取所有set方法  
110.                 Method setter = proderdesc.getWriteMethod();  
111.                 //判断set方法是否定义了注解  
112.                 if(setter!=null && setter.isAnnotationPresent(ZxfResource.class)){  
113.                     //获取当前注解，并判断name属性是否为空  
114.                     ZxfResource resource = setter.getAnnotation(ZxfResource.class);  
115.                     String name ="";  
116.                     Object value = null;  
117.                     if(resource.name()!=null&&!"".equals(resource.name())){  
118.                         //获取注解的name属性的内容  
119.                         name = resource.name();  
120.                         value = sigletions.get(name);  
121.                     }else{ //如果当前注解没有指定name属性,则根据类型进行匹配  
122.                         for(String key : sigletions.keySet()){  
123.                             //判断当前属性所属的类型是否在配置文件中存在  
124.                             if(proderdesc.getPropertyType().isAssignableFrom(sigletions.get(key).getClass())){  
125.                                 //获取类型匹配的实例对象  
126.                                 value = sigletions.get(key);  
127.                                 break;  
128.                             }  
129.                         }  
130.                     }  
131.                     //允许访问private方法  
132.                     setter.setAccessible(true);  
133.                     //把引用对象注入属性  
134.                     setter.invoke(bean, value);   
135.                 }  
136.             }  
137.         } catch (Exception e) {  
138.             log.info("set方法注解解析异常..........");  
139.         }  
140.     }  
141.       
142.     /** 
143.      * 处理在字段上的注解 
144.      * @param bean 处理的bean 
145.      */  
146.     public void fieldAnnotation(Object bean){  
147.         try {  
148.             //获取其全部的字段描述  
149.             Field[] fields = bean.getClass().getFields();  
150.             for(Field f : fields){  
151.                 if(f!=null && f.isAnnotationPresent(ZxfResource.class)){  
152.                     ZxfResource resource = f.getAnnotation(ZxfResource.class);  
153.                     String name ="";  
154.                     Object value = null;  
155.                     if(resource.name()!=null&&!"".equals(resource.name())){  
156.                         name = resource.name();  
157.                         value = sigletions.get(name);  
158.                     }else{  
159.                         for(String key : sigletions.keySet()){  
160.                             //判断当前属性所属的类型是否在配置文件中存在  
161.                             if(f.getType().isAssignableFrom(sigletions.get(key).getClass())){  
162.                                 //获取类型匹配的实例对象  
163.                                 value = sigletions.get(key);  
164.                                 break;  
165.                             }  
166.                         }  
167.                     }  
168.                     //允许访问private字段  
169.                     f.setAccessible(true);  
170.                     //把引用对象注入属性  
171.                     f.set(bean, value);  
172.                 }  
173.             }  
174.         } catch (Exception e) {  
175.             log.info("字段注解解析异常..........");  
176.         }  
177.     }  
178.       
179.     /** 
180.      * 获取Map中的对应的bean实例 
181.      * @param beanId 
182.      * @return 
183.      */  
184.     public Object getBean(String beanId) {  
185.         return sigletions.get(beanId);  
186.     }  
187.   
188.   
189.     public static void main(String[] args) {  
190.         ClassPathXMLApplicationContext path = new ClassPathXMLApplicationContext(  
191.                 "configAnnotation.xml");  
192.         UserServiceImpl userService =(UserServiceImpl)path.getBean("userService");  
193.         userService.show();  
194.     }  
195. }  

个人分类： spring