注解的基本知識(shí)
注解（也被稱為元數(shù)據(jù)）憔辫，為我們?cè)诖a中添加信息提供了一種形式化的方法知举，使得我們可以在稍后某個(gè)時(shí)刻可以非常方便的使用這些數(shù)據(jù)。
為什么要使用注解 醒颖？？
通過使用注解壳炎，我們可以將元數(shù)據(jù)保存在Java源代碼中泞歉，并利用annotation API為自己的注解構(gòu)造處理工具，，同時(shí)腰耙，注解還有使得代碼更加干凈易讀榛丢，以及編譯器類型檢查等優(yōu)點(diǎn)。
Java中內(nèi)置了三種標(biāo)準(zhǔn)注解挺庞，以及四種元注解晰赞。
標(biāo)準(zhǔn)注解
- @Override 表示當(dāng)前的方法將覆蓋父類中的方法。
- @Deprecated 如果程序員使用了此注解选侨，那么編譯器會(huì)發(fā)出警告信息宾肺。被程序作者不推薦使用。
- @SuppressWarnings 關(guān)閉不當(dāng)?shù)木幾g器警告信息侵俗。
元注解 專門負(fù)責(zé)注解其他的注解
- @Target 表示注解可以用于什么地方锨用。可能的
ElementType參數(shù)為：CONSTRUCTOR(構(gòu)造器)隘谣，F(xiàn)IELD(域)增拥，LOACAL_VARIABLE(局部變量),METHOD（方法）,PACKAGE（包）,PARAMETER（參數(shù)）,TYPE（類，接口） - @Retention 表示需要在什么級(jí)別保存該注解信息寻歧。
RetentionPolicy參數(shù)：SOURCE（注解將被編譯器丟棄）掌栅，CLASS（注解在class文件中可以使用，但會(huì)被VM丟棄）码泛，RUNTIME（VM也在運(yùn)行期間也保留注解猾封，因此可以通過反射機(jī)制讀取注解的信息）。 - @Documented 將此注解包含在Javadoc中噪珊。
- @Inherited 允許子類繼承父類中的注解晌缘。
注解的定義
注解可以通過 @interface 關(guān)鍵字進(jìn)行定義。下面我們自定義一個(gè)注解痢站，并詳細(xì)講述如何應(yīng)用注解磷箕。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface CustomAnnation{
String field();
}
上面代碼自定義了一個(gè)CustomAnnation注解，該注解只能用于類或接口（@Target(ElementType.TYPE)）阵难，并且它是一個(gè)編譯時(shí)注解（@Retention(RetentionPolicy.CLASS)）岳枷。此外，它還有一個(gè)String類型的元素呜叫。
那么空繁，如何使用注解呢？假設(shè)類Test需要使用CustomAnnation注解朱庆。
@CustomAnnation(field="test")
public class Test{
}
注解處理器
注解處理器（Annotation Processor）是javac的一個(gè)工具盛泡，它用于在編譯時(shí)掃描和處理注解。一個(gè)注解的注解處理器椎工，以Java代碼（或者編譯過的字節(jié)碼）作為輸入饭于，生成文件（通常是.java文件）作為輸出蜀踏。這具體的含義什么呢？你可以生成Java代碼掰吕！這些生成的Java代碼是在生成的.java文件中果覆，所以你不能修改已經(jīng)存在的Java類，例如向已有的類中添加方法殖熟。這些生成的Java文件局待，會(huì)同其他普通的手動(dòng)編寫的Java源代碼一樣被javac編譯。
自定義一個(gè)注解處理器需要繼承AbstractProcessor類菱属。
public class MyProcessor extends AbstractProcessor {
@Override
public synchronized void init(ProcessingEnvironment env){ }
@Override
public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { }
@Override
public Set<String> getSupportedAnnotationTypes() { }
@Override
public SourceVersion getSupportedSourceVersion() { }
}
- init(ProcessingEnvironment env) 方法：被注解處理工具調(diào)用钳榨，并輸入
ProcessingEnviroment參數(shù)。ProcessingEnviroment提供很多有用的工具類Elements,Types纽门，Messenger和Filer - process方法：所有處理注解的邏輯都是在這里調(diào)用薛耻，包括掃描，評(píng)估和處理注解赏陵。
- getSupportedAnnotationTypes方法：指定注解處理器是注冊(cè)給那一個(gè)注解的饼齿，它是一個(gè)字符串的集合，意味著可以支持多個(gè)類型的注解蝙搔，并且字符串是合法全名缕溉。
- getSupportedSourceVersion方法：指定使用的Java版本。
注冊(cè)注解處理器
在寫完自己的注解處理器后吃型，需要將自定義注解處理器注冊(cè)到j(luò)avac中证鸥，這樣自定義注解處理器才能生效。然而勤晚，如何注冊(cè)呢枉层？只需要將它打包成.jar文件之前，添加配置信息到META-INF/services路徑下运翼。
－－myprcessor.jar
－－－－com
－－－－－－example
－－－－－－－－MyProcessor.class
－－－－META-INF
－－－－－－services
－－－－－－－－javax.annotation.processing.Processor
當(dāng)然返干，也可以直接使用谷歌提供的注冊(cè)處理器庫(kù)兴枯。
implementation 'com.google.auto.service:auto-service:1.0-rc2'
使用方法很簡(jiǎn)單血淌。直接在自定義注解處理器上添加注解即可。
@AutoService(Processor.class)
public class MyProcessor extends AbstractProcessor {
...
}
Elements 和TypeMirrors
在init()中我們獲得如下引用：
-
Elements：一個(gè)用來處理
Element的工具類（后面將做詳細(xì)說明）财剖； -
Types：一個(gè)用來處理
TypeMirror的工具類（后面將做詳細(xì)說明）悠夯； - Filer：正如這個(gè)名字所示，使用Filer你可以創(chuàng)建文件躺坟。
在注解處理過程中沦补，我們掃描所有的Java源文件。源代碼的每一個(gè)部分都是一個(gè)特定類型的Element咪橙。換句話說：Element代表程序的元素夕膀，例如包虚倒、類或者方法。每個(gè)Element代表一個(gè)靜態(tài)的产舞、語言級(jí)別的構(gòu)件魂奥。在下面的例子中，我們通過注釋來說明這個(gè)：
package com.example; // PackageElement
public class Foo { // TypeElement
private int a; // VariableElement
private Foo other; // VariableElement
public Foo () {} // ExecuteableElement
public void setA ( // ExecuteableElement
int newA // VariableElement
) {}
}
