实用 AI

可在线运行 AI 集合,涵盖 AI 文案生成、写作辅助、AI 绘图与照片修复、AI 配音、字幕生成、语音转录以及 AI 视频创作和数字人等多种 AI 服务

查看详情

自定义注解处理器和自动生成代码

Android面试技术要点汇总
2021-05-17 14:29 · 阅读时长9分钟
小课

虽然自定义注解处理器是Java1.5发布的特性了,但是仍然十分强大,我们将学习什么是注解处理器以及如何使用注解处理器和代码生成库来一些好用的功能。

一、注解

我相信每个使用过Java的人都知道,Java自身就有很多注解,比如@Override用来声明重写方法,@Singleton用来申明单例,Android SDK中也定义了一些注解,比如@NonNull@StringRes@IntRes等等。

二、代码生成

如果使用过Dagger2LombokDeepLinkDispatch 这些开源库的话,应该知道@Inject、@Component@Module等注解,通过在一些类或者方法上加上这些注解就能实现一些非常神奇的功能。实际上之所以能实现这些功能,是因为这些第三方库定义了一些注解处理器,在编译时,这些注解处理器根据注解自动生成了一些实现功能的Java代码。

三、自定义注解处理器

下面开始实现自定义注解处理器,主要功能是通过注解,实现路由跳转,示例项目分为以下三个部分:

  1. app模块。
  2. annotation模块,用于自定义一些注解。
  3. annotation processor模块,用于自定义一些注解处理器。
自定义注解处理器和自动生成代码

在annotation模块中,新建文件src/main/java/com/example/annotation/Route.java,声明自定义注解

加载中...
  • @interface,用于声明自定义注解。
  • @Target,用于申明自定义注解修饰类型,比如TYPE(类,接口等)、FIELD(成员变量)、METHOD(方法)等等。
  • @Retention,用于声明自定义注解保留的阶段,比如SOURCE(在源码中保留,编译后以及运行时就没有使用该注解的信息)、CLASS(编译后还保留使用该注解的信息,但是在运行时不可用)、RUNTIME(源码、编译后,以及运行时都可以获取使用该注解的信息)。

在annotation-processor模块中,修改build.gradle引入依赖

加载中...

然后编写自定义注解处理器,创建文件src/main/java/com/example/annotation/processor/RouteProcessor.java

加载中...
  • getSupportedAnnotationTypes,用于申明,该注解处理器需要处理的注解,只有包含这些注解的才会被该注解处理器处理。
  • process,用于实现处理注解的主要逻辑,包括解析被@Route标注过的类,根据@Route的参数url和对应类生成一张HashMap,然后根据表生成Java代码。
加载中...

最终通过注解自动生成的代码如下:

加载中...

这里仅仅是完成了最简单的路由跳转功能,没有考虑传参,以及调用结果之类的逻辑,完整的示例项目代码如下

一些优秀的路由框架:WMRouterARouterDeepLinkDispatch

注释
文件大小修改时间
annotation
2022年02月15日
annotation-processor
2022年02月15日
app
2022年02月15日
build.gradle
431 B 2022年02月15日
gradle/wrapper
2022年02月14日
gradle.properties
1 kB 2022年02月15日
gradlew
6 kB 2022年02月14日
gradlew.bat
3 kB 2022年02月14日
local.properties
437 B 2022年02月14日
settings.gradle
388 B 2022年02月15日
annotation processorannotationcode generation注解