Java注解

Java注解又称Java标注，Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同，Java标注可以通过反射获取注解内容。在编译器生成类文件时，注解可以被嵌入到字节码中。注解的本质就是一个继承了 Annotation 接口的接口。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface LogRecord{

}

实际上

public interface LogRecord extends Annotation{
    
}

1、内置注解

Java 定义了一套内置注解，如下所示：
(1)、作用在代码的注解是

• @Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
• @Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
• @SuppressWarnings - 指示编译器去忽略注解中声明的警告。

(2)、元注解:

@Retention 

• RetentionPolicy.SOURCE - 标记的注释仅保留在源级别中，并由编译器忽略。
• RetentionPolicy.CLASS - 标记的注释在编译时由编译器保留，但Java虚拟机（JVM）会忽略。
• RetentionPolicy.RUNTIME - 标记的注释由JVM保留，因此运行时环境可以使用它。

@Documented

@Documented 注释表明，无论何时使用指定的注释，都应使用Javadoc工具记录这些元素。（默认情况下，注释不包含在Javadoc中。）有关更多信息，请参阅 Javadoc工具页面。

@Target

@Target 注释标记另一个注释，以限制可以应用注释的Java元素类型。目标注释指定以下元素类型之一作为其值

• ElementType.TYPE 可以应用于类的任何元素。
• ElementType.FIELD 可以应用于字段或属性。
• ElementType.METHOD 可以应用于方法级注释。
• ElementType.PARAMETER 可以应用于方法的参数。
• ElementType.CONSTRUCTOR 可以应用于构造函数。
• ElementType.LOCAL_VARIABLE 可以应用于局部变量。
• ElementType.ANNOTATION_TYPE 可以应用于注释类型。
• ElementType.PACKAGE 可以应用于包声明。
• ElementType.TYPE_PARAMETER
• ElementType.TYPE_USE

@Inherited

@Inherited 注释表明注释类型可以从超类继承。当用户查询注释类型并且该类没有此类型的注释时，将查询类的超类以获取注释类型（默认情况下不是这样）。此注释仅适用于类声明。

@Repeatable

Repeatable Java SE 8中引入的，@Repeatable注释表明标记的注释可以多次应用于相同的声明或类型使用(即可以重复在同一个类、方法、属性等上使用)。

2、 自定义注解

@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface Permission {

    String valueData() default "";

    String textData() default "";
}

@Permission(valueData = "eeee", textData = "ffff")
public class MainTest {

    @Permission(valueData = "aaa", textData = "bbb")
    public String name;

    public String address;

    @Permission(valueData = "cccc", textData = "dddd")
    public void testMyName(){
        System.out.println("测试我的名字");
    }

    public static void main(String[] args) {
        Class clazz = null;
        try {
            //可以通过反射的方式获取注解的内容
            clazz = Class.forName("annotationuse.MainTest");
            Field[] fields = clazz.getFields();
            for (Field field : fields) {
                Permission annotationField = field.getAnnotation(Permission.class); //获取作用在字段上的注解内容
                if (annotationField != null){  //如果没有加注解，会报空指针异常
                    System.out.println(annotationField.valueData());
                    System.out.println(annotationField.textData());
                }
            }
            Method[] methods = clazz.getMethods();
            for (Method method : methods) {
                Permission annotationMethod = method.getAnnotation(Permission.class); //获取作用在方法上的注解内容
                if (annotationMethod != null){ //如果没有加注解，会报空指针异常
                    System.out.println(annotationMethod.valueData());
                    System.out.println(annotationMethod.textData());
                }
            }
            Permission permission = (Permission) clazz.getAnnotation(Permission.class); //获取作用在类上的注解内容
            if (permission != null){   //如果没有加注解，会报空指针异常
                System.out.println(permission.valueData());
                System.out.println(permission.textData());
            }
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}