新增Fragment后集成Hilt的Room Dao编译报错问题

你看到的所有Room相关报错都是误导性假报错。真正的故障点在Hilt注解处理环节：新增Fragment后，Hilt的kapt注解处理器在处理新Fragment相关代码时抛出了未捕获的InvocationTargetException，直接导致整个kapt编译任务中途崩溃。此时Room注解处理器还没完成类信息扫描，读不到Item类上的@Entity注解，才会抛出一堆“参数不是@Entity类型”“不支持CRUD返回值”的错误。
你之前尝试清缓存、重启、重编译都没用，是因为根本问题是代码配置错误，不是缓存脏数据导致的，每次编译都会在同一个环节崩溃。

• 不要去修改build目录下自动生成的ItemDao.java，这个文件是编译时自动生成的，手动改了下次编译也会覆盖。
• 打开Android Studio的Build输出窗口，把所有折叠的编译日志全部展开，找到[Hilt]标记后面的完整异常堆栈，不要只看编译窗口最后几行的错误总结，那里只会显示最表层的报错。
• 优先排查新增Fragment的Hilt配置错误，这类问题90%都是以下几种情况：
  • Fragment类加了@AndroidEntryPoint注解，但是Fragment里注入的ViewModel没有加@HiltViewModel注解，或者ViewModel的构造函数漏了@Inject注解
  • Fragment或者其依赖的ViewModel、Repository里，用@Inject标注注入的某个类型，没有在Hilt Module里配置对应的提供方法，也没有给该类的构造函数加@Inject注解，Hilt无法生成该类的实例
  • 写新Fragment代码时，误导入了其他包下同名的Item类，或者不小心新建了同名的Item类，导致Room扫描到的Item不是你定义的带@Entity注解的版本
• 额外检查ItemRoomDatabase类上的@Database注解，确认entities参数数组里确实包含了Item::class，没有漏写。
• 修复对应配置错误后，执行clean项目再重新编译即可。

这类混合使用Room+Hilt的项目，只要kapt环节中任何一个注解处理器（包括Hilt、Room、DataBinding、SafeArgs）抛出未捕获异常导致kapt任务中途终止，都有可能让其他注解处理器抛出不相关的假报错，排查问题时一定要顺着日志找第一个抛出的异常，不要被最后显示的表层错误误导。

内容的提问来源于stack exchange，提问作者Fernando Pailhe