您现在的位置：程式碼之家 >> 編程語言 > >> Java 程式設計 >> Java 相關知識

Java 註解完整教學：內建註解、元註解與自定義註解解析實戰

編輯：Java 相關知識

什麼是註解？

註解是元資料，JDK 1.5 引入，不直接影響程式邏輯，但可被編譯器、工具、運行時反射讀取，用於：

生成文檔
替代配置檔（如 Spring、Hibernate）
編譯期檢查（如 @Override）

三大標準註解

註解	用途
`@Override`	標示方法覆寫父類，編譯器檢查簽名一致性
`@Deprecated`	標示過時 API，使用時編譯器警告
`@SuppressWarnings`	抑制特定編譯器警告

四大元註解

元註解用於定義其他註解：

元註解	說明	關鍵屬性
`@Target`	註解適用程式元素	`ElementType.TYPE/METHOD/FIELD/...`
`@Retention`	註解保留階段	`RetentionPolicy.SOURCE/CLASS/RUNTIME`
`@Documented`	包含於 JavaDoc	無
`@Inherited`	允許子類繼承父類註解	無

自定義註解實戰

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MethodLog {
    String method() default "do something";
    String operator() default "someone";
}

@interface 宣告註解型別。
屬性以無參方法形式定義，支援 default。
屬性型別限制：基本型別、String、Class、enum、註解、上述型別陣列。

使用註解

public class CelebrateController {
    @MethodLog(method = "celebrate birthday", operator = "we")
    public void celebrateBirthday() {}

    @MethodLog(operator = "we")
    public void celebrateNewYears() {} // method 使用預設值

    @MethodLog
    public void yeah() {} // 全部預設值
}

註解解析器（反射讀取）

public class MethodLogParse {
    public static void parse(Class<?> clazz) {
        for (Method m : clazz.getDeclaredMethods()) {
            if (m.isAnnotationPresent(MethodLog.class)) {
                MethodLog log = m.getAnnotation(MethodLog.class);
                System.out.println(m.getName() + ": " + log.operator() + " - " + log.method());
            }
        }
    }
    public static void main(String[] args) { parse(CelebrateController.class); }
}

輸出：

celebrateBirthday: we - celebrate birthday
celebrateNewYears: we - do something
yeah: someone - do something

進階應用

編譯期處理：實作 AbstractProcessor，配合 @Retention(SOURCE)，掃描原始碼生成代碼（如 Lombok、MapStruct）。
運行時掃描：Spring 掃描 @Component、@RequestMapping 等建構 Bean 定義。
參數驗證：@NotNull、@Size 搭配 Validator。