Android 注解Annotation

相關(guān)文章：

Android AOP注解Annotation詳解（一）
Android AOP之注解處理解釋器詳解（二）
Android AOP 注解詳解及簡單使用實(shí)例（三）

Android AOP 等在Android上應(yīng)用越來越廣泛，例如框架ButterKnife，Dagger2，EventBus3等等，這里我自己總結(jié)了一個學(xué)習(xí)路程。

- Java的注解Annotation
- 注解處理解析器APT(Annotation Processing Tool)
- Android上的注解
- 。。。。

一、啥是注解

從JDK5開始，Java增加了Annotation(注解)，Annotation是代碼里的特殊標(biāo)記，這些標(biāo)記可以在編譯、類加載、運(yùn)行時被讀取，并執(zhí)行相應(yīng)的處理。通過使用Annotation，開發(fā)人員可以在不改變原有邏輯的情況下，在源文件中嵌入一些補(bǔ)充的信息。代碼分析工具、開發(fā)工具和部署工具可以通過這些補(bǔ)充信息進(jìn)行驗(yàn)證、處理或者進(jìn)行部署。

Annotation提供了一種為程序元素（包、類、構(gòu)造器、方法、成員變量、參數(shù)、局域變量）設(shè)置元數(shù)據(jù)的方法。Annotation不能運(yùn)行，它只有成員變量，沒有方法。Annotation跟public、final等修飾符的地位一樣，都是程序元素的一部分，Annotation不能作為一個程序元素使用。

annotation并不直接影響代碼語義，但是它能夠被看作類似程序的工具或者類庫，它會反過來對正在運(yùn)行的程序語義有所影響。

• Annotations可以為編譯器提供而外信息，以便于檢測錯誤，抑制警告等.
• 軟件工具可以通過處理Annotation信息來生成原代碼，xml文件等等.
• 有一些annotation甚至可以在程序運(yùn)行時被檢測，使用.

總結(jié)一句話：注解是一種元數(shù)據(jù)，起到了”描述，配置”的作用。

二、自定義Annotation

2.1 定義注解

定義新的Annotation類型使用@interface關(guān)鍵字（在原有interface關(guān)鍵字前增加@符號）。定義一個新的Annotation類型與定義一個接口很像，例如：

public @interface Test{

}

2.2 使用注解

定義完該Annotation后，就可以在程序中使用該Annotation。使用Annotation，非常類似于public、final這樣的修飾符，通常，會把Annotation另放一行，并且放在所有修飾符之前。例如：

@Test
public class MyClass{
....
}

三、Annotation的一些概念

3.1 定義屬性

Annotation只有成員變量，沒有方法。Annotation的成員變量在Annotation定義中以“無形參的方法”形式來聲明，其方法名定義了該成員變量的名字，其返回值定義了該成員變量的類型。下面示例中定義了2個成員變量，這2個成員變量以方法的形式來定義：

public @interface MyTag{
 string name();
 int age();
}

一旦在Annotation里定義了成員變量后，使用該Annotation時就應(yīng)該為該Annotation的成員變量指定值(如果有默認(rèn)值可以不用指定) 。例如：

public class Test{
 @MyTag(age=30,name="天平")
 public void info(){

 }
}

參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型 , 以及這一些類型的數(shù)組。

3.2 分類

根據(jù)Annotation是否包含成員變量，可以把Annotation分為如下兩類：

- 標(biāo)記注解Annotation：沒有成員變量的Annotation被稱為標(biāo)記。這種Annotation僅用自身的存在與否來為我們提供信息，例如@override等。

- 元數(shù)據(jù)Annotation：包含成員變量的Annotation。因?yàn)樗鼈兛梢越邮芨嗟脑獢?shù)據(jù)，因此被稱為元數(shù)據(jù)Annotation。

3.3 默認(rèn)值

注解元素必須有確定的值，要么在定義注解的默認(rèn)值中指定，要么在使用注解時指定，非基本類型的注解元素的值不可為null。因此, 使用空字符串或0作為默認(rèn)值是一種常用的做法。栗子:

定義注解

public @interface MyTag {
 public int id() default -1; 
 public String name() default "";//使用default可以設(shè)置默認(rèn)值
 public itn age();
}

使用注解

public class Test{
 @MyTag(age=30)
 public void info(){
 //age沒有指定默認(rèn)值，所以這里必須要設(shè)置age
 }
}

