java annotations basics
What are Anotations?
如果用一個單詞來描述Annotation那就是Metadata, Metadata是描述數(shù)據(jù)的數(shù)據(jù),所以Annotation可以理解為code的元數(shù)據(jù)描述。Annotation在JDK5.0版本被引入,大概是如下圖這樣的
@Override
public String toString() {
return "This is String Representation of current object."
}
這里重載了toString()方法,用到了@Override注解。如果去掉了@Override,代碼也能正常運行。那為什么還要用它呢?@Override注解告訴編譯器這是一個重載方法,是關于method的描述。如果父類中沒有這個方法,那么編譯器會報錯,如下:
Error:(8, 5) java: 方法不會覆蓋或實現(xiàn)超類型的方法
重新定義:
Annotation是用來裝飾class、method、field、parameter、variable、constructor和package的一種特殊Java結構體。
How Annotations Work
Java內置的Override注解源碼如下:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
可以看出Override沒有什么東西,又怎么做到檢驗重載方法是否定義在父類中。原因是Annotation只是metadata,不包含任何的業(yè)務邏輯。可以這么來理解,Annotation是class、method、package、field的裝飾信息的生產(chǎn)者,對應的還有一個信息的消費者。那這里的@Override的問題就好理解了,Override是信息的提供者,JVM是信息的消費者,在二進制層面來檢測重載方法的是否存在于父類中。
How to Write Custom Annotations
JDK提供了4中內置的元注解,作用是注解其他的注解,分別是
@Documented - Whether to put the annotation in Javadocs
@Retention - When the annotation is needed
@Target? - Places the annotation can go
@Inherited - Whether subclasses get the annotation
@Retention - Annotation被保留的時間長短,標注注解的生命周期。3種RetentionPolicy的取值說明如下
RetentionPolicy.SOURCE - 在編譯期間就被拋棄。這類注解在編譯完成后就沒有任何意義了,不會被寫到字節(jié)碼里。比如@Override、@SuppressWarnings
RetentionPolicy.CLASS - 在class加載時被拋棄。適合在編譯成字節(jié)碼后做一些處理,而且是Retention的默認值。
RetentionPolicy.RUNTIME - 不拋棄。這類注解適用于運行時反射
@Target - 注解放置的位置
如果不指定@Target的話,可以放到任何地方,一般的使用如下
ElementType.TYPE (class, interface, enum)
ElementType.FIELD (instance variable)
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE (on another annotation)
ElementType.PACKAGE (remember package-info.java)
@Inherited – 控制是否影響子類
注解的內容(屬性)僅支持String和enum類型,所有屬性被定義成方法,還可以提供默認值
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Todo {
public enum Priority {LOW, MEDIUM, HIGH}
public enum Status {STARTED, NOT_STARTED}
String author() default "Yash";
Priority priority() default Priority.LOW;
Status status() default Status.NOT_STARTED;
}
那么@Todo注解的使用方式是怎么呢,如下
@Todo(priority = Todo.Priority.MEDIUM, author = "Yashwant", status = Todo.Status.STARTED)
public void incompleteMethod1() {
//Some business logic is written
//But it’s not complete yet
}
如果Annotation里面僅有一個屬性,可以命名為"value",如下
@interface Author{
String value();
}
@Author("Yashwant")
public void someMethod() {
}
How to use custom Annotations
1, 反射
反射會提供Class、Method和Field對象,這些對象都有共同的方法getAnnotation(),強轉成自定義的Annotation后就可以使用在Annotation內部定義的屬性,如下
Class businessLogicClass = BusinessLogic.class;
for(Method method : businessLogicClass.getMethods()) {
Todo todoAnnotation = (Todo)method.getAnnotation(Todo.class);
if(todoAnnotation != null) {
System.out.println(" Method Name : " + method.getName());
System.out.println(" Author : " + todoAnnotation.author());
System.out.println(" Priority : " + todoAnnotation.priority());
System.out.println(" Status : " + todoAnnotation.status());
}
}
## 2,Android里的@StringDef@IntDef代替Enum
[點這查看](http://tools.android.com/tech-docs/support-annotations)