Java基礎—註解（轉載）

時間  2019-11-08
標籤 java 基礎 註解 轉載 欄目 Java 简体版
原文   原文鏈接

概念

註解（Annotation），也叫元數據。一種代碼級別的說明。它是JDK1.5及之後版本引入的一個特性，與類、接口、枚舉是在同一個層次。它能夠聲明在包、類、字段、方法、局部變量、方法參數等的前面，用來對這些元素進行說明，註釋。

註解有許多用處，主要以下： html

  • 提供信息給編譯器： 編譯器能夠利用註解來探測錯誤和警告信息 
  • 編譯階段時的處理： 軟件工具能夠用來利用註解信息來生成代碼、Html文檔或者作其它相應處理。 
  • 運行時的處理： 某些註解能夠在程序運行的時候接受代碼的提取
 

註解語法

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

註解的定義

註解經過 @interface 關鍵字進行定義。程序員

public @interface TestAnnotation {
}

它的形式跟接口很相似，不過前面多了一個 @ 符號。上面的代碼就建立了一個名字爲 TestAnnotaion 的註解。數組

註解的應用

上面建立了一個註解，那麼註解的的使用方法是什麼呢。app

@TestAnnotation
public class Test {
}

建立一個類 Test,而後在類定義的地方加上 @TestAnnotation 就能夠用 TestAnnotation 註解這個類了。框架

不過，要想註解可以正常工做，還須要介紹一下一個新的概念那就是元註解。ide

元註解

元註解是能夠註解到註解上的註解，或者說元註解是一種基本註解，可是它可以應用到其它的註解上面。它們被用來提供對其它 註解類型做說明。工具

元註解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。post

@Retention

Retention 的英文意爲保留期的意思。當 @Retention 應用到一個註解上的時候，它解釋說明了這個註解的的存活時間。測試

它的取值以下： 

  • RetentionPolicy.SOURCE 註解只在源碼階段保留，在編譯器進行編譯時它將被丟棄忽視。 
  • RetentionPolicy.CLASS 註解只被保留到編譯進行的時候，它並不會被加載到 JVM 中。 
  • RetentionPolicy.RUNTIME 註解能夠保留到程序運行的時候，它會被加載進入到 JVM 中，因此在程序運行時能夠獲取到它們。
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代碼中，咱們指定 TestAnnotation 能夠在程序運行週期被獲取到，所以它的生命週期很是的長。

@Documented

顧名思義，這個元註解確定是和文檔有關。它的做用是可以將註解中的元素包含到 Javadoc 中去。

@Target

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

表示該註解能夠用於一個類中的那些屬性及方法上，若是做用域類型有多個用英文逗號分隔。

@Target 有下面的取值：

  • ElementType.ANNOTATION_TYPE 能夠給一個註解進行註解
  • ElementType.CONSTRUCTOR 能夠給構造方法進行註解
  • ElementType.FIELD 能夠給屬性進行註解
  • ElementType.LOCAL_VARIABLE 能夠給局部變量進行註解
  • ElementType.METHOD 能夠給方法進行註解
  • ElementType.PACKAGE 能夠給一個包進行註解
  • ElementType.PARAMETER 能夠給一個方法內的參數進行註解
  • ElementType.TYPE 能夠給一個類型進行註解，好比類、接口、枚舉

@Inherited

Inherited 是繼承的意思，可是它並非說註解自己能夠繼承，而是說若是一個超類被 @Inherited 註解過的註解進行註解的話，那麼若是它的子類就繼承了超類的註解。 
說的比較抽象。代碼來解釋。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}

@Test
public class A {}

public class B extends A {}

註解 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{

}

注意上面的代碼，@Repeatable 註解了 Person。而 @Repeatable 後面括號中的類至關於一個容器註解。

什麼是容器註解呢？就是用來存放其它註解的地方。它自己也是一個註解。

咱們再看看代碼中的相關容器註解。

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

按照規定，它裏面必需要有一個 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();
}

上面代碼定義了 TestAnnotation 這個註解中擁有 id 和 msg 兩個屬性。在使用的時候，咱們應該給它們進行賦值。

