面試官：什么是 Java 注解？
本文轉載自微信公眾號「JavaFish」，作者nasus 。轉載本文請聯系JavaFish公眾號。
哈嘍，我是狗哥。隨著開發經驗的累積，我越發覺得基礎真的非常重要。比如：大部分框架 (如 Spring) 都使用了注解簡化代碼并提高編碼的效率，掌握注解是一名 JAVA 程序員必備的技能。
但我發現很多工作 2、3 年的同學居然還沒寫過自定義注解，問起注解的原理也是一臉懵。我是很震驚的，你們咋理解代碼的?基于此，今天我們就來一起學習下注解。
國際慣例，先上腦圖：
01 什么是注解?
Java 注解(Annotation)，相信大家沒用過也見過。個人理解，注解就是代碼中的特殊標記，這些標記可以在編譯、類加載、運行時被讀取，從而做相對應的處理。
注解跟注釋很像，區別是注釋是給人看的(想想自己遇到那些半句注釋沒有的業務代碼，還是不是很難受?);而注解是給程序看的，它可以被編譯器讀取。
1.1 注解的作用
注解大多時候與反射或者 AOP 切面結合使用，它的作用有很多，比如標記和檢查，最重要的一點就是簡化代碼，降低耦合性，提高執行效率。比如我司就是通過自定義注解 + AOP 切面結合，解決了寫接口重復提交的問題。
簡單描述下我司防止重復提交注解的邏輯：請求寫接口提交參數 —— 參數拼接字符串生成 MD5 編碼 —— 以 MD5 編碼加用戶信息拼接成 key，set Redis 分布式鎖，能獲取到就順利提交(分布式鎖默認 3 秒過期)，不能獲取就是重復提交了，報錯。
如果每加一個寫接口，就要寫一次以上邏輯的話，那程序員會瘋的。所以，有大佬就使用注解 + AOP 切面的方式解決了這個問題。只要在寫接口 Controller 方法上加這個注解即可解決，也方便維護。
1.2 注解的語法
以我司防止重復提交的自定義注解，介紹下注解的語法。它的定義如下：
- // 聲明 NoRepeatSubmit 注解
- @Target(ElementType.METHOD) // 元注解
- @Retention(RetentionPolicy.RUNTIME) // 元注解
- public @interface NoRepeatSubmit {
- /**
- * 鎖定時間，默認單位（秒）
- */
- long lockTime() default 3L;
- }
Java 注解使用 @interface 修飾，我司的 NoRepeatSubmit 注解也不例外。此外，還使用兩個元注解。其中 @Target 注解傳入 ElementType.METHOD 參數來標明 @NoRepeatSubmit 只能用于方法上，@Retention(RetentionPolicy.RUNTIME) 則用來表示該注解生存期是運行時，從代碼上看注解的定義很像接口的定義，在編譯后也會生成 NoRepeatSubmit.class 文件。
1.3 注解的元素
定義在注解內部的變量，稱之為元素。注解可以有元素，也可以沒有元素。像 @Override 就是無元素的注解，@SuppressWarnings 就屬于有元素的注解。
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.SOURCE)
- public @interface Override {
- }
- @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
- @Retention(RetentionPolicy.SOURCE)
- public @interface SuppressWarnings {
- String[] value();
- }
帶元素的自定義注解：
- @Target({ElementType.METHOD})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface NoRepeatSubmit {
- /**
- * 鎖定時間，默認單位（秒）
- */
- long lockTime() default 2L;
- }
1.3.1 注解元素的格式
- // 基本格式
- 數據類型 元素名稱();
- // 帶默認值
- 數據類型 元素名稱() default 默認值;
1.3.2 注解元素的數據類型
注解元素支持如下數據類型：
- 所有基本類型（int,float,boolean,byte,double,char,long,short）
- String
- Class
- enum
- Annotation
- 上述類型的數組
聲明注解元素時可以使用基本類型但不允許使用任何包裝類型，同時注解也可以作為元素的類型，也就是嵌套注解。
1.3.3 編譯器對元素默認值的限制
遵循規則：
元素要么具有默認值，要么在使用注解時提供元素的值。
對于非基本類型的元素，無論是在源代碼中聲明，還是在注解接口中定義默認值，都不能以 null 作為值。
1.4 注解的使用
注解是以 @注釋名 的格式在代碼中使用，比如：以下常見的用法。
- public class TestController {
- // NoRepeatSubmit 注解修飾 save 方法，防止重復提交
- @NoRepeatSubmit
- public static void save(Object o){
- // 保存邏輯
- }
- // 一個方法上可以有多個不同的注解
- @Deprecated
- @SuppressWarnings("uncheck")
- public static void getDate(){
- }
- }
在 save 方法上使用 @NoRepeatSubmit (我司自定義注解)，加上之后，編譯期會自動識別該注解并執行注解處理器的方法，防止重復提交;
而對于 @Deprecated 和 @SuppressWarnings (“uncheck”)，則是 Java 的內置注解，前者意味著該方法是過時的，后者則是忽略指定的異常檢查。
02 Java 注解的分類
上面介紹注解的語法和使用，我們遇到了 @Target、@Retention 等沒見過的注解，你可能有點懵。但沒關系，聽我說道說道。Java 中有 @Override、@Deprecated 和 @SuppressWarnings 等內置注解;也有 @Target、@Retention、@Documented、@Inherited 等修飾注解的注解，稱之為元注解。
2.1 內置注解
Java 定義了一套自己的注解，其中作用在代碼上的是：
@Override - 檢查該方法是否是重寫方法。如果發現其父類，或者是引用的接口中并沒有該方法時，會報編譯錯誤。
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.SOURCE)
- public @interface Override {
- }
- @Deprecated - 標記過時方法。如果使用該方法，會報編譯警告。
- @Documented
- @Retention(RetentionPolicy.RUNTIME)
- @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
- public @interface Deprecated {
- }
- @SuppressWarnings - 用于有選擇的關閉編譯器對類、方法、成員變量、變量初始化的警告。
- @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
- @Retention(RetentionPolicy.SOURCE)
- public @interface SuppressWarnings {
- String[] value();
- }
JDK7 之后又加了 3 個，這幾個的用法，我也用得很少。就不過多介紹了，感興趣的小伙伴自行百度分別是：
- @SafeVarargs - Java 7 開始支持，忽略任何使用參數為泛型變量的方法或構造函數調用產生的警告。
- @Documented
- @Retention(RetentionPolicy.RUNTIME)
- @Target({ElementType.CONSTRUCTOR, ElementType.METHOD})
- public @interface SafeVarargs {}
- @FunctionalInterface - Java 8 開始支持，標識一個匿名函數或函數式接口。
- @Documented
- @Retention(RetentionPolicy.RUNTIME)
- @Target(ElementType.TYPE)
- public @interface FunctionalInterface {}
- @Repeatable - Java 8 開始支持，標識某注解可以在同一個聲明上使用多次。
- @Documented
- @Retention(RetentionPolicy.RUNTIME)
- @Target(ElementType.ANNOTATION_TYPE)
- public @interface Repeatable {
- Class<? extends Annotation> value();
- }
2.2 元注解
元注解就是修飾注解的注解，分別有：
2.2.1 @Target
用來指定注解的作用域(如方法、類或字段)，其中 ElementType 是枚舉類型，其定義如下，也代表可能的取值范圍
- public enum ElementType {
- /**標明該注解可以作用于類、接口（包括注解類型）或enum聲明*/
- TYPE,
- /** 標明該注解可以作用于字段(域)聲明，包括enum實例 */
- FIELD,
- /** 標明該注解可以作用于方法聲明 */
- METHOD,
- /** 標明該注解可以作用于參數聲明 */
- PARAMETER,
- /** 標明注解可以作用于構造函數聲明 */
- CONSTRUCTOR,
- /** 標明注解可以作用于局部變量聲明 */
- LOCAL_VARIABLE,
- /** 標明注解可以作用于注解聲明(應用于另一個注解上)*/
- ANNOTATION_TYPE,
- /** 標明注解可以作用于包聲明 */
- PACKAGE,
- /**
- * 標明注解可以作用于類型參數聲明（1.8新加入）
- * @since 1.8
- */
- TYPE_PARAMETER,
- /**
- * 類型使用聲明（1.8新加入)
- * @since 1.8
- */
- TYPE_USE
- }
PS：如果 @Target 無指定作用域，則默認可以作用于任何元素上。等同于：
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
2.2.2 @Retention
用來指定注解的生命周期，它有三個值，對應 RetentionPolicy 中的三個枚舉值，分別是：源碼級別(source)，類文件級別(class)或者運行時級別(runtime)
- SOURCE：只在源碼中可用
- CLASS：注解在 class 文件中可用，但會被 VM 丟棄(該類型的注解信息會保留在源碼里和 class 文件里，在執行的時候，不會加載到虛擬機中)，PS：當注解未定義 Retention 值時，默認值是 CLASS，如 Java 內置注解，@Override、@Deprecated、@SuppressWarnning 等
- RUNTIME：在源碼，class，運行時均可用，因此可以通過反射機制讀取注解的信息(源碼、class 文件和執行的時候都有注解的信息)，如 SpringMvc 中的 @Controller、@Autowired、@RequestMapping 等。此外，我們自定義的注解也大多在這個級別。
2.2.2.1 理解 @Retention
這里引申一下話題，要想理解 @Retention 就要理解下從 java 文件到 class 文件再到 class 被 jvm 加載的過程了。下圖描述了從 .java 文件到編譯為 class 文件的過程：
其中有一個注解抽象語法樹的環節，這個環節其實就是去解析注解然后做相應的處理。
所以重點來了，如果你要在編譯期根據注解做一些處理，你就需要繼承 Java 的抽象注解處理器 AbstractProcessor，并重寫其中的 process () 方法。
一般來說只要是注解的 @Target 范圍是 SOURCE 或 CLASS，我們就要繼承它;因為這兩個生命周期級別的注解等加載到 JVM 后，就會被抹除了。
比如，lombok 就用 AnnotationProcessor 繼承了 AbstractProcessor，以實現編譯期的處理。這也是為什么我們使用 @Data 就能實現 get、set 方法的原因。
2.2.3 @Documented
執行 javadoc 的時候，標記這些注解是否包含在生成的用戶文檔中。
2.2.4 @Inherited
標記這個注解具有繼承性，比如 A 類被注解 @Table 標記，而 @Table 注解被 @Inherited 聲明(具備繼承性);繼承于 A 的子類，也繼承 @Table 注解。
- //聲明 Table 注解，有繼承性
- @Inherited
- @Target(ElementType.TYPE)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface Table {
- }
03 自定義注解
好啦，說了這么多理論。大家也聽累了，我也聊累了。那怎么自定義一個注解并讓它起作用呢?下面我將帶著你們看看我司的防止重復提交的注解是怎么實現的?當然，由于設計內部的東西，我只會寫寫偽代碼。思路在前面介紹過了，為方便閱讀我拿下來，大家理解就行。
需求是：同一用戶，三秒內重復提交一樣的參數，就會報異常阻止重復提交，否則正常提交處理寫請求。
3.1 定義注解
首先，定義注解必須是 @interface 修飾;其次，有四個考慮的點：
- 注解的生命周期 @Retention，一般都是 RUNTIME 運行時。
- 注解的作用域 @Target，作用于寫請求，也就是 controller 方法上。
- 是否需要元素，用分布式鎖實現，必須要有鎖的過期時間。給定默認值，也支持自定義。
- 是否生成 javadoc @Documented，這個注解無腦加就對了。
基于此，我司的防止重復提交的自定義注解就出來了：
- @Documented
- @Target({ElementType.METHOD})
- @Retention(RetentionPolicy.RUNTIME)
- public @interface BanReSubmitLock {
- /**
- * 鎖定時間，默認單位（秒）默認時間（3秒）
- */
- long lockTime() default 3L;
- }
3.2 AOP 切面處理
- @Aspect
- @Component
- public class BanRepeatSubmitAop {
- @Autowired
- private final RedisUtils redisUtils;
- @Pointcut("@annotation(com.nasus.framework.web.annotation.BanReSubmitLock)")
- private void banReSubmitLockAop() {
- }
- @Around("banReSubmitLockAop()")
- public Object aroundApi(ProceedingJoinPoint point) throws Throwable {
- // 獲取 AOP 切面方法簽名
- MethodSignature signature = (MethodSignature) point.getSignature();
- // 方法
- Method method = signature.getMethod();
- // 獲取目標方法上的 BanRepeatSubmitLock 注解
- BanReSubmitLock banReSubmitLock = method.getAnnotation(BanReSubmitLock.class);
- // 根據用戶信息以及提交參數，創建 Redis 分布式鎖的 key
- String lockKey = createReSumbitLockKey(point, method);
- // 根據 key 獲取分布式鎖對象
- Lock lock = redisUtils.getReSumbitLock(lockKey);
- // 上鎖
- boolean result = lock.tryLock();
- // 上鎖失敗，拋異常
- if (!result) {
- throw new Exception("請不要重復請求");
- }
- // 其他處理
- ...
- }
- /**
- * 生成 key
- */
- private String createReSumbitLockKey(ProceedingJoinPoint point, Method method) {
- // 拼接用戶信息 & 請求參數
- ...
- // MD5 處理
- ...
- // 返回
- }
- }
可以看到這里利用了 AOP 切面的方式獲取被 @NoReSubmitLock 修飾的方法，并借此拿到切點(被注解修飾方法)的參數、用戶信息等等，通過 MD5 處理，最終嘗試上鎖。
3.3 使用
- public class TestController {
- // NoReSubmitLock 注解修飾 save 方法，防止重復提交
- @NoReSubmitLock
- public boolean save(Object o){
- // 保存邏輯
- }
- }
使用也非常簡單，只需要一個注解就可以完成大部分的邏輯;如果不用注解，每個寫接口的方法都要寫一遍防止重復提交的邏輯的話，代碼非常繁瑣，難以維護。通過這個例子相信你也看到了，注解的作用。
04 總結
本文介紹了注解的作用主要是標記、檢查以及解耦;介紹了注解的語法;介紹了注解的元素以及傳值方式;介紹了 Java 的內置注解和元注解，最后通過我司的一個實際例子，介紹了注解是如何起作用的?
注解是代碼的特殊標記，可以在程序編譯、類加載、運行時被讀取并做相關處理。其對應 RetentionPolicy 中的三個枚舉，其中 SOURCE、CLASS 需要繼承 AbstractProcessor (注解抽象處理器)，并實現 process () 方法來處理我們自定義的注解。而 RUNTIME 級別是我們常用的級別，結合 Java 的反射機制，可以在很多場景優化代碼。
05 參考鏈接
bilibili.com/video/BV1p4411P7V3
mp.weixin.qq.com/s/BPKvLbdCyuWijkD-si75Dw
blog.csdn.net/javazejian/article/details/71860633
