注解

java java

Created At : 2021-11-10 20:50

Views 👀 :

理解Java注解
基本语法
注解与反射机制
Java8中注解增强
1. 元注解Repeatable

理解Java注解

Java注解与普通修饰符使用方式类似。

public class Demo {
    // @Test注解修饰方法A
    @Test
    public static void A() {
        System.out.println("Test.....");
    }

    // 一个方法上可以拥有多个不同的注解
    @Deprecated
    @SuppressWarnings("error")
    public static void B() {

    }
}

@Test:注解后，在运行该方法时，测试框架会自动识别该方法并单独调用
@Deprecated:说明该方法或是类都已经过期不建议再用
@SuppressWarnings:表示忽略指定警告

基本语法

声明注解与元注解

// 声明Test注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}

@Target:用来约束注解可以应用的地方。当注解未指定Target值时，则此注解可以用于任何元素之上，多个值使用{}包含并用逗号隔开。
- TYPE:标明该注解可以用于类、接口（包括注解类型）或enum声明
- FIELD:标明该注解可以用于字段(域)声明，包括enum实例
- METHOD:标明该注解可以用于方法声明
- PARAMETER:标明该注解可以用于参数声明
- CONSTRUCTOR:标明注解可以用于构造函数声明
- LOCAL_VARIABLE:标明注解可以用于局部变量声明
- ANNOTATION_TYPE:标明注解可以用于注解声明(应用于另一个注解上)
- PACKAGE:标明注解可以用于包声明
- TYPE_PARAMETER:标明注解可以用于类型参数声明（1.8新加入）
- TYPE_USE:类型使用声明（1.8新加入)
@Retention:约束注解的生命周期，分别有三个值，源码级别（source），类文件级别（class）或者运行时级别（runtime）。
- SOURCE：注解将被编译器丢弃（该类型的注解信息只会保留在源码里，源码经过编译后，注解信息会被丢弃，不会保留在编译好的class文件里）
- CLASS：注解在class文件中可用，但会被VM丢弃（该类型的注解信息会保留在源码里和class文件里，在执行的时候，不会加载到虚拟机中），请注意，当注解未定义Retention值时，默认值是CLASS，如Java内置注解，@Override、@Deprecated、@SuppressWarnning等
- RUNTIME：注解信息将在运行期(JVM)也保留，因此可以通过反射机制读取注解的信息（源码、class文件和执行的时候都有注解的信息），如SpringMvc中的@Controller、@Autowired、@RequestMapping等。
@Documented:被修饰的注解会生成到javadoc中
@Inherited:可以让注解被继承，但这并不是真的继承，只是通过使用@Inherited，可以让子类Class对象使用getAnnotations()获取父类被@Inherited修饰的注解

注解元素及其数据类型

public @interface AfterReturningTest {
    int name() default 1;
}

支持如下数据类型:

所有基本类型(注意，声明注解元素时可以使用基本类型但不允许使用任何包装类型)
String
Class
enum
Annotation(注解嵌套)
上述类型的数组

编译器对默认值的限制

元素不能有不确定的值。对于非基本类型的元素，无论是在源代码中声明，还是在注解接口中定义默认值，都不能以null作为值。

注解不支持继承

注解是不支持继承的，因此不能使用关键字extends来继承某个@interface，但注解在编译后，编译器会自动继承java.lang.annotation.Annotation接口。

快捷方式

value的元素，并且在使用该注解时，如果该元素是唯一需要赋值的一个元素，那么此时无需使用key=value的语法，而只需在括号内给出value元素所需的值即可。

Java内置注解与其它元注解

@Override：用于标明此方法覆盖了父类的方法
@Deprecated：用于标明已经过时的方法或类
@SuppressWarnnings:用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告
- deprecation：使用了不赞成使用的类或方法时的警告；
- unchecked：执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型;
- fallthrough：当 Switch 程序块直接通往下一种情况而没有 Break 时的警告;
- path：在类路径、源文件路径等中有不存在的路径时的警告;
- serial：当在可序列化的类上缺少 serialVersionUID 定义时的警告;
- finally：任何 finally 子句不能正常完成时的警告;
- all：关于以上所有情况的警告。

注解与反射机制

Java使用Annotation接口代表注解元素，该接口是所有Annotation类型的父接口。同时为了运行时能准确获取到注解的相关信息，Java在java.lang.reflect 反射包下新增了AnnotatedElement接口，它主要用于表示目前正在 VM 中运行的程序中已使用注解的元素，通过该接口提供的方法可以利用反射技术地读取注解的信息，如反射包的Constructor类、Field类、Method类、Package类和Class类都实现了AnnotatedElement接口。
下面是AnnotatedElement中相关的API方法:

方法返回值	方法名称	方法说明
<A extends Annotation>	getAnnotation(Class<A> annotationClass)	该元素如果存在指定类型的注解，则返回这些注解，否则返回 null。
Annotation[]	getAnnotations()	返回此元素上存在的所有注解，包括从父类继承的
boolean	isAnnotationPresent(Class<? extends Annotation> annotationClass)	如果指定类型的注解存在于此元素上，则返回 true，否则返回 false。
Annotation[]	getDeclaredAnnotations()	返回直接存在于此元素上的所有注解，注意，不包括父类的注解，调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响，没有则返回长度为0的数组

Java8中注解增强

元注解Repeatable

表示在同一个位置重复相同的注解。在没有该注解前，一般是无法在同一个类型上使用相同的注解的。