Room中@Ignore注解在KSP环境下失效问题求助

问题原因 #

在Kotlin数据类的主构造函数中使用@Ignore标记Java类类型的字段时，Room会因无法匹配到仅包含持久化字段的构造函数而报错。Room要求实体构造函数的参数必须与所有非忽略字段一一对应，而原数据类的主构造函数包含了被忽略的sampleJavaClass参数，导致构造函数匹配失败。

解决方法 #

方法一：将忽略字段移至类体中

把被@Ignore标记的字段从主构造函数移到类内部，主构造函数仅保留需要持久化的字段，Room就能正常识别构造函数：

@Entity(tableName = "SampleEntityTable")
data class SampleEntity(
    @PrimaryKey(autoGenerate = true)
    val id: Int = 0,
    var epoch: Long = 0
) {
    @Ignore
    var sampleJavaClass: SampleJavaClass? = null
}

方法二：添加次级构造函数

主构造函数仅包含持久化字段，同时添加一个包含忽略字段的次级构造函数，用于创建带忽略字段的实例：

@Entity(tableName = "SampleEntityTable")
data class SampleEntity(
    @PrimaryKey(autoGenerate = true)
    val id: Int = 0,
    var epoch: Long = 0
) {
    @Ignore
    lateinit var sampleJavaClass: SampleJavaClass

    constructor(id: Int = 0, epoch: Long = 0, sampleJavaClass: SampleJavaClass) : this(id, epoch) {
        this.sampleJavaClass = sampleJavaClass
    }
}

说明 #

两种方法都能让Room正确识别符合要求的构造函数，同时保留对忽略字段的使用。方法一更简洁，适合不需要在实例化时就传入忽略字段的场景；方法二则适合需要在创建实体时就初始化忽略字段的场景。

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