Room实体复合主键成员变量@NonNull注解错误排查

看起来你遇到的问题是Room注解处理器没有正确识别你给name字段添加的@NonNull注解，即便你已经配置了复合主键。下面我来拆解可能的原因和正确的配置方式：

一、先确认复合主键的基础配置是否正确 #

首先，Room中定义复合主键必须在@Entity注解里通过primaryKeys数组指定所有主键字段，而不是给单个字段加@PrimaryKey注解。正确的实体类结构应该是这样的：

Java示例 #

import androidx.annotation.NonNull;
import androidx.room.Entity;

@Entity(primaryKeys = {"scavHuntID", "name"}) // 这里必须包含两个主键字段
public class ScavItems {
    @NonNull
    private String scavHuntID;
    @NonNull
    private String name;
    
    // 构造方法、getter/setter等
}

Kotlin示例 #

import androidx.annotation.NonNull
import androidx.room.Entity

@Entity(primaryKeys = ["scavHuntID", "name"])
data class ScavItems(
    @NonNull
    val scavHuntID: String,
    @NonNull
    val name: String // 注意：这里不能是String?，必须是不可空类型
)

二、报错的常见原因排查 #

你已经给name加了@NonNull但仍报错，大概率是以下某一个环节出了问题：

1. @NonNull的包导入错误
   必须使用androidx.annotation.NonNull，而不是java.lang.NonNull或者其他第三方库的@NonNull注解。Room的注解处理器只识别AndroidX的这个注解，导错包的话会直接忽略你的非空声明。

2. Kotlin中字段声明为可空类型
   如果是用Kotlin编写，即使你加了@NonNull，只要字段类型是String?（可空字符串），Room依然会判定它是可空的。必须确保字段类型是不可空的String。

3. @Entity的primaryKeys数组拼写错误
   检查数组里的字段名是否和实体类中的变量名完全一致（大小写敏感）。比如如果你的变量是name，但在primaryKeys里写了Name，Room就不会把它当作主键，进而触发非空检查错误。

4. 注解处理器缓存问题
   有时候Android Studio的注解处理器缓存会导致错误提示不更新。尝试执行Build > Clean Project然后Build > Rebuild Project，重新触发注解编译。

三、额外注意事项 #

• 如果你用的是较新版本的Room（2.4+），对于Kotlin的不可空类型，其实可以不用加@NonNull注解，Room会自动识别非空字段。但为了兼容性和代码清晰，加上也没问题。
• 确保所有主键字段都添加了@NonNull（或者在Kotlin中声明为不可空），因为主键本身就不允许为null。

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