文章開頭先引入一處圖片。

Annotation 中文譯過來就是註解、標釋的意思，在 Java 中註解是一個很重要的知識點，但常常還是有點讓新手不容易理解。

我個人認為，比較糟糕的技術文件主要特徵之一就是：用專業名詞來介紹專業名詞。

例如：

Java 註解用於為 Java 程式碼提供元資料。作為元數據，註解不直接影響你的程式碼執行，但也有一些類型的註解實際上可以用於這個目的。 Java 註解是從 Java5 開始加入到 Java 的。

這是大多數網站上對於 Java 註解，解釋確實正確，但是說實在話，我第一次學習的時候，頭腦一片空白。這什麼跟什麼啊？聽了像沒有聽一樣。因為概念太過於抽象，所以初學者實在是比較吃力才能夠理解，然後隨著自己開發過程中不斷地強化練習，才會慢慢對它形成正確的認識。

我在寫這篇文章的時候，我就在思考。如何讓自己或讓讀者能夠比較直觀地認識註解這個概念？是要去官方文件上翻譯說明嗎？我馬上否定了這個答案。

後來，我想到了一樣東西————墨水，墨水可以揮發、可以有不同的顏色，用來解釋註解正好。

不過，我繼續發散思維後，想到了一樣東西能夠更好地取代墨水，那就是印章。印章可以沾上不同的墨水或印泥，可以定製印章的文字或圖案，如果願意它也可以被戳到你任何想戳的物體表面。

但是，我再繼續發散思考後，又想到一樣東西能夠更好地取代印章，那就是標籤。標籤是一張便利紙，標籤上的內容可以自由定義。常見的如貨架上的商品價格標籤、圖書館中的書本編碼標籤、實驗室中化學材料的名稱類別標籤等等。

並且，往抽像地說，標籤不一定是一張紙，它可以是對人事物的屬性評價。也就是說，標籤具備對於抽象事物的解釋。

所以，基於如此，我完成了自我的知識認知升級，我決定用標籤來解釋註解。

註解如同標籤

回到博文開始的地方，之前某新聞客戶端的評論有蓋樓的習慣，於是「賈伯斯重新定義了手機、羅永浩重新定義了傻X」 就經常極為工整地出現在了評論樓層中，並且廣大網友在相當長的一段時間內對於這種行為樂此不疲。這其實就是等同於貼標籤的行為。

在某些網友眼中，羅永浩就成了傻X的代名詞。

廣大網友給羅永浩貼了一個名為「傻x」的標籤，他們並不真正了解羅永浩，不知道他當教師、砸冰箱、辦部落格的壯舉，但是因為「傻x」這樣的標籤存在，這有助於他們直接快速地對羅永浩這個人做出評價，然後基於此，羅永浩就可以成為茶餘飯後的談資，這就是標籤的力量。

而在網路的另一邊，老羅靠著他的人格魅力自然收穫一大批忠實的擁泵，他們對於老羅貼的又是另一種標籤。

老羅還是老羅，但由於人們對於它貼上的標籤不同，所以造成對於他的看法大相徑庭，不喜歡他的人整天在網路上評論抨擊嘲諷，而崇拜欣賞他的人則會願意賺錢購買錘子手機的發表會門票。

我無意於評價這兩種行為，我再引個例子。

《奇葩說》是近年網絡上非常火熱的辯論節目，其中辯手陳銘被另外一個辯手馬薇薇攻擊說是————“站在宇宙中心呼喚愛”，然後貼上了一個大大的標籤————“雞湯男”，自此以後，觀眾再看到陳銘的時候，首先映入腦海中便是“雞湯男”三個大字，其實本身而言陳銘非常優秀，為人師表、作風正派、談吐舉止得體，但是在網絡中，因為娛樂至上的環境所致，人們更願意以娛樂的心態來認知一切，於是“雞湯男”就如陳銘自己所說成了一個撕不了的標籤。

我們可以抽象化概括一下，標籤是對事物行為的某些角度的評價與解釋。

到這裡，終於可以引出本文的主角註解了。

初學者可以這樣理解註解：想像程式碼有生命，註解就是對於程式碼中某些鮮活個體的貼上去的一張標籤。簡化來講，註解如同一張標籤。

