Android Room如何构建嵌套一对一关系类实现单查询获取全量关联数据
Android Room 嵌套关联关系类设计方案
整体思路
Room 处理嵌套一对一关联的核心是用非Entity的POJO承载类组装关联数据,结合@Embedded嵌入基础实体、@Relation配置关联规则,最终通过带@Transaction的DAO方法一次性返回完整组装的对象。
你的场景是三层嵌套一对一:User -> Address -> Geo + User -> Company,需按层级拆分承载类实现。
步骤1:设计Address与Geo的关联承载类
首先处理Address和Geo的一对一嵌套关系,新建非Entity的普通类AddressWithGeo:
import androidx.room.Embedded; import androidx.room.Relation; // 普通POJO,无需添加@Entity注解 public class AddressWithGeo { // 嵌入Address实体的所有字段,加prefix避免和其他实体同名字段冲突 @Embedded(prefix = "address_") public Address address; // 配置Geo关联规则:Address的fk_geoId对应Geo的主键geoId @Relation(parentColumn = "fk_geoId", entityColumn = "geoId") public Geo geo; }
说明:
prefix = "address_"会给Address的所有字段加前缀(比如street变为address_street),从根源避免字段冲突。
步骤2:设计User的全量数据承载类
新建最顶层的非Entity普通类UserWithFullDetails,组装User、关联的AddressWithGeo、关联的Company:
import androidx.room.Embedded; import androidx.room.Relation; public class UserWithFullDetails { // 嵌入User实体的所有字段,加前缀避免和Company的同名字段(比如name)冲突 @Embedded(prefix = "user_") public User user; // 配置Address关联:User的fk_addressId对应Address的主键addressId @Relation( parentColumn = "fk_addressId", entity = Address.class, // 显式指定关联的实体类,避免Room推断错误 entityColumn = "addressId" ) public AddressWithGeo addressWithGeo; // 配置Company关联:User的fk_companyId对应Company的主键companyId @Relation( parentColumn = "fk_companyId", entity = Company.class, entityColumn = "companyId" ) public Company company; }
注意:你的User和Company实体都包含
name字段,必须给嵌入的User加prefix前缀,否则Room会报字段冲突错误。
步骤3:配置DAO查询方法
在DAO接口中添加查询方法,必须加@Transaction注解:Room处理关联数据是多步查询(主表查询一次,关联表分别批量查询),事务保证整个组装过程的数据一致性。
import androidx.room.Dao; import androidx.room.Query; import androidx.room.Transaction; import java.util.List; @Dao public interface UserDao { @Transaction @Query("SELECT * FROM User") // 仅需写一次主查询SQL,Room自动处理后续关联查询 List<UserWithFullDetails> getUsersWithFullInfo(); }
关键注意事项
- 所有承载类都不能加
@Entity注解,否则会被Room识别为独立数据表 @Relation的parentColumn、entityColumn必须和实体中定义的外键、主键列名完全一致- 出现字段冲突时优先用
@Embedded的prefix参数加前缀,不要修改实体本身的字段名 - 多层嵌套关联无需手动编写多表联查SQL,Room会自动按层级处理关联查询逻辑
- 基本类型(比如double、int)不需要加
@NonNull注解,Room会默认处理非空逻辑 - 实体中的Gson相关注解(比如
@SerializedName)会被Room自动忽略,无需删除
内容的提问来源于stack exchange,提问作者Coder88
相关产品推荐
相关产品推荐