四、元注解meta-annotation

注解的注解，不是上述的”元數(shù)據(jù)Annotation”。

元注解的作用就是負(fù)責(zé)注解其他注解，它們被用來提供對其它annotation類型作說明。JDK提供了如下4個元注解:

- @Retention
- @Target
- @Documented
- @Inherited

4.1 @Retention

保留的意思，用于指定Annotation可以保留多長時間。

@Retention包含一個名為“value”的成員變量，該value成員變量是RetentionPolicy枚舉類型。使用@Retention時，必須為其value指定值。value成員變量的值只能是如下3個：

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

1. RetentionPolicy.SOURCE: Annotation只保留在源代碼中，編譯器編譯時，直接丟棄這種Annotation。在源文件中有效。
2. RetentionPolicy.CLASS: 編譯器把Annotation記錄在class文件中。當(dāng)運(yùn)行Java程序時，JVM中不再保留該Annotation。在class中有效。
3. RetentionPolicy.RUNTIME: 編譯器把Annotation記錄在class文件中。當(dāng)運(yùn)行Java程序時，JVM會保留該Annotation，程序可以通過反射獲取該Annotation的信息。在運(yùn)行時有效。
   

例子：

定義注解

//name=value形式
//@Retention(value=RetentionPolicy.RUNTIME)
//直接指定
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
 String value();
}

使用

@MyTag("天平")
public class RMain {

}

ps: 如果Annotation里有一個名為“value“的成員變量，使用該Annotation時，可以直接使用XXX(val)形式為value成員變量賦值，無須使用name=val形式，看上面的例子。

4.2 @Target

目標(biāo)，指定Annotation用于修飾哪些程序元素。@Target也包含一個名為”value“的成員變量，該value成員變量類型為ElementType[]，ElementType為枚舉類型，值有如下幾個：

作用: 規(guī)定Annotation所修飾的對象范圍。

1. ElementType.TYPE：能修飾類、接口(包括注解類型)或枚舉類型
2. ElementType.FIELD：能修飾成員變量、對象、屬性(包括enum實(shí)例)
3. ElementType.METHOD：能修飾方法
4. ElementType.PARAMETER：能修飾參數(shù)
5. ElementType.CONSTRUCTOR：能修飾構(gòu)造器
6. ElementType.LOCAL_VARIABLE：能修飾局部變量
7. ElementType.ANNOTATION_TYPE：能修飾注解
8. ElementType.PACKAGE：能修飾包

4.2.1 栗子1

注解定義

//FIELD 只能修飾成員變量
@Target(ElementType.FIELD)
public @interface TargetTest {
 String name() default "天平";
}

使用

public class TMain {

 @TargetTest
 String test;

}

4.2.2 栗子2

注解定義

//FIELD,METHOD 同時修飾成員變量和方法
@Target({ElementType.FIELD,ElementType.METHOD})
public @interface TargetTest {
 String name() default "sunchp";
}

使用

public class TMain {

 @TargetTest
 String test;

 @TargetTest
 public void testMethod(){

 }
}

4.3 @Documented

如果定義注解A時，使用了@Documented修飾定義，則在用javadoc命令生成API文檔后，所有使用注解A修飾的程序元素，將會包含注解A的說明。Documented是一個標(biāo)記注解，沒有成員。栗子：

定義注解

@Documented
public @interface DTest {

}

使用注解

@DTest
public class DMain {
 //使用javadoc生成api文檔之后，這個類就會包含注解DTest的說明。
}

4.4 @Inherited

繼承，是一個標(biāo)記注解，闡述了某個被標(biāo)注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用于一個class，則這個annotation將會被用于該class的子類。栗子:

定義注解:

@Inherited
public @interface ITest {

}

一個父類使用注解:

@ITest
public class IMain {

}

一個子類繼承父類:

public class IMainChild extends IMain {
 //這時候這個類也有IMain的注解屬性
}

五、基本Annotation

JDK默認(rèn)提供了如下幾個基本Annotation：

- @Override
- @SuppressWarning
- @Deprecated
- @SafeVarargs

5.1 @Override

限定重寫父類方法。對于子類中被@Override修飾的方法，如果存在對應(yīng)的被重寫的父類方法，則正確；如果不存在，則報錯。@Override 只能作用于方法，不能作用于其他程序元素。

父類:

public class Father{


 public void test(){

 }

}

