Definiowanie i wyszukiwanie zagnieżdżonych relacji

Czasami może być konieczne wysłanie zapytania do zbioru 3 lub więcej tabel, które są ze sobą powiązane. W takim przypadku definiujesz relacje zagnieżdżone między tabelami.

Załóżmy, że w przykładzie aplikacji do odtwarzania strumieniowego muzyki chcesz wysłać zapytanie do wszystkich użytkowników, wszystkich list odtwarzania każdego użytkownika i wszystkich utworów na każdej liście odtwarzania każdego użytkownika. Użytkownicy mają relację jeden do wielu z listami odtwarzania, a listy odtwarzania mają relację wiele do wielu z utworami. Poniższy przykład kodu pokazuje klasy reprezentujące te elementy oraz tabelę odniesień krzyżowych dla relacji wiele do wielu między listami odtwarzania a utworami:

@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"], indices = [Index("playlistId", "songId")])
data class PlaylistSongCrossRef(
    val playlistId: Long,
    val songId: Long
)
NestedRelationshipsSnippets.kt

Najpierw modeluj relację między 2 tabelami w zbiorze w zwykły sposób, używając klasy danych i adnotacji @Relation. Poniższy przykład pokazuje klasę PlaylistWithSongs, która modeluje relację wiele do wielu między klasą elementu Playlist a klasą elementu Song:

data class PlaylistWithSongs(
    @Embedded val playlist: Playlist,
    @Relation(
        parentColumns = ["playlistId"],
        entityColumns = ["songId"],
        associateBy = Junction(PlaylistSongCrossRef::class)
    )
    val songs: List<Song>
)
NestedRelationshipsSnippets.kt

Po zdefiniowaniu klasy danych reprezentującej tę relację utwórz kolejną klasę danych, która modeluje relację między inną tabelą ze zbioru a pierwszą klasą relacji, „zagnieżdżając” istniejącą relację w nowej. Poniższy przykład pokazuje klasę UserWithPlaylistsAndSongs, która modeluje relację jeden do wielu między klasą elementu User a klasą relacji PlaylistWithSongs:

data class UserWithPlaylistsAndSongs(
    @Embedded val user: User,
    @Relation(
        entity = Playlist::class,
        parentColumns = ["userId"],
        entityColumns = ["userCreatorId"]
    )
    val playlists: List<PlaylistWithSongs>
)
NestedRelationshipsSnippets.kt

Klasa UserWithPlaylistsAndSongs pośrednio modeluje relacje między wszystkimi 3 klasami elementów: User, Playlist i Song. Ilustruje to rysunek 1.

Jeśli zbiór zawiera więcej tabel, utwórz klasę, która modeluje relację między każdą pozostałą tabelą a poprzednią klasą relacji. Ten proces tworzy łańcuch relacji zagnieżdżonych między wszystkimi tabelami, do których chcesz wysłać zapytanie.

Na koniec dodaj funkcję do klasy obiektu umożliwiającego dostęp do danych (DAO), aby udostępnić funkcję zapytania, której potrzebuje Twoja aplikacja. Ta funkcja wymaga od Room uruchomienia wielu zapytań, więc dodaj adnotację @Transaction, aby cała operacja była niepodzielna:

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