在IntelliJ中调试Annotation Processor

转载翻译自 https://medium.com/@joachim.beckers/debugging-an-annotation-processor-using-intellij-idea-in-2018-cde72758b78a

如果想使用Intellij调试Annotation Processor（注释处理器）有以下三种选择：

1. Attach模式， 使用IntelliJ 内置的内置特性
2. Attach模式， 使用自定义设定
3. Listen模式

Attach模式， 使用IntelliJ 内置的内置特性

1. 创建一个远程调试设定

   
   
   Remote Run Configuration for Attach Mode
   
   

   在其中你需要选择调试器模式（Debugger Mode）为Attach并指定相应的端口（Port）。
   同时，还需要指定搜寻的classpath（Search sources using module's classpath）。

2. 设定构建过程的调试端口
   在菜单中选择：Help -> Edit Custom VM Options， 添加以下内容并重启IntelliJ：

-Dcompiler.process.debug.port=8000

端口8000是刚才我们在第一步中选择的需要attach的端口。

3. 打开IntelliJ的调试构建过程
   
   Turn on Debug Build Process
   
   注意，这个选项在每次IntelliJ重启后都会默认关闭。
4. 开始调试
   首先在Annotation Processor代码中添加断点。推荐断点打在AbstractProcessor#init中，因为AbstractProcessor#process不一定每次都会执行。
   然后按下快捷键Ctrl+F9触发构建过程。
   
   Start to Build Project
   
   在状态栏你可以看到构建过程在等待调试器连接：
   
   Build Process Pause
   
   这时候你需要运行你刚才创建的调试设置：
   
   Start Run Configuration

Attach模式， 使用自定义设定

1. 创建一个远程调试设定

   
   
   Remote Run Configuration for Attach Mode
   
   

   这里的设定和之前的选择是一样的。

2. 设置构建过程的VM选项
   选择File -> Settings -> Build, Execution, Deployment -> Compiler
   
   Shared build process VM options for Attach mode
   
   将构建过程共享VM选项设定为(Shared build process VM options)：

-Xdebug -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000

3. 取消使用模块JDK的编译器
   这一步的目的是为保证构建过程使用的是共享的构建过程。
   选择File -> Settings -> Build, Execution, Deployment -> Compiler->Java Compiler
   
   Uncheck Use compiler from module target JDK when possible
4. 开始调试构建过程
   和之前一样，添加断点，按下Ctrl+F9。

Listen模式

1. 创建一个远程调试设定
   
   Remote Run Configuration for Attach Mode
   
   这次我们选择的是Listen模式。其他的诸如端口设定和之前一样。
2. 使用模块JDK的编译器
   选择File -> Settings -> Build, Execution, Deployment -> Compiler
   我们要选中使用模块目标JDK的编译器（Use compiler from module target JDK when possible）
   
   Compiler options
   
   同时我们还需要添加额外的命令行参数：

-J-Xdebug -J-agentlib:jdwp=transport=dt_socket,server=n,address=localhost:8000,suspend=y,onuncaught=n

上面的参数的内容实际上是：

-J-Xdebug -J[调试设定中的参数]

关于参数中onthrow=和onuncaught=意义可以参考这里

3. 开始调试
   开始调试的步骤和之前的方法一致。

注意事项

• 对包含Annotation Processor的模块，需要关闭IntelliJ的annotation processing(Settings > Compiler > Annotation Processors)。

如何选择

• 方法一可能是最方便的选项， 你只需要通过打开/关闭IntelliJ的调试构建过程（Debug Build Process）的选项即可。
• 方法二适用于如果你需要更改命令行参数。
• 方法三在你需要保证适用模块目标JDK的编译器（Use compiler from module target JDK when possible）被选中的情况下适用。