子類:

public class Child{

 //加上這個注解表示重寫父類的方法
 @Override
 public void test(){

 }

}

5.2 @SuppressWarning

抑制編譯器警告。指示被@SuppressWarning修飾的程序元素（以及該程序元素中的所有子元素，例如類以及該類中的方法…..）取消顯示指定的編譯器警告。例如，常見的@SuppressWarning(“unchecked”)

5.3 @Deprecated

用于表示某個程序元素（類、方法等）已過時。如果使用 被@Deprecated修飾的類或方法等，編譯器顯示為紅色，表示這個方法已經(jīng)被棄用。

例子:

public class Main{

 @Deprecated
 public void test(){

 }

 public static void main(String[] args){

 Main main = new Main();
 main.test(); //這時候編輯器就會報紅色，提示過時
 }

}

5.4 @SafeVarargs

安全參數(shù)，@SafeVarargs注解只能用在參數(shù)長度可變的方法或構(gòu)造方法上，且方法必須聲明為static或final，否則會出現(xiàn)編譯錯誤。是JDK7專門為抑制“堆污染”警告提供的。例如：

如果我傳遞一個List給下面的方法，編譯器就會報警告

public static <T> T useVarargs(T... args) { 
 return args.length > 0 ? args[0] : null; 
} 

當(dāng)然使用@SuppressWarnings(“unchecked”)可以不顯示警告，但是這樣子是不好的。這時候用@SageVarargs,如果開發(fā)人員確信某個使用了可變長度參數(shù)的方法，在與泛型類一起使用時不會出現(xiàn)類型安全問題，就可以用這個注解進(jìn)行聲明。在使用了這個注解之后，編譯器遇到類似的情況，就不會再給出相關(guān)的警告信息:

@SafeVarargs 
public static <T> T useVarargs(T... args) { 
 return args.length > 0 ? args[0] : null; 
} 

六、Annotation的本質(zhì)

注解在編譯之后，會生成一個class文件。例如4.2.1的TargetTest，使用下面的命令生成生成的class字節(jié)碼

javap -verbose -c Target.class > test.txt

生成的字節(jié)碼內(nèi)容為:

Classfile /C:/Users/Litp/Desktop/TargetTest.class
 Last modified 2017-2-18; size 397 bytes
 MD5 checksum 99ffe85662789e888a8e913b96961233
 Compiled from "TargetTest.java"
public interface com.tpnet.annotationtest.target.TargetTest extends java.lang.annotation.Annotation
 SourceFile: "TargetTest.java"
 RuntimeVisibleAnnotations:
 0: #11(#12=[e#13.#14,e#13.#15])
 minor version: 0
 major version: 51
 flags: ACC_PUBLIC, ACC_INTERFACE, ACC_ABSTRACT, ACC_ANNOTATION
Constant pool:
 #1 = Class  #16  // com/tpnet/annotationtest/target/TargetTest
 #2 = Class  #17  // java/lang/Object
 #3 = Class  #18  // java/lang/annotation/Annotation
 #4 = Utf8  name
 #5 = Utf8  ()Ljava/lang/String;
 #6 = Utf8  AnnotationDefault
 #7 = Utf8  sunchp
 #8 = Utf8  SourceFile
 #9 = Utf8  TargetTest.java
 #10 = Utf8  RuntimeVisibleAnnotations
 #11 = Utf8  Ljava/lang/annotation/Target;
 #12 = Utf8  value
 #13 = Utf8  Ljava/lang/annotation/ElementType;
 #14 = Utf8  FIELD
 #15 = Utf8  METHOD
 #16 = Utf8  com/tpnet/annotationtest/target/TargetTest
 #17 = Utf8  java/lang/Object
 #18 = Utf8  java/lang/annotation/Annotation
{
 public abstract java.lang.String name();
 descriptor: ()Ljava/lang/String;
 flags: ACC_PUBLIC, ACC_ABSTRACT
 AnnotationDefault:
 default_value: s#7}

可以看出:

- 注解是被編譯成了接口，繼承java.lang.annotation.Annotation
- 注解里面的成員變量編譯成了同名的構(gòu)造方法，AnnotationDefault定義默認(rèn)值
- 注解的注解 利用了一個RuntimeVisibleAnnotations標(biāo)識。

感謝閱讀，希望能幫助到大家，謝謝大家對本站的支持！

最新評論