Java注解

Java注解

注解为代码提供元数据, 作为元数据, 注解不直接影响代码执行

1.注解的语法

// 注解和class, interface一样, 是java语言中的一种类
// 注解是通过@interface定义的
public @ interface TestAnnotation
{
    // 
}

2.元注解

2.1 元注解列表

就是使用在注解上的注解
元注解有 @Retention @Documented @Target @Inherited @Repeatable 5种

元注解	含义	选项
@Retention	标识注解的存活阶段	RetentionPolicy.SOURCE 源码阶段, 编译后丢失 RetentionPolicy.CLASS 编译阶段, 加载到jvm后丢失 RetentionPolicy.RUNTIOME 运行阶段, 运行时可以被获取, 生命周期最长
@Target	标识注解使用的地方, 多个使用位置可以使用 "," 分割	ElementType.ANNOTATION_TYPE 给一个注解进行注解 ElementType.CONSTRUCTOR 给构造器进行注解 ElementType.FIELD 给属性进行注解 ElementType.LOCAL_VARIABLE 给局部变量注解 ElementType.METHOD 给方法进行注解 ElementType.PACKAGE 给包进行注解 ElementType.PARAMETER 给方法的参数进行注解 ElementType.TYPE 给类, 接口, 枚举, 注解进行注解
@Documented	添加后JavaDoc工具处理完注解信息会被写到api文档中
@Inherited	被注解的类的子类是否能继承该注解	注意: 被注解的接口的子类不会继承该注解
@Repeatable	同一个位置该注解是否能被重复使用

2.2 @Repeatable注解(java8添加)

// 申明Role注解可以重复
// 反射获取的Role注解是多个, 多个Role被封装成RoleCan中
@ Repeatable(RoleCan.class)
public @interface Role
{
    public String value();
}

// 申明Role注解的容器, 属性是Role的数组
@ Retention(RetentionPolicy.RUNTIME)
@ Target({ElementType.TYPE, ElementType.FIELD})
public @interface RoleCan
{
    Role[] value() default {};
}

3.注解的属性

注解的属性也就是注解的成员变量, 注解只有成员变量没有方法, 注解的成员变量的声明方式以 "无参函数" 的方式来申明, 这个无参函数的方法名就是成员变量的名称

@ Retention(RetentionPolicy.RUNTIME)
@ Target({ElementType.TYPE, ElementType.FIELD})
public @interface TestAnnotation
{
    // name就是该注解的成员变量, 默认值是zhangsam, public可以省略
    public String name();

    // 申明数组类型的成员变量
    public String[] addrs();
}

给注解的属性赋值

@ TestAnnotation(name = "zhangsam", addrs = {"无锡"})
public class Test
{
    // 如果TestAnnotation注解的name属性没有默认值, 则会报错, 需要手动赋值
    // 如果TestAnnotation没有属性, 则括号可以省略
}

4.注解的提取

// 如果TestAnnotation注解的name属性没有默认值, 则会报错, 需要手动赋值
// 如果TestAnnotation没有属性, 则括号可以省略
@ TestAnnotation(name = "zhangsam", addrs = {"wuxi"})
public class Test
{
    // 定义在属性上的注解
    @ TestAnnotation(name = "lisi", addrs = {"changan"})
    private String a;

    public static void main(String[] args) throws NoSuchFieldException, SecurityException
    {
        // 提取类上的注解
        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
        if (hasAnnotation)
        {
            // TestAnnotation annotation = Test.class.getAnnotation(TestAnnotation.class);
            TestAnnotation[] annotations = Test.class.getAnnotationsByType(TestAnnotation.class);
            for (TestAnnotation annotation : annotations)
            {
                System.out.println(annotation.name());
                System.out.println(annotation.addrs());
            }
        }

        // 提取属性上的注解
        Field a = Test.class.getDeclaredField("a");
        a.setAccessible(true);
        TestAnnotation annotationInField = a.getAnnotation(TestAnnotation.class);
        System.out.println(annotationInField.name());
        System.out.println(annotationInField.addrs());
    }
}

5.注解的使用场景

1. 提供信息给编译器, 编译器利用注解信息来检测和探知信息
2. 编译时的处理, 软件工具可以使用注解信息生成代码
3. 运行时处理