Java中的注解：自定义注解、元注解、注解处理器

翻滚的胖子
2023-05-29 17:08:50
后端技术
Java

在Java编程中，注解（Annotation）是一种元数据，它提供了关于程序代码的额外信息，这些信息可以被编译器、解释器和其他工具使用。注解可以被用来提供文档信息、配置文件、代码分析等。

注解的分类

Java中的注解可以分为三类：元注解、预定义注解和自定义注解。

元注解

元注解是用来注解其他注解的注解。Java中提供了四种元注解：

@Retention：指定注解的生命周期，包括RetentionPolicy.SOURCE、RetentionPolicy.CLASS和RetentionPolicy.RUNTIME三种。
@Target：指定注解可以标注在哪些元素上，包括ElementType.TYPE、ElementType.FIELD等。
@Inherited：指定注解是否可以被继承。
@Documented：指定注解是否包含在JavaDoc中。

预定义注解

Java中提供了一些预定义的注解，例如：

@Override：用于标注方法覆盖父类方法。
@Deprecated：用于标注已经过时的方法或类。
@SuppressWarnings：用于抑制编译器警告。

自定义注解

自定义注解可以通过@interface关键字定义，语法格式如下：

[访问修饰符] @interface 注解名 {

在自定义注解中可以定义属性，属性的语法格式如下：

属性类型 属性名([参数列表]);

其中，注解属性可以有默认值，如果不指定属性值则使用默认值。

注解处理器

注解处理器用于处理注解，生成新的Java代码、XML文件等。在Java中，可以使用Java Annotation Processing Tool (APT) 或者第三方库来处理注解。

注解处理器的实现需要继承AbstractProcessor类，并重写其process()方法，该方法会在编译时被调用。

下面是一个自定义注解和其对应的注解处理器的案例：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    String value() default "";
}

public class MyAnnotationProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (Element element : roundEnv.getElementsAnnotatedWith(MyAnnotation.class)) {
            String value = element.getAnnotation(MyAnnotation.class).value();
            // 生成新的Java代码等
        }
        return true;
    }
}