Java自定義註解詳解（基礎原理和應用舉例）

 

一、什麼是註解

對於很多初次接觸的開發者來說應該都有這個疑問？Annotation是Java5開始引入的新特徵，中文名稱叫註解。它提供了一種安全的類似註釋的機制，用來將任何的信息或元數據（metadata）與程序元素（類、方法、成員變量等）進行關聯。爲程序的元素（類、方法、成員變量）加上更直觀更明瞭的說明，這些說明信息是與程序的業務邏輯無關，並且供指定的工具或框架使用。Annontation像一種修飾符一樣，應用於包、類型、構造方法、方法、成員變量、參數及本地變量的聲明語句中。
　　Java註解是附加在代碼中的一些元信息，用於一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。註解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。

 

二、註解的作用

1、生成文檔。這是最常見的，也是java 最早提供的註解。常用的有@param @return 等
2、跟蹤代碼依賴性，實現替代配置文件功能。比如Dagger 2依賴注入，未來java開發，將大量註解配置，具有很大用處;
3、在編譯時進行格式檢查。如@override 放在方法前，如果你這個方法並不是覆蓋了超類方法，則編譯時就能檢查出。

 

三、註解的原理

註解本質是一個繼承了Annotation的特殊接口，其具體實現類是Java運行時生成的動態代理類。而我們通過反射獲取註解時，返回的是Java運行時生成的動態代理對象$Proxy1。通過代理對象調用自定義註解（接口）的方法，會最終調用AnnotationInvocationHandler的invoke方法。該方法會從memberValues這個Map中索引出對應的值。而memberValues的來源是Java常量池。

 

四、註解的使用基礎

1.註解的定義：Java文件叫做Annotation，用@interface表示。

2.元註解：@interface上面按需要註解上一些東西，包括@Retention、@Target、@Document、@Inherited四種。

3.註解的保留策略：

　　@Retention(RetentionPolicy.SOURCE)   // 註解僅存在於源碼中，在class字節碼文件中不包含

　　@Retention(RetentionPolicy.CLASS)     // 默認的保留策略，註解會在class字節碼文件中存在，但運行時無法獲得

　　@Retention(RetentionPolicy.RUNTIME)  // 註解會在class字節碼文件中存在，在運行時可以通過反射獲取到

4.註解的作用目標：

　　@Target(ElementType.TYPE)                      // 接口、類、枚舉、註解

　　@Target(ElementType.FIELD)                     // 字段、枚舉的常量

　　@Target(ElementType.METHOD)                 // 方法

　　@Target(ElementType.PARAMETER)            // 方法參數

　　@Target(ElementType.CONSTRUCTOR)       // 構造函數

　　@Target(ElementType.LOCAL_VARIABLE)   // 局部變量

　　@Target(ElementType.ANNOTATION_TYPE) // 註解

　　@Target(ElementType.PACKAGE)               // 包

5.註解包含在javadoc中：

　　@Documented

6.註解可以被繼承：

　　@Inherited

7.註解解析器：用來解析自定義註解。

 

五、常用註解

1.）Override
      java.lang.Override是一個標記類型註解，它被用作標註方法。它說明了被標註的方法重載了父類的方法，起到了斷言的作用。如果我們使用了這種註解在一個沒有覆蓋父類方法的方法時，java編譯器將以一個編譯錯誤來警示。
2.）Deprecated
     Deprecated也是一種標記類型註解。當一個類型或者類型成員使用@Deprecated修飾的話，編譯器將不鼓勵使用這個被標註的程序元素。所以使用這種修飾具有一定的“延續性”：如果我們在代碼中通過繼承或者覆蓋的方式使用了這個過時的類型或者成員，雖然繼承或者覆蓋後的類型或者成員並不是被聲明爲@Deprecated，但編譯器仍然要報警。
3.）SuppressWarnings
     SuppressWarning不是一個標記類型註解。它有一個類型爲String[]的成員，這個成員的值爲被禁止的警告名。對於javac編譯器來講，被-Xlint選項有效的警告名也同樣對@SuppressWarings有效，同時編譯器忽略掉無法識別的警告名。
　　@SuppressWarnings("unchecked")

 

六、註解例子-spring日誌

package com.zjq.eureka.user.aspect;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD})
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface SpringLog {
	/** 模塊 */
    String title() default "";
 
    /** 功能 */
    String action() default "";
    
    /** 請求地址 */
    String requestUrl();
}

package com.zjq.eureka.user.aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@Aspect
@Component
public class LogAspect {
	//切入點
    @Pointcut(value = "@annotation(com.zjq.eureka.user.aspect.SpringLog)")
    private void pointcut() {
    	log.info("進入切入點！" );
    }

    /**
     * 在方法執行前
     *
     * @param point
     * @param myLog
     * @return
     */
    @Around(value = "pointcut() && @annotation(myLog)")
    public Object around(ProceedingJoinPoint point, SpringLog myLog) {

    	log.info("執行了around方法");

        String requestUrl = myLog.requestUrl();
        String title = myLog.title();
        String action = myLog.action();

        //攔截的類名
        Class<? extends Object> clazz = point.getTarget().getClass();
        //攔截的方法
        Method method = ((MethodSignature) point.getSignature()).getMethod();

        log.info("執行了 類:" + clazz + " 方法:" + method + " 自定義請求地址:" + requestUrl);
        log.info("請求模塊："  +title+ "功能描述：" + action );
        try {
            return point.proceed(); //執行程序
        } catch (Throwable throwable) {
            throwable.printStackTrace();
            return throwable.getMessage();
        }
    }

    /**
     * 方法執行後
     *
     * @param joinPoint
     * @param myLog
     * @param result
     * @return
     */
    @AfterReturning(value = "pointcut() && @annotation(myLog)", returning = "result")
    public Object afterReturning(JoinPoint joinPoint, SpringLog myLog, Object result) {

//        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
//        HttpSession session = request.getSession();

    	log.info("執行了afterReturning方法");

    	log.info("執行結果：" + result);

        return result;
    }

    /**
     * 方法執行後 並拋出異常
     *
     * @param joinPoint
     * @param myLog
     * @param ex
     */
    @AfterThrowing(value = "pointcut() && @annotation(myLog)", throwing = "ex")
    public void afterThrowing(JoinPoint joinPoint, SpringLog myLog, Exception ex) {
    	log.info("執行了afterThrowing方法");
    	log.info("請求：" + myLog.requestUrl() + " 出現異常");
    }

}

@SpringLog(requestUrl="/testAspect",action="測試日誌註解",title="註解")
	@RequestMapping(value="/testAspect", method=RequestMethod.GET)
	public String testAspect() {
		
		return "success";
	}

借鑑：https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html