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})
@Inherited
public @interface Unfinished {
public enum Priority { LOW, MEDIUM, HIGH }

String value();
String[] owners() default "";
Priority priority() default Priority.MEDIUM;
}

四.

@Documented 将注释包含在JavaDoc中