Java 注解

Euphoria 發(fā)布于2019-08-16 11:01 / 716人閱讀

摘要：注解對于代碼的運行效果沒有直接影響。主要作用提供信息給編譯器編譯器可以利用注解來探測錯誤和警告信息編譯階段時的處理軟件工具可以用來利用注解信息來生成代碼文檔或者做其它相應(yīng)處理。注解超類的子類那么，也擁有注解。

簡介

注解是一系列元數(shù)據(jù)，它提供數(shù)據(jù)用來解釋程序代碼，但是注解并非是所解釋代碼本身的一部分。注解對于代碼的運行效果沒有直接影響。

主要作用

提供信息給編譯器：編譯器可以利用注解來探測錯誤和警告信息

編譯階段時的處理：軟件工具可以用來利用注解信息來生成代碼、Html文檔或者做其它相應(yīng)處理。

運行時的處理：某些注解可以在程序運行的時候接受代碼的提取

定義

注解和類、接口等是一個層次的東西，它的聲明是用@interface標識的，跟接口很像，如下所示：

public @interface Zeling {
}

元注解-注解的注解 @Documented

使用這個注解，可以讓注解中的元素包含到j(luò)avadoc或者類似的工具上去。

// Indicates that annotations with a type are to be documented by javadoc and similar tools by default.

@Target

限定運用場景，可以同時限定多個，比如說新定義一個注解，限定在類型和方法注解。

// Indicates the contexts in which an annotation type is applicable.

主要有以下幾種：

    // 限定給類型注解，比如說類、接口、枚舉等
    TYPE,

    // 限定給屬性注解
    FIELD,

    // 限定給方法注解
    METHOD,

    // 限定給參數(shù)注解
    PARAMETER,

    // 限定給構(gòu)造函數(shù)注解
    CONSTRUCTOR,

    // 限定給局部變量注解
    LOCAL_VARIABLE,

    // 限定在注解上注解
    ANNOTATION_TYPE,

    // 限定在包上使用注解
    PACKAGE

@Retention

保留期，即注解可以在什么時間段上起作用。

SOURCE 源代碼階段起作用

CLASS 到編譯階段還能起作用

RUNTIME 到運行期還能起作用

@Inherited

繼承注解：當一個超類使用了這個注解，然后他的子類如果沒有使用注解的話，那么子類可以繼承超類的注解。

// 注解A
public @interface A {}

// 超類B
@A
public class B {}

// B的子類C
public class C extends B {}

那么，C也擁有注解A。

@Repeatable

可重復(fù)的，當一個注解A使用了這個可重復(fù)的注解，那么注解A可以多次注解在同一個地方。

public @interface Colors {
    Color[] value();
}

@Repeatable(Colors.class)
public @interface Color {
    String color() default "black";
}

@Color("purple")
@Color("brown")
@Color("red")
public class Pen {}

上面這個代碼塊就是這個注解的習(xí)慣用法，自己理解哈。

注解的屬性

注解只有屬性，沒有方法。注解的屬性定義跟無形參的方法很像。

public @interface A {
    // String 是屬性的返回值，msg是屬性的名稱，可以用default后面跟著默認的值
    String msg() default "msg";
}

使用方式

@A(msg = "zeling")
public class B {}

如果注解屬性中，只有一個屬性，并且屬性的名稱為value那么可以直接在注解后面直接填值，不用寫出屬性名，如：

@C(value = "msg")
//等價于
@C("msg")

注解的運用

Class中有三個為注解提供的方法：

// 判斷是否使用了注解
public boolean isAnnotationPresent(Class annotationClass) {}
// 獲取某個注解
public  A getAnnotation(Class annotationClass) {}
// 獲取所有注解
public Annotation[] getAnnotations() {}

例子：

@Zeling(msg = "zeling")
public class App {
    /**
     * @description TODO
     * @date 2018年1月31日 下午11:06:13
     * @param args
     */
    public static void main(String[] args) throws Exception {
        boolean flag = App.class.isAnnotationPresent(Zeling.class);
        if (flag) {
            Zeling zeling = App.class.getAnnotation(Zeling.class);
            System.out.println("annotation: " + zeling.msg());
        }
        
    }
}

結(jié)果：