?原文地址如下:摸我
?我希望以此篇博文作為基于注解處理器生成代碼系列博文的開篇,給大家展示注解處理器有多么強大,并在最后使用這項技術來在編譯時刻生成android代碼
?在這個系列博文中,我們會:
- 介紹Java語言中的注解
- 理解注解的基本用法和作用域
- 了解
Annotation Processor
基礎知識和作用 - 學習如何在命令行,
Eclipse
,Maven
中運行Annotation Processors
- 學習如何使用
Annotation Processors
來生成代碼 - 學習如何
Apache Velocity
模版來生成代碼
簡介
?注解首先在第三版Java Language Specification
中被提出,并在java 5
中被實現。
?使用注解我們可以給源代碼添加元數據信息,比如構造或者部署信息,配置屬性,編譯特性或者代碼質量檢查。
?不像Javadocs
,注解是強類型的,每個注解都對應一個預先定義好的注解類型。除此之外,程序可以在運行時獲得注解信息,Javadocs
不行。
注解語法
?注解通常出現在被注解代碼片段之前,單獨成行,并且和代碼片段有相同的縮進。
?注解可以應用到包,類型(類,接口,枚舉,注解類型),變量(對象,局部變量-包括定義在循環結構中的變量),構造函數,方法,和參數。
?注解的最簡單形式是不帶任何元素,比如:
@Override()
public void theMethod() {…}
?在這種情況下,括號可以被省略。
@Override
public void theMethod() {…}
?注解可以包括通過冒號分離的鍵值對數據,類型可以是基礎類型,字符串,枚舉,和數組:
@Author(name = "Albert",
created = "17/09/2010",
revision = 3,
reviewers = {"George", "Fred"})
public class SimpleAnnotationsTest {…}
?當注解只有一個元素并且其名字是value,那么它就可以被省略:
@WorkProduct("WP00000182")
@Complexity(ComplexityLevel.VERY_SIMPLE)
public class SimpleAnnotationsTest {…}
?注解可以定義它的元素的默認值,有默認值的元素可以在注解聲明使用時被省略。
?比如,假設注解Author
定義了revision
(默認為1)和reviewers
(默認為空的字符串數組),下邊的兩個注釋聲明是相同的:
@Author(name = "Albert",
created = "17/09/2010",
revision = 1,
reviewers = {})
public class SimpleAnnotationsTest() {…}
@Author(name = "Albert", // defaults are revision 1
created = "17/09/2010") // and no reviewers
public class SimpleAnnotationsTest() {…}
注解的典型使用
?有三類注解類型在Java Language Specification
中被定義,它們提供給java的編譯器使用:
-
@Deprecated:表明被標記的元素不應該再被使用。當你使用被標記元素時,編譯器會給出警告。也可以使用在
Javadoc
中,解釋標記元素不能在使用的原因。 - @Override:表面被標記元素為重載了超類中的元素
- @SuppressWarnings:讓編譯器忽略標記元素會產生的一些特定警告
?自從注解被引入,很多庫和框架都在其最新版本中添加了注解。通過在代碼中使用注解,這些庫或者框架可以減少或者去除配置文件的使用。
 最有代表性的幾個庫或框架如下:
- Java Enterprise Edition and its main components – Enterprise JavaBeans, Java Persistence API or Web Services API’s.
- Spring Framework – used thoroughly for configuration, dependency injection and inversion of control in the core framework and in other Spring projects.
- Seam, Weld, Guice.
- Apache Struts 2.
注解類型
?注解類型(Annotation Type
)是定義自定義注解的特殊接口(interface
)。
?一個注解類型使用@interface
來定義:
public @interface Author {
String name();
String created();
int revision() default 1;
String[] reviewers() default {};
}
public @interface Complexity {
ComplexityLevel value() default ComplexityLevel.MEDIUM;
}
public enum ComplexityLevel {
VERY_SIMPLE, SIMPLE, MEDIUM, COMPLEX, VERY_COMPLEX;
}
?注解類型和常規的接口有一些不同的地方:
- 只有基礎類型,字符串,枚舉,類常量和上述類型的數組允許在注解定義中使用,一般的類和對象不允許使用,雙重數組也不允許。
- 注解元素的定義語法和類方法的語法相似,但是注意,注解元素的定義不包括修飾符和參數。
- 默認值是使用
default
關鍵字定義的,其后的值必須是字面量,數組初始器和枚舉值。
?枚舉類型可以在注解內部進行定義:
public @interface Complexity {
public enum Level {
VERY_SIMPLE, SIMPLE, MEDIUM, COMPLEX, VERY_COMPLEX;
}
…
用來定義注解的注解
?JDK中預先定義了一些用來修改自定義注解行為的注解:
-
@Retention:表明被標記的注解信息會保存多長時間,一些可能的值如下:
CLASS
(默認選項,注解信息保存到class文件中,但是無法在運行時獲得),SOURCE
(當class文件被創建時被編譯器拋棄) andRUNTIME
(在程序運行時可以獲得). -
@Target:表明注解可以標記元素的類型,可能的值為枚舉類型
ElementType
的值:ANNOTATION_TYPE
,CONSTRUCTOR
,FIELD
,LOCAL_VARIABLE
,METHOD
,PACKAGE
,PARAMETER
andTYPE
.
?下一篇博文為《注解處理器》,稍后會給出。
—
(1) ”The Java Language Specification, Third Edition” is available for free download here.
?Update: new link to relevant JLS section in his new home at Oracle site here.