Room多对多关联更新TripWithPlaces报错：参数需为@Entity类

问题描述 #

我开发用户行程追踪功能，行程包含起始公里数、结束公里数（用于计算总里程）及用户前往的地点。创建新行程时，用户可输入详情并从列表选择地点，场景和Room多对多关联的播放列表-歌曲案例类似。

最初未添加地点关联时，DAO中的更新方法如下，应用能正常查询数据库：

@Update
void updateTrip(Trip trip);

添加地点关联后，我想通过组合类TripWithPlaces更新完整行程，把方法改成：

@Transaction
@Update
void updateTrip(TripWithPlaces trip);

运行时出现编译错误：

error: Type of the parameter must be a class annotated with @Entity or a collection/array of it.
void updateTrip(TripWithPlaces trip);
^

删除操作也报相同错误。我尝试过更新依赖版本：将kotlin-bom升级至1.9.10，Room升级至2.6.0-rc01，Lifecycle升级至2.7.0-alpha02，但问题仍未解决。

相关代码 #

PlaceDao #

@Dao
public interface PlaceDao {

    @Insert
    void addPlace(Place place);

    @Update
    void updatePlace(Place place);

    @Delete
    void deletePlace(Place place);

    @Query("SELECT * FROM place WHERE place_id = :id")
    LiveData<Place> getPlaceByID(int id);

    @Query("SELECT * FROM place")
    LiveData<List<Place>> getAllPlaces();

}

TripDao #

@Dao
public interface TripDao {

    @Insert
    void addTrip(Trip trip);
    
    @Transaction
    @Update
    void updateTrip(TripWithPlaces trip);
    
    @Delete
    void deleteTrip(Trip trip);

    @Transaction
    @Query("SELECT * FROM trip WHERE trip_id = :id")
    LiveData<TripWithPlaces> getTripByID(int id);

    @Query("SELECT * FROM trip")
    LiveData<List<Trip>> getAllTrips();

    @Transaction
    @Query("SELECT * FROM trip")
    LiveData<List<TripWithPlaces>> getTripsWithPlaces();

}

Place实体 #

@Entity(tableName = "place")
public class Place {

    @PrimaryKey(autoGenerate = true)
    @ColumnInfo(name = "place_id")
    private int placeID;

    private String name;

    private String city;

    // constructors, getters, setters

}

Trip实体 #

@Entity(tableName = "trip")
public class Trip {

    @PrimaryKey(autoGenerate = true)
    @ColumnInfo(name = "trip_id")
    private int tripID;

    @ColumnInfo(name = "start_km")
    private double startKm;

    @ColumnInfo(name = "end_km")
    private double endKm;

    private TripStatus status;

    @ColumnInfo(name = "created_at")
    private long createdAt;

    // constructors, getters, setters

}

TripPlaceCrossRef #

@Entity(tableName = "trip_place_cross_ref", primaryKeys = {"trip_id", "place_id"})
public class TripPlaceCrossRef {

    @ColumnInfo(name = "trip_id")
    private int tripID;

    @ColumnInfo(name = "place_id")
    private int placeID;

    // constructors, getters, setters

}

TripWithPlaces #

public class TripWithPlaces {

    @Embedded
    private Trip trip;

    @Relation(
            parentColumn = "trip_id",
            entityColumn = "place_id",
            associateBy = @Junction(TripPlaceCrossRef.class)
    )
    private List<Place> places;

    // constructors, getters, setters

}

解决方案 #

错误原因 #

TripWithPlaces是通过@Embedded和@Relation组合的POJO类，并非Room的@Entity实体，而@Update、@Delete注解仅支持直接操作被@Entity标记的类或其集合/数组，因此直接用这些注解操作TripWithPlaces会触发编译错误。

解决步骤 #

1. 恢复原有Trip更新方法
   把TripDao中错误的updateTrip(TripWithPlaces trip)替换回原来的实体更新方法：

   @Update
   void updateTrip(Trip trip);
   

2. 添加关联表操作方法
   在TripDao中新增操作行程-地点关联表的方法：

   // 删除指定行程的所有关联地点记录
   @Query("DELETE FROM trip_place_cross_ref WHERE trip_id = :tripId")
   void deleteTripPlaceCrossRefs(int tripId);
   
   // 批量插入行程-地点关联记录
   @Insert
   void insertTripPlaceCrossRefs(List<TripPlaceCrossRef> crossRefs);
   

3. 编写事务性的自定义更新方法
   在TripDao中添加带@Transaction的默认方法，手动处理Trip实体和关联地点的完整更新：

   @Transaction
   default void updateTripWithPlaces(TripWithPlaces tripWithPlaces) {
       // 1. 更新Trip实体本身
       updateTrip(tripWithPlaces.getTrip());
       // 2. 删除该行程旧的关联地点记录
       deleteTripPlaceCrossRefs(tripWithPlaces.getTrip().getTripID());
       // 3. 生成新的关联记录并插入
       List<TripPlaceCrossRef> crossRefs = new ArrayList<>();
       for (Place place : tripWithPlaces.getPlaces()) {
           crossRefs.add(new TripPlaceCrossRef(tripWithPlaces.getTrip().getTripID(), place.getPlaceID()));
       }
       insertTripPlaceCrossRefs(crossRefs);
   }
   

4. 业务层调用自定义方法
   在代码中调用updateTripWithPlaces完成完整的行程更新：

   tripDao.updateTripWithPlaces(updatedTripWithPlaces);
   

同理处理删除操作 #

如果需要删除带关联地点的行程，可编写类似的事务方法：

@Transaction
default void deleteTripWithPlaces(TripWithPlaces tripWithPlaces) {
    deleteTripPlaceCrossRefs(tripWithPlaces.getTrip().getTripID());
    deleteTrip(tripWithPlaces.getTrip());
}

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