在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的端口。

  1. 打开IntelliJ的调试构建过程
    Turn on Debug Build Process

    注意,这个选项在每次IntelliJ重启后都会默认关闭。
  2. 开始调试
    首先在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
  1. 取消使用模块JDK的编译器
    这一步的目的是为保证构建过程使用的是共享的构建过程。
    选择File -> Settings -> Build, Execution, Deployment -> Compiler->Java Compiler
    Uncheck Use compiler from module target JDK when possible
  2. 开始调试构建过程
    和之前一样,添加断点,按下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=意义可以参考这里

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

注意事项

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

如何选择

  • 方法一可能是最方便的选项, 你只需要通过打开/关闭IntelliJ的调试构建过程(Debug Build Process)的选项即可。
  • 方法二适用于如果你需要更改命令行参数。
  • 方法三在你需要保证适用模块目标JDK的编译器(Use compiler from module target JDK when possible)被选中的情况下适用。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342