[Java] 注解

背景

• 一种数据类型，和class平级
• JDK 1.5 后可用
• 类比：贴标签
• 注解是用来解释代码的元数据，但不是注解的代码本身的一部分，对代码运行效果没有直接影响
• 提取和处理Annotation的代码统称APT（Annotation Proccesing Tool）

应用

• 提供信息给编译器：检查错误信息
• 编译阶段处理：生成代码，Html文档等
• 运行时处理：注解在运行时接收代码提取

基本内置注解

• @Override：重写父类方法。如果父类没有该方法则编译无法通过
• @SuppressWarning：忽略警告信息
• @SafeVarargs：去掉使用可变数量参数，参数类型是泛型T时出现的警告
• @FunctionalInterface：约定函数接口

自定义注解

• 注解类型：@interface
• 创建注解：public @interface JDBCConfig
• 注解元素：String ip();
• 通过反射，获取注解对象
• 通过class对象的isAnnotationPresent()方法，判断是否应用了某个注解
• 通过class对象的getAnnotation()，获取Annotation对象
• 拿到注解对象，通过其方法，获取注解元素的值
• 注解只有成员变量，没有方法
• 注解的成员变量在注解定义中以“无形参方法”形式声明
• 方法名定义了成员变量的名字，返回值定义了成员变量的类型
• 使用时为属性赋值（value = " "），多个属性间用 , 隔开
• 属性的类型必须是8中数据类型，或类、接口、注解及其数组
• 利用 default 为注解的属性设置默认值

元注解

• 元数据（metadata）：为其他数据提供信息的数据
• @Target({METHOD,TYPE})：此注解可以使用在方法、类、接口上，不能放在属性位置
• @Retention(RetentionPolicy.RUNTIME)：运行时注解，运行起来才可获得注解中信息，而不像@Override编译时就可获取
• @Inherited：可被子类继承
• @Documented：执行javadoc时，会生成相关文档
• @Repeatable：可重复，注解的值可同时取多个

TestAnnotation.java

package Annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    
    int id() default -1;
    
    String msg() default "Hi";

}

Test.java

import Annotation.TestAnnotation;

@TestAnnotation()
public class Test {
    
    public static void main(String[] args) {
        
        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
        
        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
            
            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }
    }
}

参考

秒懂，Java 注解 （Annotation）你可以这样学

https://blog.csdn.net/briblue/article/details/73824058

自定义注解

https://how2j.cn/k/annotation/annotation-customize/1056.html#nowhere