引言
Java注解（Annotation）是一种元数据，提供了一种向代码添加信息的方式。注解不会直接影响代码的执行，但可以用于生成代码、编译时检查和运行时处理。本篇博客将深入探讨Java注解与注解处理器，帮助读者全面理解和应用这一强大的工具。
什么是注解
注解是在代码中添加的元数据，它们可以用于类、方法、字段、参数、局部变量和包声明中。注解以 @ 字符开头，可以包含可选的元素。
内置注解
Java 提供了一些内置注解，如 @Override、@Deprecated 和 @SuppressWarnings：
public class BuiltInAnnotations {@Overridepublic String toString() {return "BuiltInAnnotations instance";}@Deprecatedpublic void deprecatedMethod() {// This method is deprecated}@SuppressWarnings("unchecked")public void suppressWarningsExample() {List rawList = new ArrayList();rawList.add("test");}
}
自定义注解
我们可以定义自己的注解：
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyCustomAnnotation {String value() default "default value";
}public class CustomAnnotationExample {@MyCustomAnnotation(value = "Hello, world!")public void annotatedMethod() {System.out.println("This method is annotated with MyCustomAnnotation.");}public static void main(String[] args) {CustomAnnotationExample example = new CustomAnnotationExample();example.annotatedMethod();}
}
在这个例子中，我们定义了一个自定义注解 MyCustomAnnotation，并将其应用到 annotatedMethod 上。@Retention 和 @Target 元注解用于指定注解的保留策略和可以应用的目标。
注解处理器
注解处理器是一种在编译时处理注解的工具。我们可以创建自己的注解处理器来生成代码或进行编译时检查。
创建注解处理器
首先，我们定义一个注解：
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface AutoGenerate {String className();
}
接下来，我们创建一个注解处理器：
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
import javax.tools.JavaFileObject;
import java.io.Writer;
import java.util.Set;@SupportedAnnotationTypes("AutoGenerate")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class AutoGenerateProcessor extends AbstractProcessor {@Overridepublic boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {for (Element element : roundEnv.getElementsAnnotatedWith(AutoGenerate.class)) {AutoGenerate annotation = element.getAnnotation(AutoGenerate.class);String className = annotation.className();try {JavaFileObject builderFile = processingEnv.getFiler().createSourceFile(className);try (Writer writer = builderFile.openWriter()) {writer.write("public class " + className + " {\n");writer.write(" public void hello() {\n");writer.write(" System.out.println(\"Hello from \" + getClass().getSimpleName());\n");writer.write(" }\n");writer.write("}\n");}} catch (Exception e) {processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, e.toString());}}return true;}
}
最后，我们在 META-INF/services 目录下创建一个文件 javax.annotation.processing.Processor，并在文件中添加处理器的完整类名：
com.example.AutoGenerateProcessor
使用注解处理器
我们可以使用 @AutoGenerate 注解来自动生成一个类：
@AutoGenerate(className = "GeneratedClass")
public class Example {public static void main(String[] args) {new GeneratedClass().hello();}
}
编译后，将生成 GeneratedClass 类并输出相应的信息。
结论
Java 注解与注解处理器提供了一种强大的机制，可以在编译时处理元数据以生成代码或执行检查。在这篇博客中，我们探讨了内置注解、自定义注解和注解处理器，以及如何在实际项目中使用它们。希望这篇博客能帮助你更好地理解和应用Java注解与注解处理器。
