java中自定義注解的應用

  要想深刻的理解注解，我們必須能實現自己的注解，然后應用自己的注解去實現特定的業務，使用注解可以更優雅的做到某些事情。

有這樣一個場景，在需要文件導出時，我們需要將一個model中的一些重要字段導出到csv文件中去，當然還有一些沒用的或者不能暴露的字段，不需要導出到文件中，這樣業務如果一般實現起來我們可以將需要導出的字段寫入一個配置文件，然后根據配置文件進行比對，需要導出的就寫入到流中實現導出。但是這樣做始終感覺擴展性不是很好，而且實現方式有點粗暴，於是想到了通過反射來做，為需要導出的字段加上自定義的注解，當該屬性被注解時導出，我們來看看實現方式。

首先自定義注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)

//文件導出時，只導出帶有改注解的字段
public @interface ExportFieldAnnotation {

}

然后，在model中需要導出的字段上添加該注解：

public class IndicatorModel {
    private String indexId;
    @ExportFieldAnnotation
    private String indexName;
    @ExportFieldAnnotation
    private String indexRule;
    @ExportFieldAnnotation
    private String indexField;
    @ExportFieldAnnotation
    private Integer indexType;//1私有  2公有
    @ExportFieldAnnotation
    private Integer sort;

  //getter and setter
}

最后，在導出的時候，通過反射獲取到該對象屬性的注解，完成業務規則：

 public static String genTitle(Field[] fAll){
        List titles = new ArrayList<>();
        for(int i=0;i<fAll.length;i++){
            //獲取該字段所有的注解
            Annotation[] annotations = fAll[i].getDeclaredAnnotations();
            for(Annotation annotation : annotations){
                //只獲取指定注解的字段
                if(annotation instanceof ExportFieldAnnotation){
                    titles.add(fAll[i].getName());
                }
            }
        }
        String s = StringUtils.join(titles,",");
        logger.info("export titles : " + s );
        return s;
    }

可以看到，對傳進來的field數組，遍歷循環，當屬性的注解包含我們自定義的注解的時候，才把這個字段寫入到title當中去。

下面我們整理一下幾個元注解的含義（以下摘抄自：http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html）：

            1. @Target：

    說明了Annotation所修飾的對象范圍：Annotation可被用於 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構造方法、成員變量、枚舉值）、方法參數和本地變量（如循環變量、catch參數）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。

       取值(ElementType)有：

　　　　1.CONSTRUCTOR:用於描述構造器
　　　　2.FIELD:用於描述域
　　　　3.LOCAL_VARIABLE:用於描述局部變量
　　　　4.METHOD:用於描述方法
　　　　5.PACKAGE:用於描述包
　　　　6.PARAMETER:用於描述參數
　　　　7.TYPE:用於描述類、接口(包括注解類型) 或enum聲明

　　　　2.@Retention：

    @Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。

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

　　取值（RetentionPoicy）有：

　　　　1.SOURCE:在源文件中有效（即源文件保留）
　　　　2.CLASS:在class文件中有效（即class保留）
　　　　3.RUNTIME:在運行時有效（即運行時保留）

　　　3.@Documented：

　　@Documented用於描述其它類型的annotation應該被作為被標注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個標記注解，沒有成員。

　　　4.@Inherited：

 

      @Inherited 元注解是一個標記注解，@Inherited闡述了某個被標注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用於一個class，則這個annotation將被用於該class的子類。

 

　　注意：@Inherited annotation類型是被標注過的class的子類所繼承。類並不從它所實現的接口繼承annotation，方法並不從它所重載的方法繼承annotation。

 

　　當@Inherited annotation類型標注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時，反射代碼檢查將展開工作：檢查class和其父類，直到發現指定的annotation類型被發現，或者到達類繼承結構的頂層。

           5.自定義注解：

      使用@interface自定義注解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細節。在定義注解時，不能繼承其他的注解或接口。@interface用來聲明一個注解，其中的每一個方法實際上是聲明了一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數的默認值。

　　定義注解格式：
　　public @interface 注解名 {定義體}

　　注解參數的可支持數據類型：

　　　　1.所有基本數據類型（int,float,boolean,byte,double,char,long,short)
　　　　2.String類型
　　　　3.Class類型
　　　　4.enum類型
　　　　5.Annotation類型
　　　　6.以上所有類型的數組

　　Annotation類型里面的參數該怎么設定: 
　　第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為defaul默認類型；　 　
　　第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這里的參數成員就為String;　　
　　第三,如果只有一個參數成員,最好把參數名稱設為"value",后加小括號。

 

明白了自定義注解怎么使用了，下面我們來看一個更加經典的使用場景：

為每一個接口加一個@ExecTime，實現計算每一個接口從請求到返回的時間。

首先，我們自定義一個注解：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExecTime {
    String value() default "";
}

然后，我們通過aspectj去實現注解的業務：

@Aspect
@Component
public class MethodTimeAspect {
    private final static Logger logger = LoggerFactory.getLogger(MethodTimeAspect.class);

    @Pointcut("@annotation(com.usst.user.auth.annotation.ExecTime)")
    public void pointCut() {
    }

    @Around("pointCut()")
    public Object useTime(ProceedingJoinPoint joinPoint) {
        Object out = null;
        try {
            String className = joinPoint.getTarget().getClass().getSimpleName();
            logger.info(String.format(" Method [%s.%s()] start", className, joinPoint.getSignature().getName()));
            long start = System.currentTimeMillis();
            out = joinPoint.proceed();
            long elapsedTime = System.currentTimeMillis() - start;
            logger.info(String.format(" Method [%s.%s()] execution time:%sms", className, joinPoint.getSignature().getName(), elapsedTime));
        } catch (Throwable throwable) {
            logger.error("aop record method exec time error", throwable);
        }
        return out;
    }
}

這樣，我們完成了在這個自定義注解的方法上，織入了打印請求時間和請求響應耗時的業務，只需要在對應的controller層上的接口，加上對應的注解就可以了。