Java进阶--编译时注解处理器(APT)详解

接下来我们用@Factory去注解形状类,如下:

@Factory(id = “Rectangle”, type = IShape.class)

public class Rectangle implements IShape {

@Override

public void draw() {

System.out.println(“Draw a Rectangle”);

}

}

//… 其他形状类代码类似不再贴出

**2.认识AbstractProcessor **

接下来,就到了我们本篇文章所要讲的核心了。没错,就是AbstractProcessor!我们先在factory-compiler模块下创建一个FactoryProcessor类继承AbstractProcessor ,并重写相应的方法,代码如下:

@AutoService(Processor.class)

public class FactoryProcessor extends AbstractProcessor {

@Override

public synchronized void init(ProcessingEnvironment processingEnvironment) {

super.init(processingEnvironment);

}

@Override

public Set getSupportedAnnotationTypes() {

return super.getSupportedAnnotationTypes();

}

@Override

public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {

return false;

}

@Override

public SourceVersion getSupportedSourceVersion() {

return super.getSupportedSourceVersion();

}

}

可以看到,在这个类上添加了@AutoService注解,它的作用是用来生成META-INF/services/javax.annotation.processing.Processor文件的,也就是我们在使用注解处理器的时候需要手动添加META-INF/services/javax.annotation.processing.Processor,而有了@AutoService后它会自动帮我们生成。AutoService是Google开发的一个库,使用时需要在factory-compiler中添加依赖,如下:

implementation ‘com.google.auto.service:auto-service:1.0-rc4’

接下来我们将目光移到FactoryProcessor类内部,可以看到在这个类中重写了四个方法,我们由易到难依次来看:

(1) public SourceVersion getSupportedSourceVersion()

这个方法非常简单,只有一个返回值,用来指定当前正在使用的Java版本,通常return SourceVersion.latestSupported()即可。

(2) public Set getSupportedAnnotationTypes()

这个方法的返回值是一个Set集合,集合中指要处理的注解类型的名称(这里必须是完整的包名+类名,例如com.example.annotation.Factory)。由于在本例中只需要处理@Factory注解,因此Set集合中只需要添加@Factory的名称即可。

(3) public synchronized void init(ProcessingEnvironment processingEnvironment)

这个方法用于初始化处理器,方法中有一个ProcessingEnvironment类型的参数,ProcessingEnvironment是一个注解处理工具的集合。它包含了众多工具类。例如:

Filer可以用来编写新文件;

Messager可以用来打印错误信息;

Elements是一个可以处理Element的工具类。

在这里我们有必要认识一下什么是Element

在Java语言中,Element是一个接口,表示一个程序元素,它可以指代包、类、方法或者一个变量。Element已知的子接口有如下几种:

PackageElement 表示一个包程序元素。提供对有关包及其成员的信息的访问。

ExecutableElement 表示某个类或接口的方法、构造方法或初始化程序(静态或实例),包括注释类型元素。

Type

  • 11
    点赞
  • 26
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java注解处理器(Annotation Processor)是Java语言提供的一种机制,用于在编译扫描和处理注解信息。它可以自动扫描Java源代码中的注解,生成新的Java代码、XML文件或者其他类型的文件。 Java注解处理器可以用于很多方面,比如生成代码、检查代码、生成文档等等。下面我们来详细介绍一下Java注解处理器的使用。 1. 创建注解 首先,我们需要定义一个注解注解通常用来标记Java源代码中的某个元素,比如类、方法、变量等。注解的定义方式如下: ```java @Target(ElementType.TYPE) @Retention(RetentionPolicy.SOURCE) public @interface MyAnnotation { String value(); } ``` 上面的代码定义了一个注解`MyAnnotation`,它有一个属性`value`。这个注解只能用于类上,它的生命周期为源代码级别。 2. 编写注解处理器 接下来,我们需要创建一个注解处理器,用来扫描和处理Java源代码中的注解信息。注解处理器必须实现`javax.annotation.processing.Processor`接口,同还需要用`@SupportedAnnotationTypes`注解指定要处理的注解类型,用`@SupportedSourceVersion`注解指定支持的Java版本。 ```java @SupportedAnnotationTypes("MyAnnotation") @SupportedSourceVersion(SourceVersion.RELEASE_8) public class MyAnnotationProcessor extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { for (TypeElement annotation : annotations) { Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(annotation); for (Element element : elements) { if (element.getKind() == ElementKind.CLASS) { String className = element.getSimpleName().toString(); String packageName = processingEnv.getElementUtils().getPackageOf(element).toString(); String value = element.getAnnotation(MyAnnotation.class).value(); System.out.println("Found class " + packageName + "." + className + ", value = " + value); } } } return true; } } ``` 上面的代码是一个简单的注解处理器,它可以处理`MyAnnotation`注解,输出被注解的类的信息,包括类名、包名和注解的属性值。 3. 注册注解处理器 最后,我们需要在`META-INF/services/javax.annotation.processing.Processor`文件中注册注解处理器,这样编译器才能够找到它并使用它。这个文件的内容就是注解处理器的全限定类名,比如: ``` com.example.MyAnnotationProcessor ``` 4. 编译Java源代码 现在我们就可以使用注解处理器了。对于一个Java项目,我们需要将注解处理器打包成一个Jar文件,并将它添加到项目的classpath中。然后,在编译Java源代码,我们需要指定`-processor`选项来告诉编译器要使用哪个注解处理器,比如: ``` javac -cp my-processor.jar -processor com.example.MyAnnotationProcessor MyAnnotatedClass.java ``` 上面的命令将会编译`MyAnnotatedClass.java`文件,并使用`com.example.MyAnnotationProcessor`注解处理器来处理其中的注解信息。 总结 Java注解处理器是一个非常强大的工具,它可以帮助我们自动化生成代码、检查代码、生成文档等等。使用注解处理器可以减少手写重复代码的工作量,提高代码的可维护性和可读性。需要注意的是,注解处理器只能用于编译,不能用于运行

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值