概述

Java5.0注解可以看做Javadoc和Xdoclet標(biāo)簽的延伸和發(fā)展，在Java5.0中可以自定義這些標(biāo)簽，并通過Java語言的反射機(jī)制獲取類中標(biāo)注的注解，完成特定的功能。

注解是代碼的附屬信息，它遵循一個(gè)基本的原則：注解不能直接干擾程序代碼的運(yùn)行，無論增加或者刪除注解，代碼都能正常運(yùn)行。

Java語言解釋器會(huì)忽略這些注解，而由第三方工具負(fù)責(zé)對(duì)注解進(jìn)行處理。 第三方工具可以利用代碼中的注解間接控制程序代碼的運(yùn)行，它們通過Java反射機(jī)制讀取注解的信息，并根據(jù)這些信息更改目標(biāo)程序的邏輯。

元注解Meta-annotation

元注解的作用就是負(fù)責(zé)注解其他注解。

Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型，它們被用來提供對(duì)其它 annotation類型作說明。

Java5.0定義的元注解：　

• - @Target
• - @Retention
• - @Documented
• - @Inherited

這幾個(gè)類都在java.lang.annotation包中

@Target

@Target主要說明Annotation所修飾的對(duì)象范圍。

Annotation可被用于 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構(gòu)造方法、成員變量、枚舉值）、方法參數(shù)和本地變量（如循環(huán)變量、catch參數(shù)）。

在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)。

作用：用于描述注解的使用范圍，即被描述的注解可以用在什么地方。

取值(ElementType)有： @Target(ElementType.XXX)取值如下

• - TYPE:類、接口、注解類、Enum聲明處，相應(yīng)的注解稱為類型注解
• - FIELD:類成員變量或者常量聲明處，相應(yīng)的注解被稱為域值注解
• - METHOD：方法處聲明，相應(yīng)的注解稱為方法注解
• - PARAMETER:參數(shù)聲明處，相應(yīng)的注解稱為參數(shù)注解
• - CONSTRUCTOR:構(gòu)造函數(shù)聲明處，相應(yīng)的注解稱為構(gòu)造函數(shù)注解
• - LOCAL_VARIABLE:局部變量聲明處，相應(yīng)的注解稱為局域比納涼注解
• - PACKAGE:包聲明處，相應(yīng)的注解被稱為包注解

舉例：

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 *
 * @Description: 注解@DataSource既可以加在方法上，也可以加在接口或者接口的實(shí)現(xiàn)類上
 *              
 * 
 * @author: Mr.Yang
 * @date: 2017年7月24日 下午9:59:29
 */
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
    // 和配置文件中 dynamicDatasourceMap中的key保持一致
    public static String PR_RB = "dataSourcePR";
    public static String DR_RB = "dataSourceDR";
    public static String PR_CC = "dataSourceCC";
    /**
     * 
     * 
     * @Title: name
     * 
     * @Description: 如果僅標(biāo)注@DataSource 默認(rèn)為PR_RB數(shù)據(jù)庫實(shí)例
     * 
     * @return
     * 
     * @return: String
     */
    String name() default DataSource.PR_RB;
}

@Retention

@Retention定義了該Annotation被保留的時(shí)間長短.

某些Annotation僅出現(xiàn)在源代碼中，而被編譯器丟棄；

而另一些卻被編譯在class文件中,編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略，

而另一些在class被裝載時(shí)將被讀?。ú⒉挥绊慶lass的執(zhí)行，因?yàn)锳nnotation與class在使用上是被分離的）。

使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制。

作用：表示需要在什么級(jí)別保存該注釋信息，用于描述注解的生命周期（即被描述的注解在什么范圍內(nèi)有效）

Retention meta-annotation類型有唯一的value作為成員，它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。

取值（RetentionPoicy）有：

• SOURCE:在源文件中有效（即源文件保留）,單對(duì)應(yīng)的字節(jié)碼文件將不再保留
• CLASS:在class文件中有效（即class保留），但類家愛妻加載字節(jié)碼文件時(shí)不會(huì)將注解加載到JVM中，即運(yùn)行期不能獲取注解信息
• RUNTIME:在運(yùn)行時(shí)有效（即運(yùn)行時(shí)保留），注解信息在目標(biāo)類加載到JVM后依然保留，在運(yùn)行期可以通過反射機(jī)制讀取類中的注解信息

比如

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
    .......
}

@Documented

@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個(gè)標(biāo)記注解，沒有成員。

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
    .......
}

@Inherited

@Inherited 元注解是一個(gè)標(biāo)記注解，@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class，則這個(gè)annotation將被用于該class的子類。

@Inherited annotation類型是被標(biāo)注過的class的子類所繼承。類并不從它所實(shí)現(xiàn)的接口繼承annotation，方法并不從它所重載的方法繼承annotation。

當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強(qiáng)了這種繼承性。如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí)，反射代碼檢查將展開工作：檢查class和其父類，直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)，或者到達(dá)類繼承結(jié)構(gòu)的頂層。

自定義注解

使用@interface自定義注解時(shí)，自動(dòng)繼承了java.lang.annotation.Annotation接口，由編譯程序自動(dòng)完成其他細(xì)節(jié)。

在定義注解時(shí)，不能繼承其他的注解或接口。

@interface用來聲明一個(gè)注解，其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。

方法的名稱就是參數(shù)的名稱，返回值類型就是參數(shù)的類型（返回值類型只能是基本類型、Class、String、enum）。

可以通過default來聲明參數(shù)的默認(rèn)值。

定義注解格式：

　public @interface 注解名 {定義體}

注解參數(shù)的可支持?jǐn)?shù)據(jù)類型

所有基本數(shù)據(jù)類型（int,float,boolean,byte,double,char,long,short)

• String類型
• Class類型
• enum類型
• Annotation類型
• 以上所有類型的數(shù)組

Annotation類型里面的參數(shù)設(shè)定規(guī)則：

第一,只能用public或默認(rèn)(default)這兩個(gè)訪問權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型；　 　

第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;　　

第三,如果只有一個(gè)參數(shù)成員,最好把參數(shù)名稱設(shè)為”value”,后加小括號(hào).

實(shí)例

代碼已托管到Github—> https://github.com/yangshangwei/SpringMaster

通常情況下，第三方工具不但負(fù)責(zé)處理特定的注解，其本身還提供了這些注解的定義。 事實(shí)上，定義注解類本身并不困難，Java提供了定義注解的語法，如上所述。

編寫注解類

我們著手來編寫一個(gè)簡單的注解類

package com.xgj.aop.spring.advisor.anno;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 
 * 
 * @ClassName: NeedTest
 * 
 * @Description: 自定義注解
 * 
 * @author: Mr.Yang
 * 
 * @date: 2017年8月23日 下午4:50:11
 */
// 聲明注解的保留期限
@Retention(RetentionPolicy.RUNTIME)
// 聲明可以使用該注解的目標(biāo)類型
@Target(ElementType.METHOD)
// 可以被javadoc此類的工具文檔化
@Documented
public @interface NeedTestAnnotation { // 定義注解
    // 聲明注解成員
    boolean value() default false;
}

Java新語法規(guī)定使用@interface修飾符定義注解類，一個(gè)注解可以擁有多個(gè)成員，成員聲明和接口方法聲明類似，這里僅僅定義了一個(gè)成員。

成員聲明以下幾點(diǎn)限制：

• 成員以無入?yún)?，無拋出異常的方式聲明， 以下方式是不合法的 比如 boolean value(String xx)、boolean value()throws Exception等是非法的
• 可以通過default成員指定一個(gè)默認(rèn)值，比如 String level() defalut “LOW_LEVEL”, int high() default 2 是合法的，當(dāng)然也可以不指定默認(rèn)值。
• 成員類型是受限制的，成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;　　 而 List foo() 、ForumServer value()是不合法的。

如果注解只有一個(gè)成員，成員名建議為value().

在使用時(shí)可以忽略成員和賦值號(hào)（=），比如 @NeedTestAnnotation(true).

當(dāng)注解類擁有多個(gè)成員時(shí)，如果僅僅對(duì)value成員進(jìn)行賦值，則也可不使用賦值號(hào)。

