碼上快樂

相關內容    簡體    繁體

Java注解的基本概念和原理及其簡單實用

本文轉載自   查看原文   2018-05-08 08:01   2681    Java SE（Java基礎篇）/ Java EE（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


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 iptables實用教程（一）：基本概念和原理 Java中的泛型 (上) - 基本概念和原理 HAProxy原理和基本概念 Ajax基本概念和原理 深入理解Java：注解（Annotation）基本概念 熒光基本概念和原理 Jenkins 基本概念與原理 深入理解Java：注解（Annotation）基本概念 通信原理基本概念 Java基本概念（1）什么是Java
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM