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 należy zdefiniować 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 przedstawia klasy reprezentujące te encje oraz tabelę odniesień krzyżowych dla relacji wiele do wielu między listami odtwarzania a utworami:

Kotlin

@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;
}

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 przedstawia klasę PlaylistWithSongs, która modeluje relację wiele do wielu między klasą elementu Playlist a klasą elementu Song:

Kotlin

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;
}

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 przedstawia klasę UserWithPlaylistsAndSongs, która modeluje relację jeden do wielu między klasą elementu User a klasą relacji PlaylistWithSongs:

Kotlin

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;
}

Klasa UserWithPlaylistsAndSongs pośrednio modeluje relacje między wszystkimi trzema klasami encji: User, Playlist i Song. Ilustruje to rysunek 1.

UserWithPlaylistsAndSongs modeluje relację między użytkownikiem a playlistą PlaylistWithSongs, która z kolei modeluje relację między playlistą a utworem.
Rysunek 1. Diagram klas relacji w przykładzie aplikacji do odtwarzania strumieniowego muzyki.

Jeśli w zbiorze jest więcej tabel, utwórz klasę, która modeluje relację między każdą pozostałą tabelą a klasą relacji, która modeluje relacje między wszystkimi poprzednimi tabelami. Spowoduje to utworzenie łańcucha relacji zagnieżdżonych między wszystkimi tabelami, do których chcesz wysłać zapytanie.

Na koniec dodaj do klasy DAO metodę, która udostępnia funkcję zapytania potrzebną aplikacji. Ta metoda wymaga od Room uruchomienia wielu zapytań, dlatego dodaj @Transaction adnotację, aby cała operacja była wykonywana niepodzielnie:

Kotlin

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

Java

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