《回爐重造》——註解
註解
前言
以前學習到「註解」的時候，沒有好好理解註解是如何工作的，只是知道註解可以實現一些功能，總而言之，就是懵懵懂懂。
不過，即使你不知道什麼是註解，但肯定接觸過註解，比如方法的重寫，在方法上面寫著 @Override，這個東西就是註解。
好了，下面就開始回爐重造！打好基礎！
什麼是註解？
註解（Annotation），Annotation 的意思有「標註、批註、附註」。
註解和泛型一樣，也是從 JDK5 引入的新特性。它是與類、介面處在同一級別的，有它的語法來定義註解的。
註解，人們還有另一個詞來稱呼它，即「後設資料」，所謂後設資料（metadata），就是用來描述資料的資料（data about data）。初看這句話可能會有點懵，不過沒關係，都是這樣過來的，好好細品細品。
品不過來？可以看看這裡：
好了，我們知道「註解==後設資料」，那麼它描述什麼資料呢？問得好，描述的就是我們寫的原始碼！可以描述類、方法、區域性變數、方法引數等資料（這些資料也有另一個叫法，Java Element）。注意上面我說過 Annotation 的意思有 附註 的意思，是吧，所以說這個註解實際上並不是程式本身，只是向編譯器提供相關的程式的附加資訊，也就是說註解並不會影響程式的執行。
為什麼會有註解的出現？
這就扯到歷史的發展了，綜合我所瞭解的，大概就是這樣子：
這裡也扯到了 XML（Extensible Markup Language），如果不熟悉，我這裡就簡單說下，熟悉可以跳過啦！
XML 翻譯過來就是「可延伸的標示語言」，與 HTML 類似。但是 XML 是被設計用來傳輸資料的，並不是顯示資料，具有「自我描述性」。
下面是 Jayson Tatum 寫給 Kobe Bryant 的簡訊，儲存為 XML：
<text-message>
<to>Kobe Bryant</to>
<from>Jayson Tatum</from>
<body>I got you today</body>
</text-message>
上面的簡訊就具有自我描述性。它擁有留言，同時包含了傳送者和接受者的資訊。當然，這僅僅是描述而已，XML 並沒有做任何事情，就是純文字，我們需要寫程式碼，讓程式碼識別這些標籤，賦予意義，這樣程式才能讀懂 XML，知道它描述的是什麼。
目前 XML 有兩個作用，一是可以用 XML 格式來傳輸資料，二是可以作為組態檔。
在註解出現之前，開發者基本是用 XML 來設定某些東西，因為 XML 和程式碼是低耦合的，符合低耦合的需求，但是，隨著從 XML 描述的資料越來越多，設定越來越複雜，人們發現用 XML 描述資料太複雜了，需要一種高耦合的來降低這種複雜的情況，所以才出現註解，用註解來描述資料。
不過，現在也是看情況，並不是說註解代替了 XML，而是有時使用 XML，有時使用註解，各有各的好處，兩者相互結合等，這還需要具體情況具體分析。
為什麼需要學習註解？
- 很顯然，我們現在日常開發，使用到各種開源框架，經常會用到註解，不學習註解，那自然看不懂註解相關的程式碼。
- 看起來比較厲害
JDK 自帶的註解
-
@Override：表示當前方法覆蓋了父類別的方法 -
@Deprecated： 表示該方法由於安全、效能問題等，已經不推薦使用了，即已經過時，方法上有橫線，使用時會有警告。此外，在版本升級時，如果要計劃刪除一些方法，也通常會在前一個版本中，將該方法加上@Deprecated，然後再在後續版本中刪除。 -
@SuppviseWarnings(value="unchecked")： 表示鎮壓警告資訊（讓編譯器忽略特定的編譯警告）一些
value值：unchecked，deprecation（忽略 一些過期的 API 警告）unused（忽略 沒有被使用過的程式碼的警告）fallthrough（ 忽略 switch 中缺失 break 的警告）all（忽略全部）
在 JDK 7 和 8，分別加入了 @SafeVarargs 和 @FunctionalInterface 這兩個註解。這兩個後續再來填坑吧。
@Override有什麼用？不加行不行？
@Override 是我們最早接觸的註解了，不加它行不行？
行！不加也行！只要重寫了方法正確就可以了，要是寫錯了，舉個例子：
public class Pet {
public void eat() {
System.out.println("吃...");
}
}
public class Cat extends Pet{
public void aet() {
System.out.println("吃魚...");
}
}
這裡 Cat 繼承了 Pet，重寫 eat() 方法，但是方法名寫錯了，寫成 aet() 。
Pet pet = new Cat();
pet.eat(); // 父類別參照呼叫子類方法
由於子類重寫的方法寫錯方法名，那麼此時父類別參照呼叫子類方法時，就找不到子類的 eat() 這個方法，然後就只能回去父類別找，這顯然不是我們想要的。
所以加上 @Override 有好處，寫錯方法名會有提示，也就是說，可以確保重寫的方法，的確存在於父類別/介面中，可以有效的避免單詞拼錯等情況。
註解的分類
有兩種分類方式：
- 按照執行機制分類
- 按照來源分類
按照執行機制分類（何時保留，何時不保留，某個時期保留，某個時期不保留，生命週期，Retention）
-
SOURCE——原始碼註解：註解只在原始碼中存在，編譯成.class檔案就不存在了
-
CLASS——編譯時註解：註解在原始碼和
.class檔案中都存在（如：JDK 自帶註解） -
RUNTIME——執行時註解：在執行階段還起作用，甚至會影響執行邏輯的註解（如：Spring中
@Autowired）
按照來源分類
-
元註解：給註解進行註解，也就是來修飾註解的，有4個；這裡的元註解就好比上面說過的後設資料，如果還是不能很好的理解的話，就把它理解成形容詞；
@Target({ElementType.METHOD, ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Inherited@Documented
@Target：用於宣告註解的作用域，可以是ElementType.CONSTRUCTOR可作用於構造方法ElementType.FIELD欄位宣告ElementType.LOCAL_VARIABLE區域性變數宣告ElementType.METHOD方法宣告ElementType.PACKAGE包宣告ElementType.PARAMETER引數宣告ElementType.TYPE類、介面、列舉、註解宣告。
@Retention：用於宣告註解何時保留，也有人們稱為生命週期，可以是RetentionPolicy.SOURCE只在原始碼顯示，編譯時會丟棄RetentionPolicy.CLASS編譯時會記錄到class中，執行時忽略RetentionPolicy.RUNTIME執行時存在，可以通過反射讀取。
@Inherited：允許子類繼承，即宣告該註解會被使用了該註解的類的子類所繼承。@Documented：使用了這個註解，那麼在生成 Javadoc 的時候會包含註解資訊。所以，使用這4個元註解，就是用來修飾我們自定義的註解的，規定我們自定義的註解在哪些地方能用，什麼時候會保留註解資訊等等。
在 JDK 8 新加了一個元註解
@Repeatable，這個也後續再來填坑啦。 -
JDK 自帶的註解
-
常見第三方註解（Spring、MyBatis等等）
-
自定義註解
如何自定義註解
使用 @interface 關鍵字進行註解的自定義，寫出你自己定義的註解~
public @interface 註解名 {
成員變數...以無引數無異常的方式來宣告
可以用defalt關鍵字來指定預設值
}
舉個例子：
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface TextMessage { // 使用 @interface 關鍵字定義註解，註解名為 TextMessage
String to(); // 成員變數以無引數無異常的方式來宣告
String from() default "Jayson Tatum"; // 可以用defalt關鍵字來指定預設值
String body();
}
注意事項：
- 註解只有成員變數，沒有方法，雖然這個變數有小括號，看起來挺像方法的。
- 註解中定義成員變數時它的型別只能是 8 種基本資料型別外加 String 、類、介面、註解、列舉及它們的陣列。
- 若註解只有一個成員變數，則該成員名必須取名為
value()，然後使用註解的時候引數直接寫。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface A {
String value();
}
public class B {
@A("god23bin")
public int var;
}
- 註解可以沒有成員變數，這樣的註解稱為標識註解。
獲取註解資訊
還記得開頭我說過的話嗎？
註解實際上並不是程式本身，只是向編譯器提供相關的程式的附加資訊，也就是說註解並不會影響程式的執行。
是的，註解這樣子，根本不能幫我們做什麼事情，頂多是給我們人看的，我們知道它描述什麼，此時它就和註釋的功能很像了，但是！我們知道，註解不僅僅是給我們人看的，也是給機器看的啊，那麼機器是如何看的呢？這就涉及到反射了，需要同個反射去獲取註解的資訊，進而進行下一步的操作，實現我們想要的功能！
舉個例子：
我這裡自定義了一個註解 B，作用域為類、介面、列舉、註解、方法、欄位（成員變數）。
註解的保留時期（Retention）是執行時（RetentionPolicy.RUNTIME），這是必須的，畢竟反射是執行時動態獲取的，不選這個，就不能使用反射獲取註解資訊了。
該註解有兩個成員變數，或者說兩個屬性，即 id 和 text，id 預設 -1。
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface B {
int id() default "-1";
String text();
}
現在，我們把這個註解宣告到 Test 類上：
@B()
public class Test {
}
那如何使用反射獲取呢？我們可以通過反射中的 Class 物件 的 isAnnotationPresent() 方法判斷該類是否使用了某個註解。
/**
* {@inheritDoc}
* @throws NullPointerException {@inheritDoc}
* @since 1.5
*/
@Override
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {
return GenericDeclaration.super.isAnnotationPresent(annotationClass);
}
然後通過它的 getAnnotation() 方法來獲取 Annotation 物件。
/**
* @throws NullPointerException {@inheritDoc}
* @since 1.5
*/
@SuppressWarnings("unchecked")
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {
Objects.requireNonNull(annotationClass);
return (A) annotationData().annotations.get(annotationClass);
}
或者是 getAnnotations() 方法來獲取 Annotation 陣列物件。
/**
* @since 1.5
*/
public Annotation[] getAnnotations() {
return AnnotationParser.toArray(annotationData().annotations);
}
所以，我們可以這樣獲取註解資訊：
@B("god23bin")
public class Test {
public static void main(String[] args) {
boolean isB = Test.class.isAnnotationPresent(B.class);
if (isB) {
B b = Test.class.getAnnotation(B.class);
System.out.println("id:" + b.id());
System.out.println("text:" + b.text());
}
}
}
輸出結果：
id:-1
text:god23bin
同理，位於介面、屬性（欄位）、方法上的註解，同樣可以通過反射獲取。
@B(text="I got you today")
public class Test {
@B(id=1, text="hello")
public int var;
@B(text="world")
public void empty() {
}
public static void main(String[] args) throws NoSuchFieldException, NoSuchMethodException {
boolean isB = Test.class.isAnnotationPresent(B.class);
if (isB) {
// 獲取類上的註解
B b1 = Test.class.getAnnotation(B.class);
System.out.println("1-id:" + b1.id());
System.out.println("1-text:" + b1.text());
}
Field field = Test.class.getDeclaredField("var");
field.setAccessible(true);
// 獲取欄位上的註解
B b2 = field.getAnnotation(B.class);
if (b2 != null) {
System.out.println("2-id:" + b2.id());
System.out.println("2-text:" + b2.text());
}
// 獲取方法上的註解
Method method = Test.class.getDeclaredMethod("empty");
B b3 = method.getAnnotation(B.class);
if (b3 != null) {
System.out.println("3-id:" + b3.id());
System.out.println("3-text:" + b3.text());
}
}
}
輸出結果：
1-id:-1
1-text:I got you today
2-id:1
2-text:hello
3-id:-1
3-text:world
好了，到這裡，上面已經知道我們可以通過反射獲取註解資訊，但是目前僅僅只是獲取資訊而已，如何實現其他功能呢？這個問題問的好，後續再來填坑吧，不過還是一樣，離不開反射。
以上就是註解的基本內容了。
最後的最後
由本人水平所限，難免有錯誤以及不足之處， 螢幕前的靚仔靚女們 如有發現，懇請指出！
最後，謝謝你看到這裡，謝謝你認真對待我的努力，希望這篇部落格對你有所幫助！
你輕輕地點了個贊，那將在我的心裡世界增添一顆明亮而耀眼的星！