天天看點
傳回

Java注解：你知道怎麼使用嗎？

Java注解的基本概念和文法

Java注解是一種為Java程式元素（類、方法、變量等）添加中繼資料的标記，是Java語言的一項重要特性。注解可以作為配置資訊、編譯檢查、運作時處理等方面的工具，可以友善地擴充和定制Java程式的功能和行為。

注解的定義和使用

Java注解的定義需要使用@interface關鍵字，例如：

public @interface MyAnnotation {
    String value() default "";
}

在上面的代碼中，我們定義了一個名為MyAnnotation的注解，使用了@interface關鍵字，并指定了一個名為value的屬性，其預設值為空字元串。屬性定義需要使用方法的文法，例如上面的代碼中就定義了一個名為value、傳回類型為String的屬性。

可以在Java程式元素的上方使用注解，例如：

@MyAnnotation(value = "my value")
public class MyClass {
    // class body
}

在上面的代碼中，我們使用@MyAnnotation注解标記了MyClass類，并設定了value屬性的值為"my value"。在程式運作時，可以使用反射來擷取注解資訊，例如：

MyAnnotation annotation = MyClass.class.getAnnotation(MyAnnotation.class);
String value = annotation.value(); // "my value"

注解的生命周期和使用範圍

Java注解可以指定其生命周期和使用範圍，以便更好地控制注解的作用範圍和生命周期。可以使用@Retention元注解來指定注解的生命周期，例如：

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "";
}

在上面的代碼中，我們使用@Retention元注解指定了MyAnnotation注解的生命周期為RUNTIME，即在程式運作時仍然保留該注解。

可以使用@Target元注解指定注解的使用範圍，例如：

@Target(ElementType.TYPE)
public @interface MyAnnotation {
    String value() default "";
}

在上面的代碼中，我們使用@Target元注解指定了MyAnnotation注解的使用範圍為TYPE，即隻能用于類、接口和枚舉等類型的定義上。

除了@Retention和@Target之外，還有其他的元注解可以用于指定注解的屬性和行為，例如@Documented用于指定注解是否包含在生成的Java文檔中，@Inherited用于指定注解是否可以被子類繼承等。

Java元注解

Java注解的元注解是指用于修飾自定義注解的注解，它們可以控制自定義注解的行為和使用方式。在本篇部落格中，我們将介紹Java注解的四個元注解：Retention元注解、Target元注解、Documented元注解和Inherited元注解。

  1. Retention元注解

Retention元注解用于指定自定義注解的生命周期，即在什麼時候該注解會失效。Retention元注解有以下三種取值：

  • RetentionPolicy.SOURCE：該注解隻在源代碼中存在，編譯時會被忽略。
  • RetentionPolicy.CLASS：該注解在編譯後的位元組碼檔案中存在，但在運作時會被忽略。
  • RetentionPolicy.RUNTIME：該注解在運作時存在，可以通過反射機制擷取注解資訊。

例如，下面的代碼定義了一個生命周期為RUNTIME的自定義注解：

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    // ...
}
  1. Target元注解

Target元注解用于指定自定義注解的使用範圍，即該注解可以用于哪些程式元素上。Target元注解的取值包括以下常量：

  • ElementType.TYPE：該注解可以用于類、接口和枚舉等類型的定義上。
  • ElementType.FIELD：該注解可以用于字段上。
  • ElementType.METHOD：該注解可以用于方法上。
  • ElementType.PARAMETER：該注解可以用于參數上。
  • ElementType.CONSTRUCTOR：該注解可以用于構造函數上。
  • ElementType.LOCAL_VARIABLE：該注解可以用于局部變量上。
  • ElementType.ANNOTATION_TYPE：該注解可以用于注解上。
  • ElementType.PACKAGE：該注解可以用于包定義上。

例如，下面的代碼定義了一個隻能用于類定義上的自定義注解：

@Target(ElementType.TYPE)
public @interface MyAnnotation {
    // ...
}
  1. Documented元注解

Documented元注解用于指定自定義注解是否會出現在Java文檔中。如果一個注解使用了Documented元注解，那麼在生成該注解所在程式元素的Java文檔時，該注解也會被包含在文檔中。

例如，下面的代碼定義了一個帶有Documented元注解的自定義注解：

@Documented
public @interface MyAnnotation {
    // ...
}
  1. Inherited元注解

Inherited元注解用于指定自定義注解是否可以被子類繼承。如果一個注解使用了Inherited元注解，那麼當一個類繼承了一個被該注解标記的超類時，該注解也會被繼承到子類中。

例如，下面的代碼定義了一個帶有Inherited元注解的自定義注解：

@Inherited
public @interface MyAnnotation {
    // ...
}

以上是Java注解的四個元注解：Retention元注解、Target元注解、Documented元注解和Inherited元注解。這些元注解可以幫助我們更好地控制自定義注解的行為和使用方式，提高Java程式的靈活性和可讀性。

