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

g5zhu5896

已于 2024-06-02 17:04:24 修改

阅读量837

点赞数 28

分类专栏：工具文章标签： java

于 2024-06-02 17:02:54 首次发布

本文链接：https://blog.youkuaiyun.com/g5zhu5896/article/details/139391489

版权

工具专栏收录该内容

12 篇文章

订阅专栏

前言

源码中给的几种注解处理器代码都是网上抄的，本文主要是提供了 Maven 源码，不需要自己网上研究爬坑(当然具体生成代码的逻辑还是得自己写)。且从 lombok 抄了可以解决 idea 代理 ProcessingEnvironment 类后所产生的问题。

以下是网上抄的注解处理器代码的原地址

文章中没有介绍如何写注解处理器，不知道的可以看下如下文章。

StrGenProccessor
JavapoetProcessor
JavawriterProcessor
JCTreeProcessor

源码

源码地址

模块简介

*-processor 模块是实现具体注解处理器的实现,可以参考对应模块实现自己的注解处理器。
demo 模块是使用注解处理器模块的示例。

如何断点调试注解处理器

创建如下的 maven 命令然后在 idea 中 debug 启动，即可调试注解处理器

一些问题

1.莫名奇妙的就是没生成代码，且也没报任何错，代码断点也没进去。

目前知道的是如下两点没有按说的配置就会导致上述情况

①下图的类要和需要处理的注解对应上

②就是下图的文件夹和文件名不能错,且文件中需要配置需要使用的注解处理器。(注意这里是两个文件夹META-INF和services,而不是一个文件夹名叫META-INF.services。不要从idea中看，idea中看不出是一个文件夹还是两个文件夹。)

③对应注解必须有被需要编译的代码引用到才会走注解处理器的逻辑

2.出现JPS incremental annotation processing is disabled. Compilation results on partial recompilation may be inaccurate. Use build process “jps.track.ap.dependencies” VM flag to enable/disable incremental annotation processing environment.错误(使用本文的代码已解决，所以不会出现该错误。)。

原因就不多说了,主要是因为idea对 ProcessingEnvironment 进行代理导致的(和idea版本有关系)。具体可以看下面链接

[BUG] Lombok Does not work with IntelliJ EAP 2020.3 Build 203.4203.26 · Issue #2592 · projectlombok/lombok · GitHub

一个解决方案是在 idea -> complier->Vm options中配置如下参数。
-Djps.track.ap.dependencies=false
一种是代码层面上解决的。但是网上没有说具体如何解决，只说了lombok、mapstruct解决了。本文提供的源码中就是从 lombok 源码中找的代码解决的。解决代码如下图所示,主要是使用反射从 idea 代理的类中获取原生的 ProcessingEnvironment 类使用。

3.使用 JCTree 修改语法树后调用生成代码的方法编译会找不到对应的方法。

两种解决方法。

1.写一个父类,父类包含了要生成的方法。如下图所示，这样在代码中调用时就不会报错了。

2.参考 lombok idea 插件实现插件。这样就不需要特意写一个父类了。

目前没有研究，后续如果有研究会把源码补到本文提供的源码中。

代码生成方式简介

以下方式会基于已有的类创建新的类,且创建的类名不能和原类名一样。不能在已有的类中新增代码然后基于已有的类进行调用。如基于原类生成builder。

1.字符串拼接
源码中的类为 StrGenProccessor，生成代码的方式是用字符串拼接的，可读性较差

2.使用Javapoet
源码中的类为 JavawriterProccessor，使用 Javapoet 生成代码，比较优雅，可以自动 import 引用的类。Javapoet 是基于 JavaWriter 实现的

3.使用JavaWriter
源码中的类为 JavawriterProccessor，使用 JavaWriter 生成代码。

源码中包含一个手动编译的方法。如下图所示。

4.使用模板引擎比如 freemarker

本方法没有提供源码,看懂了上面三种方式的代码iu不难实现。mapstruct 就是使用模板引擎生成的代码。