賦值的方式是在註解的括號內以 value=」」 形式，多個屬性以前用 ，隔開。

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

須要注意的是，在註解中定義屬性時它的類型必須是 8 種基本數據類型外加 類、接口、註解及它們的數組。

註解中屬性能夠有默認值，默認值須要用 default 關鍵值指定。好比：

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

TestAnnotation 中 id 屬性默認值爲 -1，msg 屬性默認值爲 Hi。 

它能夠這樣應用：

@TestAnnotation()
public class Test {}

由於有默認值，因此無須要再在 @TestAnnotation 後面的括號裏面進行賦值了，這一步能夠省略。

另外，還有一種狀況。若是一個註解內僅僅只有一個名字爲 value 的屬性時，應用這個註解時能夠直接接屬性值填寫到括號內。

public @interface Check {
    String value();
}

上面代碼中，Check 這個註解只有 value 這個屬性。因此能夠這樣應用。

@Check("hi")
int a;

這和下面的效果是同樣的

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

最後，還須要注意的一種狀況是一個註解沒有任何屬性。好比

public @interface Perform {}

那麼在應用這個註解的時候，括號均可以省略。

@Perform
public void testMethod(){}

 

Java常見內置註解

JDK自帶註解

@Override 表示覆蓋或重寫父類的方法；

@Deprecated 表示該方法已通過時了。（當方法或是類上面有@Deprecated註解時，說明該方法或是類都已通過期不能再用，但不影響之前項目使用，提醒你新替代待的方法或是類。若是程序員不當心使用了它的元素,那麼編譯器會發出警告信息。）

@SuppressWarnings 表示忽略指定警告，好比@Suppvisewarnings("Deprecation")

第三方註解

 

註解的提取 

註解與反射

須要注意的是，要想使用反射去讀取註解，必須將Retention的值選爲Runtime。

註解經過反射獲取。首先能夠經過 Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個註解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

而後經過 getAnnotation() 方法來獲取 Annotation 對象。

public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}

前一種方法返回指定類型的註解，後一種方法返回註解到這個元素上的全部註解。

若是獲取到的 Annotation 若是不爲 null，則就能夠調用它們的屬性方法了。好比

@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:-1
msg:

這個正是 TestAnnotation 中 id 和 msg 的默認值。

上面的例子中，只是檢閱出了註解在類上的註解，其實屬性、方法上的註解照樣是能夠的。一樣仍是要用反射。

@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:-1
msg:hello
check value:hi
method testMethod annotation:Perform

 

註解的使用

我要寫一個測試框架，測試程序員的代碼有無明顯的異常。

—— 程序員 A : 我寫了一個類，它的名字叫作 NoBug，由於它全部的方法都沒有錯誤。 
—— 我：自信是好事，不過爲了防止意外，讓我測試一下如何？ 
—— 程序員 A: 怎麼測試？ 
—— 我：把你寫的代碼的方法都加上 @Jiecha 這個註解就行了。 
—— 程序員 A: 好的。

NoBug.java

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!");
    }

}

上面的代碼，有些方法上面運用了 @Jiecha 註解。

這個註解是我寫的測試軟件框架中定義的註解。

package ceshi;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {

}

而後，我再編寫一個測試類 TestTool 就能夠測試 NoBug 相應的方法了。

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());

    }

}

測試的結果是：

1234567890
1+1=11
1-1=0
3 x 5=15
chufa has error:

  caused by ArithmeticException

/ by zero

NoBug has  1 error.

提示 NoBug 類中的 chufa() 這個方法有異常，這個異常名稱叫作 ArithmeticException，緣由是運算過程當中進行了除 0 的操做。

因此，NoBug 這個類有 Bug。

這樣，經過註解我完成了我本身的目的，那就是對別人的代碼進行測試。

 

 

 

參考：

秒懂，Java 註解 （Annotation）你能夠這樣學

框架基礎——全面解析Java註解

深刻理解Java：註解

Java中的註解是如何工做的？

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程