自定義注解

自定義注解是Java語言的一項特性，可以為程式元素（類、方法、字段等）添加中繼資料，用于配置、編譯檢查、運作時處理等方面。在本篇部落格中，我們将介紹自定義注解的屬性和預設值、注解的繼承和重複使用、注解的處理器和反射機制等内容。

注解的屬性和預設值

自定義注解可以定義多個屬性，用于表示該注解的中繼資料。屬性的定義需要使用方法的文法，例如：

public @interface MyAnnotation {
    String value() default "";
    int count() default 1;
}

在上面的代碼中，我們定義了一個名為MyAnnotation的注解，指定了兩個屬性：value和count，并為它們設定了預設值。注解屬性可以是基本資料類型、字元串、枚舉類型、Class類型、注解類型或它們的數組。

注解的繼承和重複使用

自定義注解可以使用@Inherited元注解指定是否可以被繼承。如果一個注解使用了@Inherited元注解，那麼當一個類繼承了一個被該注解标記的超類時，該注解也會被繼承到子類中。

自定義注解還可以使用@Repeatable元注解指定是否可以重複使用。如果一個注解使用了@Repeatable元注解，并指定了一個包含該注解的容器注解，那麼該注解就可以被重複使用了。例如：

@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
    // ...
}

public @interface MyAnnotations {
    MyAnnotation[] value();
}

在上面的代碼中，我們定義了一個名為MyAnnotation的注解，并使用@Repeatable元注解指定了一個名為MyAnnotations的容器注解。這樣，我們在使用注解時就可以直接使用@MyAnnotation或@MyAnnotations，實作注解的重複使用。

注解的處理器

Java注解處理器是一種可以掃描和處理Java源代碼中的注解的工具。在Java編譯器将源代碼編譯成位元組碼之前，注解處理器可以通過反射機制來讀取并操作Java源代碼中的注解。注解處理器可以基于注解的資訊生成額外的代碼、檢查代碼的正确性或生成文檔等。

下面介紹Java注解處理器的使用方法：

  1. 定義注解

首先，需要定義一個或多個注解，并定義注解的屬性。注解的屬性可以是基本類型、字元串、枚舉類型、Class類型或注解類型。例如：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value();
    int count() default 1;
}

在上面的代碼中，我們定義了一個名為MyAnnotation的注解，指定了兩個屬性：value和count，并為count屬性設定了預設值為1。

  1. 定義注解處理器

接下來，需要定義注解處理器。注解處理器需要實作javax.annotation.processing.Processor接口，并重寫process方法，以實作注解的處理邏輯。例如：

@SupportedAnnotationTypes("com.example.MyAnnotation")
public class MyAnnotationProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (TypeElement annotation : annotations) {
            for (Element element : roundEnv.getElementsAnnotatedWith(annotation)) {
                MyAnnotation myAnnotation = element.getAnnotation(MyAnnotation.class);
                String value = myAnnotation.value();
                int count = myAnnotation.count();
                // do something with the annotation values
            }
        }
        return true;
    }
}

在上面的代碼中，我們定義了一個名為MyAnnotationProcessor的注解處理器，使用@SupportedAnnotationTypes元注解指定了要處理的注解類型為com.example.MyAnnotation。在process方法中，我們使用反射機制擷取MyAnnotation注解的屬性值，并進行處理。

  1. 配置注解處理器

接下來，需要在META-INF/services目錄下建立一個名為javax.annotation.processing.Processor的檔案，檔案内容為注解處理器的全限定類名。例如：

com.example.MyAnnotationProcessor

在這個例子中，我們将注解處理器的全限定類名com.example.MyAnnotationProcessor寫入了javax.annotation.processing.Processor檔案中，以使得Java編譯器能夠自動發現并調用該注解處理器。

  1. 編譯和運作注解處理器

最後，需要使用Java編譯器編譯注解處理器，并将其打包成JAR檔案。在編譯Java源代碼時，可以使用-processor選項指定要使用的注解處理器，例如：

javac -processor com.example.MyAnnotationProcessor MyClass.java

在上面的指令中，我們使用-processor選項指定了要使用的注解處理器為com.example.MyAnnotationProcessor，并編譯了MyClass.java源檔案。

注解處理器也可以使用Maven或Gradle等建構工具進行建構和管理。

上一篇: 2.Vue項目的基本配置
下一篇: 2.Vue詳解一、前端核心分析二、第一個Vue程式三、Vue基本文法四、Vue雙向綁定v-model五、Vue元件六、Axios通信七、内容分發 slot八、自定義事件内容分發九、第一個vue-cli項目十、Webpack十一、vue-router路由十二、vue + ElementUI十三、路由嵌套十四、參數傳遞十五、路由鈎子與異步請求