在未開始學習任何註解具體語法而言，你可以把註解看成一張標籤。這有助於你快速地理解它的大致作用。如果初學者在學習過程有大腦放空的時候，請不要慌張，對自己說：

註解，標籤。註解，標籤。

註解文法

因為平常開發少見，相信有不少的人員會認為註解的地位不高。其實和 classs 和 interface 一樣，註解也屬於一種類型。它是在 Java SE 5.0 版本中開始引入的概念。

註解的定義

註解透過@interface關鍵字進行定義。

public @interface TestAnnotation {}

• 1

• 2

它的形式跟介面很類似，不過前面多了一個@ 符號。上面的程式碼就創造了一個名字為 TestAnnotaion 的註解。

你可以簡單理解為創造了一個名字為 TestAnnotation 的標籤。

註解的應用

上面創造了一個註解，那麼註解的的使用方法是什麼呢。

@TestAnnotationpublic class Test {}

• 1

• 2

• #3

- RetentionPolicy.SOURCE 註解只在原始碼階段保留，在編譯器進行編譯時它將被丟棄忽略。
- RetentionPolicy.CLASS 註解只保留到編譯進行的時候，它並不會載入到 JVM 中。
- RetentionPolicy.RUNTIME 註解可以保留到程式運行的時候，它會被載入進入到 JVM 中，所以在程式執行時可以取得它們。

@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation {}

• 1

• 2

• #3

##在上面的程式碼中，我們指定TestAnnotation 可以在程式運行週期中取得到，因此它的生命週期非常的長。

@Documented

顧名思義，這個元註解肯定是和文檔有關。它的作用是能夠將註解中的元素包含到 Javadoc 中。

@Target

Target 是目標的意思，@Target 指定了註解運用的地方。

你可以這樣理解，當一個註解被 @Target 註解時，這個註解就被限定了運用的場景。

類比到標籤，原本標籤是你想張貼到哪個地方就到哪個地方，但是因為@Target 的存在，它張貼的地方就非常具體了，比如只能張貼到方法上、類上、方法參數上等。 @Target 有下面的取值

ElementType.ANNOTATION_TYPE 可以給一個註解進行註解
ElementType.CONSTRUCTOR 可以給建構方法註解
ElementType.FIELD 可以給予屬性註解
ElementType.LOCAL_VARIABLE 可以給局部變數註解
#ElementType.METHOD 可以給方法註解
ElementType.PACKAGE 可以註解一個套件
ElementType.PACKAGE 可以給一個套件註解
ElementType.PARAMETER 可以給予一個方法內的參數進行註解
ElementType.TYPE 可以給一個型別註解，例如類別、介面、枚舉

@Inherited

說的比較抽象。代碼來解釋。

• @Inherited@Retention(RetentionPolicy.RUNTIME)@interface Test {}@Testpublic class A {}public class B extends A {}

  登入後複製

1
2
#3

• ##4

• 5

• 6

• 7

• 8

• 9

• 10

• ##11

  #

注解 Test 被 @Inherited 修饰，之后类 A 被 Test 注解，类 B 继承 A,类 B 也拥有 Test 这个注解。

可以这样理解：

老子非常有钱，所以人们给他贴了一张标签叫做富豪。

老子的儿子长大后，只要没有和老子断绝父子关系，虽然别人没有给他贴标签，但是他自然也是富豪。

老子的孙子长大了，自然也是富豪。

这就是人们口中戏称的富一代，富二代，富三代。虽然叫法不同，好像好多个标签，但其实事情的本质也就是他们有一张共同的标签，也就是老子身上的那张富豪的标签。

@Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。

什么样的注解会多次应用呢？通常是注解的值可以同时取多个。

举个例子，一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons { Person[] value(); }@Repeatable(Persons.class)@interface Person{ String role default ""; }@Person(role="artist")@Person(role="coder")@Person(role="PM")public class SuperMan{}

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

• 11

• 12

• 13

• 14

• 15

• 16

• 17

• 18

• 19

注意上面的代码，@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

什么是容器注解呢？就是用来存放其它注解的地方。它本身也是一个注解。

我们再看看代码中的相关容器注解。

@interface Persons { Person[] value(); }

• 1

• 2

• 3

按照规定，它里面必须要有一个 value 的属性，属性类型是一个被 @Repeatable 注解过的注解数组，注意它是数组。

