Java中注解的作用及自定義注解實現方法

Java 注解是一種元數據,提供為代碼添加額外信息的方式,不影響執行但可在編譯或運行時使用。1. 作用包括編譯檢查如@override、代碼生成如lombok的@data、運行時處理如spring的@autowired;2. 自定義注解通過@Interface定義,需指定@target和@retention;3. 使用場景如權限驗證、數據校驗及框架簡化配置;4. 保留策略選擇:source用于編譯檢查,runtime用于運行時反射處理,class較少用。自定義注解提升了代碼可讀性與框架擴展性。

Java中注解的作用及自定義注解實現方法

Java 注解,本質上是一種元數據,可以理解為代碼的標簽。它們提供了一種為代碼添加額外信息的方式,這些信息可以在編譯時、運行時被讀取和使用,但本身并不直接影響代碼的執行。自定義注解則允許我們根據特定需求創建自己的標簽,擴展 Java 的元數據能力。

Java中注解的作用及自定義注解實現方法

解決方案

Java 注解的作用主要體現在以下幾個方面:

Java中注解的作用及自定義注解實現方法

  1. 編譯時檢查: 比如 @Override 注解,它可以告訴編譯器,被注解的方法必須覆蓋父類的方法。如果方法名寫錯了,編譯器會報錯。
  2. 代碼生成: 很多框架利用注解在編譯時生成代碼,例如 Lombok,通過 @Data 注解自動生成 getter、setter 等方法,減少了大量的樣板代碼。
  3. 運行時處理: 框架可以在運行時讀取注解信息,并根據這些信息執行相應的操作。例如 Spring 框架,通過 @Autowired 注解實現依賴注入。

自定義注解的實現方法如下:

立即學習Java免費學習筆記(深入)”;

Java中注解的作用及自定義注解實現方法

  1. 定義注解: 使用 @interface 關鍵字定義注解。例如:

    import java.lang.annotation.*;  @Target(ElementType.METHOD) // 注解可以用于方法 @Retention(RetentionPolicy.RUNTIME) // 注解在運行時保留 public @interface MyAnnotation {     String value() default "default value"; // 注解的屬性,可以設置默認值     int number() default 0; }
    • @Target:指定注解可以應用在哪些元素上,例如類、方法、字段等。常見的取值有 ElementType.TYPE (類、接口)、ElementType.METHOD (方法)、ElementType.FIELD (字段) 等。
    • @Retention:指定注解的保留策略,即注解在哪個階段有效。常見的取值有 RetentionPolicy.SOURCE (源代碼級別,編譯器會丟棄)、RetentionPolicy.CLASS (編譯時,但 jvm 不可見)、RetentionPolicy.RUNTIME (運行時,JVM 可見,可以通過反射獲取)。
  2. 使用注解: 在代碼中使用定義的注解。

    public class MyClass {     @MyAnnotation(value = "hello", number = 123)     public void myMethod() {         // ...     } }
  3. 處理注解: 通過反射在運行時獲取注解信息并進行處理。

    import java.lang.reflect.Method;  public class AnnotationProcessor {     public static void main(String[] args) throws Exception {         Class<?> clazz = MyClass.class;         Method method = clazz.getMethod("myMethod");          if (method.isAnnotationPresent(MyAnnotation.class)) {             MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);             System.out.println("value: " + annotation.value());             System.out.println("number: " + annotation.number());         }     } }

為什么需要自定義注解?

自定義注解是為了滿足特定場景的需求。Java 提供的標準注解有限,無法覆蓋所有情況。例如,我們可能需要自定義注解來標記某些方法需要進行權限驗證,或者標記某些字段需要進行數據校驗。通過自定義注解,我們可以將這些信息嵌入到代碼中,并在運行時進行處理,從而實現更靈活、可擴展的功能。

自定義注解在框架開發中的應用

在框架開發中,自定義注解可以極大地簡化配置和代碼編寫。例如,一個 ORM 框架可以使用自定義注解來標記實體類的字段與數據庫表的列之間的映射關系。這樣,開發者只需要在實體類上添加注解,框架就可以自動完成數據庫操作,而無需編寫大量的 sql 代碼。spring boot 也是大量使用了注解來簡化配置,例如 @RestController, @RequestMapping 等等。

如何選擇合適的注解保留策略?

選擇合適的注解保留策略取決于你的使用場景。

  • 如果注解只用于編譯時檢查,例如 @Override,那么使用 RetentionPolicy.SOURCE 即可。
  • 如果注解需要在編譯時生成代碼,或者需要在運行時被框架處理,那么使用 RetentionPolicy.RUNTIME。
  • RetentionPolicy.CLASS 很少使用,一般用于一些特殊的字節碼處理工具

通常,為了保證靈活性和可擴展性,建議盡可能使用 RetentionPolicy.RUNTIME。

? 版權聲明
THE END
喜歡就支持一下吧
點贊8 分享