Praca z listami danych

Pobieranie referencji do bazy danych

Aby odczytywać lub zapisywać dane w bazie danych, potrzebujesz instancji DatabaseReference:

DatabaseReference ref = FirebaseDatabase.instance.ref();

Listy czytelnicze i listy do pisania

Dołączanie do listy danych

Użyj metody push(), aby dołączyć dane do listy w aplikacjach wielodostępnych. Metoda push() generuje unikalny klucz za każdym razem, gdy do określonego odwołania Firebase dodawane jest nowe dziecko. Dzięki używaniu tych automatycznie generowanych kluczy dla każdego nowego elementu na liście kilku klientów może jednocześnie dodawać elementy podrzędne do tej samej lokalizacji bez konfliktów zapisu. Unikalny klucz generowany przez push() jest oparty na sygnaturze czasowej, więc elementy listy są automatycznie uporządkowane chronologicznie.

Możesz użyć odwołania do nowych danych zwróconych przez metodę push(), aby uzyskać wartość automatycznie wygenerowanego klucza elementu podrzędnego lub ustawić dane dla elementu podrzędnego. Właściwość .key odwołania push() zawiera wygenerowany automatycznie klucz.

Możesz używać tych wygenerowanych automatycznie kluczy, aby uprościć spłaszczanie struktury danych. Więcej informacji znajdziesz w przykładzie zwielokrotnienia wyjściowego danych.

Na przykład push() można użyć do dodania nowego posta do listy postów w aplikacji społecznościowej:

DatabaseReference postListRef = FirebaseDatabase.instance.ref("posts");
DatabaseReference newPostRef = postListRef.push();
newPostRef.set({
  // ...
});

Nasłuchiwanie zdarzeń dotyczących dziecka

Zdarzenia podrzędne są wywoływane w odpowiedzi na określone operacje wykonywane na elementach podrzędnych węzła, np. dodanie nowego elementu podrzędnego za pomocą metody push() lub zaktualizowanie elementu podrzędnego za pomocą metody update().

Zdarzenie Typowe zastosowanie
onChildAdded pobierać listy elementów lub nasłuchiwać dodawania elementów do listy; To zdarzenie jest wywoływane raz dla każdego istniejącego elementu podrzędnego, a potem ponownie za każdym razem, gdy do określonej ścieżki zostanie dodany nowy element podrzędny. Do odbiorcy przekazywany jest zrzut zawierający dane nowego elementu podrzędnego.
onChildChanged Nasłuchiwanie zmian w elementach na liście. To zdarzenie jest wywoływane za każdym razem, gdy węzeł podrzędny zostanie zmodyfikowany. Obejmuje to wszelkie modyfikacje elementów podrzędnych węzła podrzędnego. Zrzut przekazany do detektora zdarzeń zawiera zaktualizowane dane dotyczące elementu podrzędnego.
onChildRemoved Nasłuchiwanie elementów usuwanych z listy. To zdarzenie jest wywoływane, gdy zostanie usunięty bezpośredni element podrzędny.Zrzut przekazywany do bloku wywołania zwrotnego zawiera dane usuniętego elementu podrzędnego.
onChildMoved Nasłuchiwanie zmian kolejności elementów na liście uporządkowanej. Zdarzenia onChildMoved zawsze następują po zdarzeniu onChildChanged, które spowodowało zmianę kolejności elementu (na podstawie bieżącej metody sortowania).

Każda z tych funkcji może być przydatna do nasłuchiwania zmian w określonym węźle w bazie danych. Na przykład aplikacja do blogowania społecznościowego może używać tych metod razem do monitorowania aktywności w komentarzach do posta, jak pokazano poniżej:

final commentsRef = FirebaseDatabase.instance.ref("post-comments/$postId");
commentsRef.onChildAdded.listen((event) {
  // A new comment has been added, so add it to the displayed list.
});
commentsRef.onChildChanged.listen((event) {
  // A comment has changed; use the key to determine if we are displaying this
  // comment and if so displayed the changed comment.
});
commentsRef.onChildRemoved.listen((event) {
  // A comment has been removed; use the key to determine if we are displaying
  // this comment and if so remove it.
});

Nasłuchiwanie zdarzeń wartości

Nasłuchiwanie zdarzeń podrzędnych jest zalecanym sposobem odczytywania list danych, ale w niektórych sytuacjach przydaje się nasłuchiwanie zdarzeń wartości w odniesieniu do listy.

Dołączenie odbiornika value do listy danych spowoduje zwrócenie całej listy danych jako pojedynczej migawki, po której można iterować, aby uzyskać dostęp do poszczególnych elementów podrzędnych.

Nawet jeśli zapytanie zwraca tylko 1 wynik, migawka jest nadal listą, tylko zawiera 1 element. Aby uzyskać dostęp do elementu, musisz przejść w pętli po wyniku:

myTopPostsQuery.onValue.listen((event) {
  for (final child in event.snapshot.children) {
    // Handle the post.
  }
}, onError: (error) {
  // Error.
});

Ten wzorzec może być przydatny, gdy chcesz pobrać wszystkie elementy podrzędne listy w ramach jednej operacji, zamiast nasłuchiwać dodatkowych zdarzeń dodania elementu podrzędnego.

Sortowanie i filtrowanie danych

Możesz użyć klasy Query, aby pobrać dane posortowane według klucza, wartości lub wartości elementu podrzędnego. Możesz też filtrować posortowane wyniki, aby uzyskać określoną liczbę wyników lub zakres kluczy lub wartości.

Sortowanie danych

Aby pobrać posortowane dane, zacznij od określenia jednej z metod sortowania, aby określić sposób sortowania wyników:

Metoda Wykorzystanie
orderByChild() Wyniki można uporządkować według wartości określonego klucza podrzędnego lub zagnieżdżonej ścieżki podrzędnej.
orderByKey() Sortuj wyniki według kluczy podrzędnych.
orderByValue() Porządkuj wyniki według wartości elementów podrzędnych.

Możesz używać tylko jednej metody zamawiania naraz. Wywołanie metody order-by kilka razy w tym samym zapytaniu powoduje błąd.

Poniższy przykład pokazuje, jak pobrać listę najpopularniejszych postów użytkownika posortowanych według liczby gwiazdek:

final myUserId = FirebaseAuth.instance.currentUser?.uid;
final topUserPostsRef = FirebaseDatabase.instance
    .ref("user-posts/$myUserId")
    .orderByChild("starCount");

Definiuje zapytanie, które w połączeniu z elementem nasłuchującym podrzędnym synchronizuje klienta z postami użytkownika z ścieżki w bazie danych na podstawie jego identyfikatora, uporządkowanymi według liczby gwiazdek, które otrzymał każdy post. Technika używania identyfikatorów jako kluczy indeksu nazywa się rozgałęzianiem danych. Więcej informacji znajdziesz w artykule Struktura bazy danych.

Wywołanie metody orderByChild() określa klucz podrzędny, według którego mają być uporządkowane wyniki. W tym przypadku posty są sortowane według wartości odpowiedniego elementu podrzędnego "starCount". Zapytania można też porządkować według zagnieżdżonych elementów podrzędnych, jeśli masz dane w takim formacie:

"posts": {
  "ts-functions": {
    "metrics": {
      "views" : 1200000,
      "likes" : 251000,
      "shares": 1200,
    },
    "title" : "Why you should use TypeScript for writing Cloud Functions",
    "author": "Doug",
  },
  "android-arch-3": {
    "metrics": {
      "views" : 900000,
      "likes" : 117000,
      "shares": 144,
    },
    "title" : "Using Android Architecture Components with Firebase Realtime Database (Part 3)",
    "author": "Doug",
  }
},

W takim przypadku możemy uporządkować elementy listy według wartości zagnieżdżonych pod kluczem metrics, podając względną ścieżkę do zagnieżdżonego elementu podrzędnego w wywołaniu orderByChild().

final mostViewedPosts =
    FirebaseDatabase.instance.ref('posts').orderByChild('metrics/views');

Więcej informacji o kolejności innych typów danych znajdziesz w artykule Kolejność danych zapytań.

Filtrowanie danych

Aby filtrować dane, możesz łączyć dowolne metody ograniczania lub zakresu z metodą sortowania podczas tworzenia zapytania.

Metoda Wykorzystanie
limitToFirst() Określa maksymalną liczbę elementów do zwrócenia od początku uporządkowanej listy wyników.
limitToLast() Ustawia maksymalną liczbę elementów do zwrócenia z końca uporządkowanej listy wyników.
startAt() Zwraca elementy o wartości klucza lub wartości większej lub równej określonej wartości, w zależności od wybranej metody sortowania.
startAfter() Zwraca elementy o wartości większej niż określony klucz lub wartość, w zależności od wybranej metody sortowania.
endAt() Zwraca produkty o wartości klucza lub wartości mniejszej lub równej określonej wartości, w zależności od wybranej metody sortowania.
endBefore() Zwraca produkty o wartości mniejszej niż określony klucz lub wartość, w zależności od wybranej metody sortowania.
equalTo() Zwraca elementy równe podanemu kluczowi lub wartości w zależności od wybranej metody sortowania.

W odróżnieniu od metod sortowania możesz łączyć ze sobą wiele funkcji limitu lub zakresu. Możesz na przykład połączyć metody startAt()endAt(), aby ograniczyć wyniki do określonego zakresu wartości.

Ograniczanie liczby wyników

Za pomocą metod limitToFirst()limitToLast() możesz ustawić maksymalną liczbę dzieci, które mają być synchronizowane w przypadku danego wydarzenia. Jeśli na przykład użyjesz funkcji limitToFirst(), aby ustawić limit 100, początkowo otrzymasz tylko do 100 zdarzeń onChildAdded. Jeśli w bazie danych Firebase masz mniej niż 100 elementów, dla każdego z nich zostanie wywołane zdarzenie onChildAdded.

W miarę zmian otrzymujesz zdarzenia onChildAdded dotyczące elementów, które pojawiają się w zapytaniu, oraz zdarzenia onChildRemoved dotyczące elementów, które z niego znikają, dzięki czemu łączna liczba elementów pozostaje na poziomie 100.

Poniższy przykład pokazuje, jak przykładowa aplikacja do blogowania definiuje zapytanie, aby pobrać listę 100 najnowszych postów wszystkich użytkowników:

final recentPostsRef = FirebaseDatabase.instance.ref('posts').limitToLast(100);

Ten przykład definiuje tylko zapytanie. Aby zsynchronizować dane, musi mieć dołączony odbiornik.

Filtrowanie według klucza lub wartości

Możesz użyć zasad startAt(), startAfter(), endAt(), endBefore()equalTo(), aby wybrać dowolne punkty początkowe, końcowe i równoważne dla zapytań. Może to być przydatne w przypadku stronicowania danych lub wyszukiwania elementów podrzędnych o określonej wartości.

Sposób uporządkowania danych zapytania

W tej sekcji wyjaśniamy, jak dane są sortowane za pomocą każdej z metod sortowania w klasie Query.

orderByChild

Gdy używasz orderByChild(), dane zawierające określony klucz podrzędny są uporządkowane w ten sposób:

  1. Najpierw wyświetlane są dzieci z wartością null dla określonego klucza dziecka.
  2. Następnie wyświetlane są dzieci z wartością false dla określonego klucza podrzędnego. Jeśli wiele elementów podrzędnych ma wartość false, są one sortowane leksykograficznie według klucza.
  3. Następnie wyświetlane są dzieci z wartością true dla określonego klucza podrzędnego. Jeśli kilka elementów podrzędnych ma wartość true, są one sortowane leksykograficznie według klucza.
  4. Następnie pojawiają się elementy podrzędne z wartością liczbową, posortowane w kolejności rosnącej. Jeśli kilka elementów podrzędnych ma tę samą wartość liczbową w przypadku określonego węzła podrzędnego, są one sortowane według klucza.
  5. Ciągi znaków występują po liczbach i są sortowane leksykograficznie w kolejności rosnącej. Jeśli wiele węzłów podrzędnych ma tę samą wartość dla określonego węzła podrzędnego, są one uporządkowane leksykograficznie według klucza.
  6. Obiekty są umieszczane na końcu i sortowane leksykograficznie według klucza w kolejności rosnącej.

orderByKey

Gdy używasz symbolu orderByKey() do sortowania danych, są one zwracane w kolejności rosnącej według klucza.

  1. Najpierw pojawiają się dzieci z kluczem, który można przeanalizować jako 32-bitową liczbę całkowitą, posortowane w kolejności rosnącej.
  2. Następnie pojawiają się dzieci z wartością ciągu znaków jako kluczem, posortowane leksykograficznie w kolejności rosnącej.

orderByValue

W przypadku korzystania z orderByValue() dzieci są uporządkowane według wartości. Kryteria sortowania są takie same jak w przypadku orderByChild(), z tym że zamiast wartości określonego klucza podrzędnego używana jest wartość węzła.

Odłączanie detektorów

Wywołania zwrotne są usuwane przez wywołanie metody off() w odniesieniu do bazy danych Firebase.

Możesz usunąć pojedynczego odbiorcę, przekazując go jako parametr do funkcji off(). Wywołanie funkcji off() w lokalizacji bez argumentów powoduje usunięcie wszystkich słuchaczy w tej lokalizacji.

Wywołanie off() na odbiorniku rodzica nie powoduje automatycznego usunięcia odbiorników zarejestrowanych w jego węzłach podrzędnych. Aby usunąć wywołanie zwrotne, należy też wywołać off() na wszystkich odbiornikach podrzędnych.

Dalsze kroki