Room所有suspend修饰Dao函数返回Object触发编译报错

问题现象 #

集成Room数据库的项目此前运行正常，近期无明确代码改动的情况下出现异常：所有被suspend修饰的Dao方法，自动生成的实现类返回值均为java.lang.Object类型，编译阶段抛出如下错误：

C:\(...\)\FlightDao.java:18: error: Not sure how to convert a Cursor to this method's return type (java.lang.Object).
    public abstract java.lang.Object getFlightById(int id, @org.jetbrains.annotations.NotNull()

报错对应的Dao定义代码如下：

@Dao
interface FlightDao {
    @Query("SELECT * FROM FlightData WHERE DELETEFLAG == 0 AND flightID = :id LIMIT 1")
    suspend fun getFlightById(id: Int): FlightData?
}

已验证的现象与配置 #

• 临时去掉方法的suspend修饰符后编译正常
• 将返回值改为Flow类型后通过first()获取结果也不会触发报错
• 按照Android官方开发文档说明，这类one-shot单次查询操作本就应该使用suspend函数实现
• 模块Gradle配置已正确引入kotlin-kapt插件与Room相关依赖：

  apply plugin: 'kotlin-kapt'
  // 其余配置省略
  implementation "androidx.room:room-runtime:$room_version"
  kapt "androidx.room:room-compiler:$room_version"
  implementation "androidx.room:room-ktx:$room_version"
  

• 已尝试Clean清理、Rebuild重新构建项目，问题未解决
• 检索到的同类问题多为suspend与LiveData不兼容导致，但当前代码未使用LiveData，写法完全参照官方文档
• 当前开发环境版本：Kotlin 1.7.0、Room 2.4.2

可行解决方案 #

该问题是Kotlin 1.7.x版本与Room 2.4.x版本的注解处理器兼容性bug导致：Kotlin 1.7调整了suspend函数的字节码生成规则，老版本Room的kapt处理器无法正确识别suspend函数的真实返回类型，才会将返回值识别为Object。可按以下优先级尝试解决：

1. 升级Room版本（推荐）
   Room从2.5.0正式版本开始完整适配Kotlin 1.7.x系列，将room_version调整为2.5.0及以上稳定版本（如2.5.2），同步Gradle依赖后重新构建即可，无需修改任何业务代码。
2. 无法升级Room时的配置规避
   如果项目暂时无法升级Room依赖，可在模块级build.gradle中关闭Room的增量注解处理，绕过签名识别bug，配置如下：

   android {
       // 原有android配置省略
   }
   kapt {
       arguments {
           arg("room.incremental", "false")
           // 如果原有配置中已经声明了room.schemaLocation等参数，保留即可，仅新增上面这行
       }
   }
   

   该方案会小幅增加全量编译的耗时，但是不需要改动依赖和业务代码。
3. 临时代码规避（不推荐长期使用）
   即已经验证过的两种写法：要么去掉suspend修饰符，在调用处手动切换到IO调度器执行查询；要么将返回值声明为Flow<FlightData?>，在业务层通过first()拿到单次查询结果。这两种写法都可以绕过注解处理的bug，但不符合Room的协程最佳实践。

注意：不要尝试通过显式声明Continuation参数的方式修改suspend函数签名，会破坏协程的正常调度逻辑。

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