如果同時(shí)對(duì)多個(gè)成員進(jìn)行賦值，這必須使用賦值號(hào)，比如 @DecalreParents(value=”XXX”,defaultImpl=XXX).

注解類可以沒有成員，沒有成員的注解稱為標(biāo)注注解，解釋程序以標(biāo)識(shí)注解存在與否進(jìn)行相應(yīng)的處理

此外，所有的注解都隱式繼承與java.lang.annotation.Annotation，但注解不允許顯示繼承其他的接口。

使用注解

我們?cè)跇I(yè)務(wù)類中，使用NeedTestAnnotation注解，標(biāo)注業(yè)務(wù)方法是否需要測(cè)試。

如下

package com.xgj.aop.spring.advisor.anno;
/**
 * 
 * 
 * @ClassName: ForumService
 * 
 * @Description: 演示使用自定義注解@NeedTestAnnotation
 * 
 * @author: Mr.Yang
 * 
 * @date: 2017年8月23日 下午5:15:18
 */
public class ForumService {
    @NeedTestAnnotation
    public void removeTopicId(int topicId) {
        System.out.println("remove topicId" + topicId);
    }
    @NeedTestAnnotation(true)
    public void removeForumId(int forumId) {
        System.out.println("remove forumId" + forumId);
    }
}

如果注解類和目標(biāo)類不在同一個(gè)包中，這需要通過improt引用注解類。

在標(biāo)注注解時(shí)，可以通過以下格式對(duì)注解成員進(jìn)行賦值

@<注解名>(<成員名1>=<成員值1>,<成員名2>=<成員值2>,.....)

如果成員是數(shù)組類型，這可以通過{}進(jìn)行賦值，比如 boolean數(shù)組的成員可以設(shè)置為{true,false,true}

訪問注解

我們說過，注解不會(huì)直接影響程序的運(yùn)行，但是第三方程序或者工具可以利用代碼中的注解完成特殊的任務(wù)，間接控制程序的運(yùn)行。 對(duì)于RetentionPolicy.RUNTIME保留期限的注解，可以通過反射機(jī)制訪問類中的注解。

在Java5.0中，Package、Class、Constructor、Method以及Field 等反射對(duì)象都新增了訪問注解信息的方法：<T extends Annotation>T getAnnotation(Class<T> annotationClass)該方法支持通過泛型直接返回注解對(duì)象.

下面通過反射來訪問注解，得到ForumService類中通過@NeedTestAnnotation注解所承載的測(cè)試需求

package com.xgj.aop.spring.advisor.anno;
import java.lang.reflect.Method;
import org.junit.Test;
/**
 * 
 * 
 * @ClassName: AnnotaitionSelfDefineTool
 * 
 * @Description: 訪問注解
 * 
 * @author: Mr.Yang
 * 
 * @date: 2017年8月23日 下午5:18:26
 */
public class AnnotaitionSelfDefineTool {
    @Test
    public void test() {
        // 得到對(duì)應(yīng)的Class
        Class<ForumService> clazz = ForumService.class;
        // 因?yàn)闃?biāo)注在方法上,所以先得到對(duì)應(yīng)的方法
        Method[] methods = clazz.getDeclaredMethods();
        System.out.println(clazz.getName() + " 有 " + methods.length + " 個(gè)方法");
        // 遍歷方法
        for (Method method : methods) {
            // 獲取方法上的注解
            NeedTestAnnotation needTestAnnotation = method
                    .getAnnotation(NeedTestAnnotation.class);
            // 判斷是否有標(biāo)注此注解
            if (needTestAnnotation != null) {
                // 獲取注解中定義的值，做處理
                if (needTestAnnotation.value()) {
                    System.out.println(method.getName() + "需要測(cè)試");
                } else {
                    System.out.println(method.getName() + "不需要測(cè)試");
                }
            }
        }
    }
}

單元測(cè)試結(jié)果：

com.xgj.aop.spring.advisor.anno.ForumService 有 2 個(gè)方法

removeTopicId不需要測(cè)試

removeForumId需要測(cè)試

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論