如果不好理解的话，可以这样理解。Persons 是一张总的标签，上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上，相当于同时给他贴了程序员、产品经理、画家的标签。

我们可能对于 @Person(role=”PM”) 括号里面的内容感兴趣，它其实就是给 Person 这个注解的 role 属性赋值为 PM ，大家不明白正常，马上就讲到注解的属性这一块。

注解的属性

注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation { int id(); String msg(); }

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。

赋值的方式是在注解的括号内以 value=”” 形式，多个属性之前用 ，隔开。

@TestAnnotation(id=3,msg="hello annotation")public class Test {}

• 1

• 2

• 3

• 4

需要注意的是，在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。

注解中属性可以有默认值，默认值需要用 default 关键值指定。比如：

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation { public int id() default -1; public String msg() default "Hi"; }

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

TestAnnotation 中 id 属性默认值为 -1，msg 属性默认值为 Hi。
它可以这样应用。

@TestAnnotation()public class Test {}

• 1

• 2

因为有默认值，所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了，这一步可以省略。

另外，还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接接属性值填写到括号内。

public @interface Check { String value(); }

• 1

• 2

• 3

上面代码中，Check 这个注解只有 value 这个属性。所以可以这样应用。

@Check("hi")int a;

• 1

• 2

这和下面的效果是一样的

@Check(value="hi")int a;

• 1

• 2

最后，还需要注意的一种情况是一个注解没有任何属性。比如

public @interface Perform {}

• 1

• 2

那么在应用这个注解的时候，括号都可以省略。

@Performpublic void testMethod(){}

• 1

• 2

Java 预置的注解

学习了上面相关的知识，我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。

@Deprecated

这个元素是用来标记过时的元素，想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

public class Hero { @Deprecated public void say(){ System.out.println("Noting has to say!"); } public void speak(){ System.out.println("I have a dream!"); } }

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

• 11

• 12

• 13

• 14

• 15

定义了一个 Hero 类，它有两个方法 say() 和 speak() ，其中 say() 被 @Deprecated 注解。然后我们在 IDE 中分别调用它们。

可以看到，say() 方法上面被一条直线划了一条，这其实就是编译器识别后的提醒效果。

@Override

这个大家应该很熟悉了，提示子类要复写父类中被 @Override 修饰的方法

@SuppressWarnings

阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。

@SuppressWarnings("deprecation")public void test1(){ Hero hero = new Hero(); hero.say(); hero.speak(); }

• 1

• 2

• 3

• 4

• 5

• 6

@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

@SafeVarargs // Not actually safe! static void m(List... stringLists) { Object[] array = stringLists; List tmpList = Arrays.asList(42); array[0] = tmpList; // Semantically invalid, but compiles without warnings String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!}

• 1

• 2

• 3

• 4

• 5

• 6

• 7

上面的代码中，编译阶段不会报错，但是运行时会抛出 ClassCastException 这个异常，所以它虽然告诉开发者要妥善处理，但是开发者自己还是搞砸了。

Java 官方文档说，未来的版本会授权编译器对这种不安全的操作产生错误警告。

@FunctionalInterface

函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。

函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

比如

@FunctionalInterfacepublic interface Runnable { /** * When an object implementing interface Runnable is used * to create a thread, starting the thread causes the object's * run method to be called in that separately executing * thread. * 
 * The general contract of the method run is that it may * take any action whatsoever. * * @see java.lang.Thread#run() */ public abstract void run(); }

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• 10

• 11

• 12

• 13

• 14

• 15

• 16

我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口，上面源码可以看到它就被 @FunctionalInterface 注解。

可能有人会疑惑，函数式接口标记有什么用，这个原因是函数式接口可以很容易转换为 Lambda 表达式。这是另外的主题了，有兴趣的同学请自己搜索相关知识点学习。

注解的提取

博文前面的部分讲了注解的基本语法，现在是时候检测我们所学的内容了。

我通过用标签来比作注解，前面的内容是讲怎么写注解，然后贴到哪个地方去，而现在我们要做的工作就是检阅这些标签内容。 形象的比喻就是你把这些注解标签在合适的时候撕下来，然后检阅上面的内容信息。

要想正确检阅注解，离不开一个手段，那就是反射。

注解与反射。

注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解

