java 元注釋學習筆記

一.

@Retention

 

您需要將批註保留多長時間？RetentionPolicy 枚舉中列出了三個選項：

選項	注釋	樣本
RetentionPolicy.SOURCE	在編譯過程中丟棄。編譯完成後，這些批註將不起任何作用，因此不會將它們寫入位元組碼。	@Override、@SuppressWarnings
RetentionPolicy.CLASS	在類載入過程中丟棄。當執行位元組碼級的後期處理時很有用。有些另人吃驚的是，這是預設值。	-
RetentionPolicy.RUNTIME	不丟棄，以便可以運行時用於反映。	@Deprecated

@Retention 批註使您可以為自訂批註類型指定所需的 RetentionPolicy；它接受一個 RetentionPolicy 類型的“value”參數。@Unfinished 樣本 RetentionPolicy.RUNTIME 更有意義，您可以進行以下更改。

package com.servlets;import java.lang.annotation.*;@Unfinished("Just articleware")@Documented@Retention(RetentionPolicy.RUNTIME)public @interface Unfinished { ...}

二. 
@Target 

現在，您要將批註放在哪裡？ElementType 枚舉中列出了八個選項： 

• ElementType.TYPE (class, interface, enum) //類,介面或枚舉聲明
• ElementType.FIELD (instance variable) //成員變數聲明
• ElementType.METHOD //方法聲明
• ElementType.PARAMETER //參數聲明
• ElementType.CONSTRUCTOR //構造器聲明
• ElementType.LOCAL_VARIABLE //局部變數聲明
• ElementType.ANNOTATION_TYPE (on another annotation) //其他元注釋聲明
• ElementType.PACKAGE (remember package-info.java) //包聲明

當您知道了可以使用的位置列表後，使用 @Target 批註（接受 ElementType 值數組）指定該位置。它只是一個整體性列表，也就說您不能排除任一位置，而是必須列出允許的七個位置。當 @Target 不存在時的預設設定是允許任何位置。@Unfinished 樣本在五個位置有效，因此我們可以按如下所示指定它： 

package com.servlets;import java.lang.annotation.*;@Unfinished("Just articleware")@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD,ElementType.CONSTRUCTOR,ElementType.ANNOTATION_TYPE,ElementType.PACKAGE})public @interface Unfinished { ...}

三.

@Inherited

 

最後，@Inherited 控制批註是否影響子類。例如，@Unfinished 超類是否指示未完成的子類？或許指示，因此以下是 @Unfinished 的最終格式：

package com.servlets;import java.lang.annotation.*;@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD,ElementType.CONSTRUCTOR,ElementType.ANNOTATION_TYPE,ElementType.PACKAGE})@Inheritedpublic @interface Unfinished {public enum Priority { LOW, MEDIUM, HIGH }String value();String[] owners() default "";Priority priority() default Priority.MEDIUM;}

四.@Documented 將注釋包含在JavaDoc中