注解处理器的基本用法

最新推荐文章于 2024-09-29 10:41:55 发布

「已注销」

最新推荐文章于 2024-09-29 10:41:55 发布

阅读量565

点赞数 18

文章标签：后端

本文链接：https://blog.csdn.net/CTZL123456/article/details/139652466

版权

注解处理器（Annotation Processor）是Java编译器的一个插件，用于在编译时扫描和处理源代码中的注解，并生成额外的代码或者进行其他的操作。在Android开发中，注解处理器通常用于自动生成代码、资源处理、依赖注入、路由等方面。

一、注解

Java的注解（Annotation）是一种用于提供元数据的机制，允许在代码中嵌入信息，这些信息可以在编译时或运行时通过反射读取和使用。注解通常用于标记类、方法、字段、参数等，并在代码中添加有意义的标签，以便在编译、部署或运行时提供额外的信息或行为。

注解的基本使用

定义注解

注解是使用@interface关键字定义的。以下是一个简单的注解定义示例：

java

复制代码

java 复制代码 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 MyAnnotation { String value(); }

这里有份Java面试笔记包括了：Java面试、Spring、JVM、MyBatis、Redis、MySQL、并发编程、微服务、Linux、Springboot、SpringCloud、MQ、Kafka 面试专题

需要全套面试笔记的【点击此处即可】即可免费获取

@Retention：指定注解的保留策略，可以是SOURCE（只在源代码中保留，编译时被丢弃）、CLASS（编译时保留，但在运行时被丢弃）或RUNTIME（在运行时也保留，可以通过反射访问）。
@Target：指定注解可以应用的元素类型，比如类、方法、字段等。

使用注解

定义好注解后，可以在代码中使用：

typescript

复制代码

java 复制代码 public class MyClass { @MyAnnotation("Example") public void myMethod() { // 方法实现 } }

元注解（Meta-Annotations）

元注解是用于注解其他注解的注解。常见的元注解包括：

@Retention：指定注解的保留策略。
@Target：指定注解的适用范围。
@Documented：指示使用这个注解的元素应当被javadoc工具文档化。
@Inherited：允许子类继承父类的注解。
@Repeatable：允许同一类型的注解在同一声明上使用多次。

常见的内置注解

Java标准库提供了一些常见的内置注解：

@Override：指示子类方法覆盖父类方法。
@Deprecated：标记某个元素已经不推荐使用。
@SuppressWarnings：抑制特定的编译器警告。

自定义注解

除了使用内置注解，开发者还可以定义自己的注解，并在编译时或运行时使用这些注解。自定义注解通常结合注解处理器或反射机制来实现特定的功能。

二、注解处理器基本用法：

定义注解：首先需要定义一个注解，并在需要使用的地方添加注解。例如：
java

复制代码
java 复制代码 @Retention(RetentionPolicy.SOURCE) @Target(ElementType.TYPE) public @interface MyAnnotation { String value(); }
编写注解处理器：编写一个注解处理器，用于处理定义的注解。注解处理器通常需要继承自 AbstractProcessor 类，并且需要实现 process() 方法来处理注解。例如：
scala

复制代码
java 复制代码 public class MyAnnotationProcessor extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { // 处理注解的逻辑 return true; } }
注册注解处理器：在 META-INF/services 目录下创建一个名为 javax.annotation.processing.Processor 的文件，并在文件中指定注解处理器的类名。例如：
复制代码
复制代码 com.example.MyAnnotationProcessor
使用注解：在需要使用注解的地方添加注解，并在编译时触发注解处理器。例如：
kotlin

复制代码
java 复制代码 @MyAnnotation("Hello") public class MyClass { // 类的内容 }
编译时生成代码：当编译项目时，Java编译器会扫描源代码中的注解，并根据注解处理器的逻辑生成额外的代码。生成的代码可以根据需要写入到文件中，或者直接在内存中操作。

通过以上步骤，你可以实现自定义的注解处理器，并在编译时根据注解生成额外的代码或者进行其他的操作。

或者也可以通过注解的方式，自动注册注解处理器。在注解处理器上使用 @SupportedAnnotationTypes 和 @SupportedSourceVersion 注解，这样可以在编译时自动注册注解处理器，而不需要手动创建 META-INF/services/javax.annotation.processing.Processor 文件。

这两个注解的作用如下：

@SupportedAnnotationTypes：这个注解用于指定注解处理器支持处理的注解类型。你可以在这个注解中列出所有你的注解处理器支持处理的注解类型。如果你的注解处理器只处理特定的一些注解，那么你可以在这个注解中指定这些注解的全限定名。例如：
kotlin

复制代码
java 复制代码 @SupportedAnnotationTypes({"com.example.MyAnnotation1", "com.example.MyAnnotation2"})
@SupportedSourceVersion：这个注解用于指定注解处理器支持的源代码版本。通常情况下，你可以将这个注解的值设置为 SourceVersion.latestSupported()，表示支持最新的源代码版本。例如：
java

复制代码
java 复制代码 @SupportedSourceVersion(SourceVersion.latestSupported())