Java注解处理器（Annotation Processor）是Java编译器的一部分，它能够在编译期间处理注解，并根据注解生成新的源代码或字节码。注解处理器在Java编译过程中运行，可以生成额外的类、接口、方法或字段，从而实现代码生成和其他编译时任务。
Java注解处理器的基本概念
Java注解处理器（Annotation Processor）是一种特殊的编译器插件，它允许开发者在编译期间处理注解，并根据注解生成新的源代码或字节码。注解处理器通常用于生成额外的类、接口、方法或字段，以实现代码生成和其他编译时任务。
注解处理器的工作流程
- 编写注解处理器 ：编写一个实现了
javax.annotation.processing.Processor接口的类。 - 注册注解处理器：通过命令行或配置文件告诉Java编译器（javac）使用你的注解处理器。
- 处理注解：在编译期间，注解处理器根据注解生成新的源代码或字节码。
注解处理器的基本步骤
1. 创建注解
首先定义一个注解，用于标记需要处理的类或方法。
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 GenerateBean {
String author() default "Unknown";
}
2. 编写注解处理器
实现javax.annotation.processing.Processor接口，并重写process方法。
import javax.annotation.processing.AbstractProcessor;
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.TypeElement;
import javax.tools.Diagnostic;
import java.io.IOException;
import java.io.Writer;
import java.util.Set;
@SupportedAnnotationTypes("com.example.GenerateBean")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class BeanProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (TypeElement annotation : annotations) {
Set<? extends Element> annotatedElements = roundEnv.getElementsAnnotatedWith(annotation);
for (Element element : annotatedElements) {
if (element instanceof TypeElement) {
TypeElement typeElement = (TypeElement) element;
generateBeanClass(typeElement);
}
}
}
return true;
}
private void generateBeanClass(TypeElement typeElement) {
String packageName = processingEnv.getElementUtils().getPackageOf(typeElement).getQualifiedName().toString();
String className = typeElement.getSimpleName().toString();
String qualifiedClassName = packageName + "." + className;
String author = typeElement.getAnnotation(GenerateBean.class).author();
String generatedClassName = qualifiedClassName + "Bean";
String generatedCode = String.format(
"package %s;\n" +
"public class %s {\n" +
" private String name = \"%s\";\n" +
" public String getName() { return name; }\n" +
"}", packageName, generatedClassName, author);
try (Writer writer = processingEnv.getFiler().createSourceFile(generatedClassName).openWriter()) {
writer.write(generatedCode);
} catch (IOException e) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Error generating bean class: " + e.getMessage());
}
}
}
3. 注册注解处理器
通过命令行或配置文件告诉Java编译器（javac）使用你的注解处理器。
通过命令行注册
javac -processorpath path/to/your/processor.jar -processor com.example.BeanProcessor YourSourceFiles.java
通过processor文件注册
创建一个名为META-INF/services/javax.annotation.processing.Processor的文件，并在其中指定处理器的全限定名：
com.example.BeanProcessor
然后将这个文件放入META-INF/services目录下。
示例代码
1. 创建注解
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 GenerateBean {
String author() default "Unknown";
}
2. 编写注解处理器
import javax.annotation.processing.AbstractProcessor;
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.TypeElement;
import javax.tools.Diagnostic;
import java.io.IOException;
import java.io.Writer;
import java.util.Set;
@SupportedAnnotationTypes("com.example.GenerateBean")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class BeanProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (TypeElement annotation : annotations) {
Set<? extends Element> annotatedElements = roundEnv.getElementsAnnotatedWith(annotation);
for (Element element : annotatedElements) {
if (element instanceof TypeElement) {
TypeElement typeElement = (TypeElement) element;
generateBeanClass(typeElement);
}
}
}
return true;
}
private void generateBeanClass(TypeElement typeElement) {
String packageName = processingEnv.getElementUtils().getPackageOf(typeElement).getQualifiedName().toString();
String className = typeElement.getSimpleName().toString();
String qualifiedClassName = packageName + "." + className;
String author = typeElement.getAnnotation(GenerateBean.class).author();
String generatedClassName = qualifiedClassName + "Bean";
String generatedCode = String.format(
"package %s;\n" +
"public class %s {\n" +
" private String name = \"%s\";\n" +
" public String getName() { return name; }\n" +
"}", packageName, generatedClassName, author);
try (Writer writer = processingEnv.getFiler().createSourceFile(generatedClassName).openWriter()) {
writer.write(generatedCode);
} catch (IOException e) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Error generating bean class: " + e.getMessage());
}
}
}
3. 使用注解
package com.example;
@GenerateBean(author = "John Doe")
public class Person {
// 类定义
}
4. 注册注解处理器
通过命令行注册
javac -processorpath path/to/your/processor.jar -processor com.example.BeanProcessor Person.java
通过processor文件注册
创建一个名为META-INF/services/javax.annotation.processing.Processor的文件，并在其中指定处理器的全限定名：
com.example.BeanProcessor
然后将这个文件放入META-INF/services目录下。
运行结果
当编译Person.java时，注解处理器会在同一包下生成一个新的PersonBean.java文件：
package com.example;
public class PersonBean {
private String name = "John Doe";
public String getName() {
return name;
}
}
总结
Java注解处理器（Annotation Processor）是Java编译器的一部分，能够在编译期间处理注解，并根据注解生成新的源代码或字节码。通过使用注解处理器，可以实现代码生成和其他编译时任务，从而简化代码编写和维护工作。
掌握Java注解处理器的基本概念和使用方法后，可以更好地利用注解处理器来编写灵活和动态的应用程序。