Annotations 0

java annotations basics

What are Anotations?

如果用一個(gè)單詞來(lái)描述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,代碼也能正常運(yùn)行。那為什么還要用它呢?@Override注解告訴編譯器這是一個(gè)重載方法,是關(guān)于method的描述。如果父類中沒有這個(gè)方法,那么編譯器會(huì)報(bào)錯(cuò),如下:

Error:(8, 5) java: 方法不會(huì)覆蓋或?qū)崿F(xiàn)超類型的方法

重新定義:
Annotation是用來(lái)裝飾class、method、field、parameter、variable、constructor和package的一種特殊Java結(jié)構(gòu)體。

How Annotations Work

Java內(nèi)置的Override注解源碼如下:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

可以看出Override沒有什么東西,又怎么做到檢驗(yàn)重載方法是否定義在父類中。原因是Annotation只是metadata,不包含任何的業(yè)務(wù)邏輯。可以這么來(lái)理解,Annotation是class、method、package、field的裝飾信息的生產(chǎn)者,對(duì)應(yīng)的還有一個(gè)信息的消費(fèi)者。那這里的@Override的問題就好理解了,Override是信息的提供者,JVM是信息的消費(fèi)者,在二進(jìn)制層面來(lái)檢測(cè)重載方法的是否存在于父類中。

How to Write Custom Annotations

JDK提供了4中內(nèi)置的元注解,作用是注解其他的注解,分別是

@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被保留的時(shí)間長(zhǎng)短,標(biāo)注注解的生命周期。3種RetentionPolicy的取值說(shuō)明如下

RetentionPolicy.SOURCE - 在編譯期間就被拋棄。這類注解在編譯完成后就沒有任何意義了,不會(huì)被寫到字節(jié)碼里。比如@Override、@SuppressWarnings

RetentionPolicy.CLASS - 在class加載時(shí)被拋棄。適合在編譯成字節(jié)碼后做一些處理,而且是Retention的默認(rèn)值。

RetentionPolicy.RUNTIME - 不拋棄。這類注解適用于運(yùn)行時(shí)反射

@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 – 控制是否影響子類

注解的內(nèi)容(屬性)僅支持String和enum類型,所有屬性被定義成方法,還可以提供默認(rèn)值

@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里面僅有一個(gè)屬性,可以命名為"value",如下

@interface Author{
String value();
}
@Author("Yashwant")
public void someMethod() {
}

How to use custom Annotations

1, 反射

反射會(huì)提供Class、Method和Field對(duì)象,這些對(duì)象都有共同的方法getAnnotation(),強(qiáng)轉(zhuǎn)成自定義的Annotation后就可以使用在Annotation內(nèi)部定義的屬性,如下

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
[點(diǎn)這查看](http://tools.android.com/tech-docs/support-annotations)
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一種元程序中的元素關(guān)聯(lián)任何信息和...
    九尾喵的薛定諤閱讀 3,216評(píng)論 0 2
  • 本文章涉及代碼已放到github上annotation-study 1.Annotation為何而來(lái) What:A...
    zlcook閱讀 29,263評(píng)論 15 116
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,886評(píng)論 18 139
  • Java 8自Java 5(發(fā)行于2004)以來(lái)最具革命性的版本。Java 8 為Java語(yǔ)言、編譯器、類庫(kù)、開發(fā)...
    誰(shuí)在烽煙彼岸閱讀 907評(píng)論 0 4
  • 不同服務(wù)器上的不同數(shù)據(jù)庫(kù)表結(jié)構(gòu),字段互相拷貝 1.不同服務(wù)器上,同一類數(shù)據(jù)庫(kù),postgresql數(shù)據(jù)庫(kù)之間互相拷...
    鄧凱獻(xiàn)閱讀 4,814評(píng)論 0 1