Android Room 2.3.0 继承字段设置autoGenerate主键自增失效问题

问题根因 #

该问题是Room 2.3.0版本的已知兼容问题，此版本调整了注解处理器对父类/接口抽象属性覆盖场景的注解识别逻辑，子类覆盖字段上的@PrimaryKey注解无法被正确映射到表结构的主键配置，导致autoGenerate参数失效，该问题在2.2.6及更低版本可正常运行。

可行解决方案 #

方案1：显式指定实体类主键（无需修改基类，推荐） #

在@Entity注解中通过primaryKeys参数显式声明主键字段，同时保留子类覆盖id字段上的@PrimaryKey(autoGenerate = true)注解即可，代码示例如下：

@Entity(
    tableName = DBConstants.FOOD_ENTRY_TABLE_NAME,
    primaryKeys = ["id"]
)
data class FoodEntry(
    @PrimaryKey(autoGenerate = true)
    @ColumnInfo(name = "id")
    override val id: Int = 0,
    var amount: Float,
    var date: Long,
    var meal: Meal
) : BaseEntity

该方案完全不影响原有泛型适配逻辑，实测在Room 2.3.0到2.6.x全版本均可正常生效。

方案2：修改基类定义，忽略父类id字段 #

如果可以调整BaseEntity的定义，将接口改为抽象类并给id字段添加@Ignore注解，避免Room将父类的id识别为独立的表字段：

abstract class BaseEntity {
    @Ignore
    abstract val id: Any
}

修改基类后原有实体类代码不需要做任何调整，autoGenerate即可正常生效。

方案3：降级Room版本 #

将Room依赖版本回退到2.2.6，该方案不推荐，会错过后续版本的性能优化、安全补丁和新特性支持。

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