public boolean isAnnotationPresent(Class annotationClass) {}

• 1

• 2

然后通过 getAnnotation() 方法来获取 Annotation 对象。

public  A getAnnotation(Class annotationClass) {}

public Annotation[] getAnnotations() {}

@TestAnnotation()public class Test { public static void main(String[] args) { boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class); if ( hasAnnotation ) { TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class); System.out.println("id:"+testAnnotation.id()); System.out.println("msg:"+testAnnotation.msg()); } } }

id:-1msg:

@TestAnnotation(msg="hello")public class Test { @Check(value="hi") int a; @Perform public void testMethod(){} @SuppressWarnings("deprecation") public void test1(){ Hero hero = new Hero(); hero.say(); hero.speak(); } public static void main(String[] args) { boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class); if ( hasAnnotation ) { TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class); //获取类的注解 System.out.println("id:"+testAnnotation.id()); System.out.println("msg:"+testAnnotation.msg()); } try { Field a = Test.class.getDeclaredField("a"); a.setAccessible(true); //获取一个成员变量上的注解 Check check = a.getAnnotation(Check.class); if ( check != null ) { System.out.println("check value:"+check.value()); } Method testMethod = Test.class.getDeclaredMethod("testMethod"); if ( testMethod != null ) { // 获取方法中的注解 Annotation[] ans = testMethod.getAnnotations(); for( int i = 0;i < ans.length;i++) { System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName()); } } } catch (NoSuchFieldException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } catch (SecurityException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } catch (NoSuchMethodException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } } }

id:-1msg:hello check value:himethod testMethod annotation:Perform

package ceshi;import ceshi.Jiecha;public class NoBug { @Jiecha public void suanShu(){ System.out.println("1234567890"); } @Jiecha public void jiafa(){ System.out.println("1+1="+1+1); } @Jiecha public void jiefa(){ System.out.println("1-1="+(1-1)); } @Jiecha public void chengfa(){ System.out.println("3 x 5="+ 3*5); } @Jiecha public void chufa(){ System.out.println("6 / 0="+ 6 / 0); } public void ziwojieshao(){ System.out.println("我写的程序没有 bug!"); } }

package ceshi;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;@Retention(RetentionPolicy.RUNTIME)public @interface Jiecha {}

package ceshi;import java.lang.reflect.InvocationTargetException;import java.lang.reflect.Method;public class TestTool { public static void main(String[] args) { // TODO Auto-generated method stub NoBug testobj = new NoBug(); Class clazz = testobj.getClass(); Method[] method = clazz.getDeclaredMethods(); //用来记录测试产生的 log 信息 StringBuilder log = new StringBuilder(); // 记录异常的次数 int errornum = 0; for ( Method m: method ) { // 只有被 @Jiecha 标注过的方法才进行测试 if ( m.isAnnotationPresent( Jiecha.class )) { try { m.setAccessible(true); m.invoke(testobj, null); } catch (Exception e) { // TODO Auto-generated catch block //e.printStackTrace(); errornum++; log.append(m.getName()); log.append(" "); log.append("has error:"); log.append("\n\r caused by "); //记录测试过程中，发生的异常的名称 log.append(e.getCause().getClass().getSimpleName()); log.append("\n\r"); //记录测试过程中，发生的异常的具体信息 log.append(e.getCause().getMessage()); log.append("\n\r"); } } } log.append(clazz.getSimpleName()); log.append(" has "); log.append(errornum); log.append(" error."); // 生成测试报告 System.out.println(log.toString()); } }

12345678901+1=111-1=03 x 5=15chufa has error: caused by ArithmeticException / by zero NoBug has 1 error.

public class ExampleUnitTest { @Test public void addition_isCorrect() throws Exception { assertEquals(4, 2 + 2); } }

public class MainActivity extends AppCompatActivity { @BindView(R.id.tv_test) TextView mTv; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); ButterKnife.bind(this); } }

public interface GitHubService { @GET("users/{user}/repos") Call> listRepos(@Path("user") String user); } Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/") .build(); GitHubService service = retrofit.create(GitHubService.class);

Java自定义注解

Java註解教學與自訂註解

相關影片：

全面解析Java註解

以上是你想要的Java註解都在這裡了，趕快看看吧的詳細內容。更多資訊請關注PHP中文網其他相關文章！