Определение и запрос вложенных отношений

Иногда может потребоваться запрос к набору из трех или более таблиц, которые связаны между собой. В этом случае вы определяете вложенные связи между таблицами.

Предположим, в примере с приложением для потоковой передачи музыки вам нужно запросить всех пользователей, все плейлисты для каждого пользователя и все песни в каждом плейлисте для каждого пользователя. Пользователи имеют отношение «один ко многим» с плейлистами, а плейлисты имеют отношение «многие ко многим» с песнями. В следующем примере кода показаны классы, представляющие эти сущности, а также таблица перекрестных ссылок для отношения «многие ко многим» между плейлистами и песнями:

Котлин 

@Entity
data class User(
    @PrimaryKey val userId: Long,
    val name: String,
    val age: Int
)

@Entity
data class Playlist(
    @PrimaryKey val playlistId: Long,
    val userCreatorId: Long,
    val playlistName: String
)

@Entity
data class Song(
    @PrimaryKey val songId: Long,
    val songName: String,
    val artist: String
)

@Entity(primaryKeys = ["playlistId", "songId"])
data class PlaylistSongCrossRef(
    val playlistId: Long,
    val songId: Long
)

Java 

@Entity
public class User {
    @PrimaryKey public long userId;
    public String name;
    public int age;
}

@Entity
public class Playlist {
    @PrimaryKey public long playlistId;
    public long userCreatorId;
    public String playlistName;
}
@Entity
public class Song {
    @PrimaryKey public long songId;
    public String songName;
    public String artist;
}

@Entity(primaryKeys = {"playlistId", "songId"})
public class PlaylistSongCrossRef {
    public long playlistId;
    public long songId;
}

Сначала смоделируйте связь между двумя таблицами в вашем наборе, как обычно, используя класс данных и аннотацию @Relation . В следующем примере показан класс PlaylistWithSongs , который моделирует связь «многие ко многим» между классом сущности Playlist и классом сущности Song :

Котлин 

data class PlaylistWithSongs(
    @Embedded val playlist: Playlist,
    @Relation(
         parentColumn = "playlistId",
         entityColumn = "songId",
         associateBy = Junction(PlaylistSongCrossRef::class)
    )
    val songs: List<Song>
)

Java 

public class PlaylistWithSongs {
    @Embedded public Playlist playlist;
    @Relation(
         parentColumn = "playlistId",
         entityColumn = "songId",
         associateBy = Junction(PlaylistSongCrossRef.class)
    )
    public List<Song> songs;
}

После определения класса данных, представляющего эту связь, создайте еще один класс данных, моделирующий связь между другой таблицей из вашего набора и первым классом связи, «вкладывая» существующую связь в новую. В следующем примере показан класс UserWithPlaylistsAndSongs , моделирующий связь «один ко многим» между классом сущности User и классом связи PlaylistWithSongs :

Котлин 

data class UserWithPlaylistsAndSongs(
    @Embedded val user: User
    @Relation(
        entity = Playlist::class,
        parentColumn = "userId",
        entityColumn = "userCreatorId"
    )
    val playlists: List<PlaylistWithSongs>
)

Java 

public class UserWithPlaylistsAndSongs {
    @Embedded public User user;
    @Relation(
        entity = Playlist.class,
        parentColumn = "userId",
        entityColumn = "userCreatorId"
    )
    public List<PlaylistWithSongs> playlists;
}

Класс UserWithPlaylistsAndSongs косвенно моделирует взаимосвязи между всеми тремя классами сущностей: User , Playlist и Song . Это показано на рисунке 1.

Объект UserWithPlaylistsAndSongs моделирует взаимосвязь между пользователем и объектом PlaylistWithSongs, который, в свою очередь, моделирует взаимосвязь между плейлистом и песней.
Рисунок 1. Диаграмма классов отношений в примере приложения для потоковой передачи музыки.

Если в вашем наборе есть еще таблицы, создайте класс для моделирования связи между каждой оставшейся таблицей и классом связей, который моделирует связи между всеми предыдущими таблицами. Это создаст цепочку вложенных связей между всеми таблицами, к которым вы хотите обращаться с запросами.

Наконец, добавьте в класс DAO метод, предоставляющий доступ к функции запроса, необходимой вашему приложению. Для выполнения нескольких запросов этому методу требуется Room, поэтому добавьте аннотацию @Transaction , чтобы вся операция выполнялась атомарно:

Котлин 

@Transaction
@Query("SELECT * FROM User")
fun getUsersWithPlaylistsAndSongs(): List<UserWithPlaylistsAndSongs>

Java 

@Transaction
@Query("SELECT * FROM User")
public List<UserWithPlaylistsAndSongs> getUsersWithPlaylistsAndSongs();