如何调试Android Annotation Processor程序

左手的ㄟ右手 2022-10-02 11:54 200阅读 0赞

> 【版权申明】非商业目的可自由转载  
> 博文地址：[https://blog.csdn.net/ShuSheng0007/article/details/92795576][https_blog.csdn.net_ShuSheng0007_article_details_92795576]  
> 出自：shusheng007

### 文章目录 ###

*  概述
 *  调试方法
 *   *  1 配置remote configuration
     *  2 配置gradle.properties 文件
     *  3 运行调试
 *  总结

# 概述 #

当我们开发一个Android Annotation Processor的时候肯定需要调试我们的代码，但是Annotation Processor的执行是与编译并行执行的，所以如果我们只是按照通常的方式简单的打一个断点，代码是不会中断的。

# 调试方法 #

我们需要使用远程调试，我们就以上篇文章[秒懂Android注解处理器][Android]中开发的 [AnnotationProcessorToy][]为例来演示一下如何调试Annotation Processor。

## 1 配置remote configuration ##

在Android Studio中配置configuration ，如下图所示  
![ss][]  
点击+ 号，选择Remote  
![在这里插入图片描述][20190618165425397.png]  
给新建的configuration命名，例如命名为APT. 复制蓝色框中的参数，接下来会用到。

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

点击apply 按钮  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70]

## 2 配置gradle.properties 文件 ##

在gradle.properties文件中添加如下两行内容，第二行的值为上一步蓝框中的内容。

org.gradle.daemon=true
    org.gradle.jvmargs= -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005

## 3 运行调试 ##

首先选择选择第一步创建的 configuration **APT**，然后点击debug按钮。

如果一切正常的话，在Console窗口会输出如下内容，表示远程进程已经启动了  
![在这里插入图片描述][2019061817340794.png]  
在processor代码中要调试的地方打上断点，然后切换到configuration **app** ，然后点击debug按钮即可  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70 1]

**note**：注意，只有被注解标记的类内容有改变时注解处理器才会执行，所以如果发现断点没有中断，记得改一下源代码。

# 总结 #

Annotation Processor的调试主要还是使用了remote调试的技术，Android Stuido的**debugger** 是运行在自己的进程中，而Annotation Processor 运行在另一个进程中，我们就是通过Remote Debug使得 **debugger** 可以调试运行在另一个进程中的程序。

[https_blog.csdn.net_ShuSheng0007_article_details_92795576]: https://blog.csdn.net/ShuSheng0007/article/details/92795576
[Android]: https://blog.csdn.net/ShuSheng0007/article/details/90734159
[AnnotationProcessorToy]: https://github.com/shusheng007/AnnotationProcessorToys
[ss]: /images/20220112/c9ada714c3534d4e8d9a5efe1daf9a82.png
[20190618165425397.png]: /images/20220112/d973e378835149ef8ffdde8e9c9a5f85.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70]: /images/20220112/dd7394336fb84c0eacda5402a05517db.png
[2019061817340794.png]: /images/20220112/96381c3dea3341b7809049ead2044510.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70 1]: /images/20220112/d748485ac57842508e6ee59ade1cab6b.png