注解在平時開發(fā)中隨處可見,不了解注解原理會覺得這是一個很神奇的東西,作為一個合格的碼農,對一些常用的知識了解其內部原理是很有必要的。
1.注解的定義
注解通過 @interface關鍵字進行定義。
public @interface TheAnnotation {
}
2.注解的應用
可以放在一個類、構造函數、方法、屬性等上
@TheAnnotation
public class Test {
}
3.元注解
元注解是可以注解到注解上的注解,或者說元注解是一種基本注解,但是它能夠應用到其它的注解上面。
元標簽有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。
@Retention
Retention 為保留期的意思。當 @Retention 應用到一個注解上的時候,它解釋說明了這個注解的存活時間。
它的取值如下:
RetentionPolicy.SOURCE 注解只在源碼階段保留,在編譯器進行編譯時它將被丟棄忽視。
RetentionPolicy.CLASS 注解只被保留到編譯進行的時候,它并不會被加載到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序運行的時候,它會被加載進入到 JVM 中,所以在程序運行時可以獲取到它們。
@Retention(RetentionPolicy.RUNTIME)
public @interface TheAnnotation {
}
@Documented
顧名思義,這個元注解肯定是和文檔有關。它的作用是能夠將注解中的元素包含到 Javadoc 中去。
@Target
Target 是目標的意思,@Target 指定了注解運用的地方,就是本文開頭所說那些應用地方。
ElementType.ANNOTATION_TYPE 可以給一個注解進行注解
ElementType.CONSTRUCTOR 可以給構造方法進行注解
ElementType.FIELD 可以給屬性進行注解
ElementType.LOCAL_VARIABLE 可以給局部變量進行注解
ElementType.METHOD 可以給方法進行注解
ElementType.PACKAGE 可以給一個包進行注解
ElementType.PARAMETER 可以給一個方法內的參數進行注解
ElementType.TYPE 可以給一個類型進行注解,比如類、接口、枚舉
下面這個注解只用應用到類、接口或者枚舉上面
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TheAnnotation {}
@Inherited
Inherited 是繼承的意思
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface TheAnnotation {}
@TheAnnotation
public class A {}
public class B extends A {}
注解 TheAnnotation 被 @Inherited 修飾,之后類 A 被 Test 注解,類 B 繼承 A,類 B 也擁有 TheAnnotation 這個注解。
@Repeatable
這個元注解稍微復雜一些,Repeatable 是可重復的意思,@Repeatable 是 Java 1.8 才加進來的。
舉個例子,一個人有多個身份的時候,可以用的這個元注解
@interface Persons {
Person[] value();
}
@Repeatable(Persons.class)
@interface Person{
String position() default "";
}
@Person(position="singer")
@Person(position="coder")
public class Man{
}
上面的 @Person 注解添加了 @Repeatable 元注解,@Repeatable括號里面中的注解相當于一個容器注解,用來放其他注解的,從上面代碼可以看到這個容器注解用來放 @Person 注解的,然后就可以將多個 @Person 注解到Man類上,這個 Man 類就有了多層身份的意思。
4.注解的屬性
上面的 @Person 注解里面的 String position() default "" 就是注解的屬性,默認值是空字符串,也可以不寫默認值。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Person{
int age();
String name();
}
@Person(age=23,name="xiaoming")
public class Man{
}
需要注意的是,在注解中定義屬性時它的類型必須是 8 種基本數據類型外加 類、接口、注解及它們的數組。
如果只有一個屬性的時候,可以簡潔寫法
public @interface Person{
int age();
}
@Person(23)
public class Man() {
}
如果一個屬性都沒有,則連括號都不需要寫。
5.注解提取
前面4大點是注解的基本知識,注解本身并沒有任何實際作用,關鍵作用的將這些注解提取出來,再做實際上的操作。注解的提取關鍵手段就是反射了。
通過反射獲取注解
Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
getAnnotation() 方法來獲取制定的 Annotation 對象。
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
getAnnotations() 方法獲取所有注解
public Annotation[] getAnnotations() {}
@Person(age = 28, name = "xiaoming")
public class AnnotationTestActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_annotation_test);
boolean isHadAnnotation = AnnotationTestActivity.class.isAnnotationPresent(Person.class);
if (isHadAnnotation) {
Person person = AnnotationTestActivity.class.getAnnotation(Person.class);
System.out.println("age:" + person.age());
System.out.println("name:" + person.name());
}
}
}
輸出結果
I/System.out: age:28
I/System.out: name:xiaoming
6.使用場景
注解一般是供編譯器和APT使用的,運行時通過反射提取,這對性能有一定的影響;APT編譯期生成類、文檔等,這對運行性能沒有影響,但是編譯稍微會慢一些,比如大名鼎鼎的Dagger2就是使用APT在編譯期生成大量代碼,完成依賴注入的工作,實現了代碼解耦。另外例如ButterKnife、Eventbus都使用到了注解,多閱讀這些源碼,自己稍加練習,這樣對注解的使用場景及理解就會更加深刻了。