如何查找Gradle模块依赖的所有@Entity注解文件及使用的属性

核心问题 #

某Gradle模块依赖多个包含数据库实体的模块，需明确该模块实际使用的实体及属性，判断移除迁移实体后模块能否正常运行，最终得到确保模块正常运行所需保留的数据库实体属性列表。

已尝试方案的局限性 #

• 实体关系图（ER图）：仅能展示实体结构关系，无法追踪代码层面的实体使用场景
• IntelliJ静态依赖分析：输出约1000个依赖类，需手动筛选实体，且无法定位具体使用的属性

可行解决方案 #

1. 基于Gradle的AST扫描任务 #

编写自定义Gradle任务，借助抽象语法树（AST）分析工具扫描模块源码：

• 利用JavaParser或Groovy AST工具，遍历当前模块的Java/Groovy源码
• 识别标注了JPA/Hibernate实体注解（如@Entity）的类，记录所有被当前模块代码直接调用的属性
• 输出结构化的实体-属性映射清单，示例格式：

  实体类：com.example.User
  使用属性：id, username, createTime
  

2. 运行时属性访问追踪 #

通过JVM字节码增强技术，追踪模块运行时实际访问的实体属性：

• 借助ByteBuddy工具，拦截实体类属性的getter/setter方法
• 运行模块核心业务流程，收集所有被触发的属性访问记录
• 对记录去重后，得到实际运行依赖的实体属性列表，可用于验证静态分析结果

3. IDE高级搜索筛选 #

利用IDE的精准搜索功能定位实体属性使用：

• 针对当前模块，搜索所有实体类属性的引用，正则示例：@Entity.*class\s+(\w+).*配合\1\.\w+
• 使用IntelliJ的Find Usages功能，批量查看每个实体属性的调用位置
• 导出搜索结果并整理为需保留的属性清单

结果验证 #

得到属性列表后，可通过以下方式验证有效性：

• 移除迁移实体及未使用的属性，编译模块检查是否存在编译错误
• 运行模块的单元测试、集成测试，确认核心业务功能正常

内容的提问来源于stack exchange，提问作者l-hofmann