Praca z listami danych

Pobieranie odniesienia do bazy danych

Aby odczytywać lub zapisywać dane w bazie danych, musisz mieć instancję DatabaseReference:

DatabaseReference ref = FirebaseDatabase.instance.ref();

Czytanie i pisanie list

Dołącz do listy danych

Aby dołączać dane do listy w aplikacji wielostanowiskowej, użyj metody push(). Metoda push() generuje unikalny klucz za każdym razem, gdy do określonego odwołania Firebase jest dodawany nowy element podrzędny. Dzięki użyciu tych automatycznie wygenerowanych kluczy dla każdego nowego elementu na liście kilka klientów może dodawać elementy podrzędne do tej samej lokalizacji w tym samym czasie bez konfliktów zapisu. Unikalny klucz wygenerowany przez funkcję push() opiera się na sygnaturze czasowej, dzięki czemu elementy listy są automatycznie sortowane chronologicznie.

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

Możesz używać tych automatycznie generowanych kluczy, aby uprościć spłaszczenie struktury danych. Więcej informacji znajdziesz w przykładzie rozgałęzienia danych.

Na przykład push() może służyć do dodawania nowych wpisów do listy wpisów w aplikacji społecznościowej:

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

Nasłuchiwanie zdarzeń podrzędnych

Zdarzenia podrzędne są wywoływane w odpowiedzi na określone operacje, które są wykonywane przez elementy podrzędne węzła w wyniku operacji, np. dodania nowego elementu podrzędnego przy użyciu metody push() lub aktualizacji elementu podrzędnego przy użyciu metody update().

Zdarzenie Typowe zastosowanie
onChildAdded pobierać listy elementów lub słuchać dodanych elementów na liście; To zdarzenie jest wywoływane raz dla każdego istniejącego elementu podrzędnego, a następnie za każdym razem, gdy do określonej ścieżki dodajesz nowy element podrzędny. Słuchacz otrzymuje zrzut zawierający nowe dane dziecka.
onChildChanged Słuchaj zmian elementów na liście. To zdarzenie jest wywoływane za każdym razem, gdy węzeł podrzędny zostanie zmodyfikowany. Obejmuje to: wszelkie modyfikacje potomków węzła podrzędnego. Zrzut przesłany do odbiornika zdarzeń zawiera zaktualizowane dane dotyczące podrzędnego elementu.
onChildRemoved Słuchaj, czy elementy są usuwane z listy. To zdarzenie jest wyzwalane po usunięciu natychmiastowego elementu podrzędnego.Zrzut przekazany do bloku wywołania zwrotnego zawiera dane usuniętego elementu podrzędnego.
onChildMoved Słuchaj 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 elementów (na podstawie bieżącej metody sortowania).

Każdy z nich może być przydatny do monitorowania zmian w określonym węźle w bazie danych. Na przykład aplikacja do obsługi blogów społecznościowych może wykorzystywać te metody razem do monitorowania aktywności w komentarzach do posta, jak w tym przykładzie:

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

Chociaż wykrywanie zdarzeń podrzędnych jest zalecanym sposobem odczytu list danych, w niektórych sytuacjach przydatne jest wykrywanie zdarzeń wartości na liście referencyjnej.

Dołączenie listenera value do listy danych spowoduje zwrócenie całej listy danych jako pojedynczego snapshota, który możesz następnie przewijać, aby uzyskać dostęp do poszczególnych elementów.

Nawet jeśli dla zapytania występuje tylko jedno dopasowanie, zrzut nadal pozostaje listą, zawiera tylko 1 element. Aby uzyskać dostęp do elementu, musisz wykonać pętlę na 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ń dodanych przez wydawcę podrzędnego.

Sortowanie i filtrowanie danych

Za pomocą klasy Query możesz pobierać dane posortowane według klucza, wartości lub wartości elementu podrzędnego. Możesz też ograniczyć liczbę wyników do określonej liczby lub do zakresu kluczy bądź wartości.

Sortowanie danych

Aby pobrać posortowane dane, najpierw określ jedną z metod sortowania, która określi sposób sortowania wyników:

Metoda Wykorzystanie
orderByChild() Uporządkuj wyniki według wartości określonego klucza podrzędnego lub ścieżki podrzędnej ujętej w nawiasach.
orderByKey() Uporządkuj wyniki według kluczy podrzędnych.
orderByValue() Porządkuj wyniki według wartości elementów podrzędnych.

W danym momencie możesz używać tylko jednej metody sortowania. Wielokrotne wywołanie metody „order by by” w tym samym zapytaniu powoduje błąd.

Ten 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");

Określa ono zapytanie, które po połączeniu z podrzędnym odbiorcą synchronizuje klienta z postami użytkownika z ścieżki w bazie danych na podstawie jego identyfikatora użytkownika, posortowanymi według liczby gwiazdek przypisanych do każdego posta. Ta technika używania identyfikatorów jako kluczy indeksu jest nazywana rozpowszechnianiem danych. Więcej informacji na ten temat znajdziesz w artykule Uporządkowanie bazy danych.

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

"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 tym przypadku możemy uporządkować elementy listy według wartości zagnieżdżonych pod kluczem metrics, podając ścieżkę względną do zagnieżdżonego elementu podrzędnego w wywołaniu orderByChild().

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

Więcej informacji o porządkowaniu innych typów danych znajdziesz w artykule Porządkowanie danych zapytań.

Filtrowanie danych

Aby filtrować dane, podczas tworzenia zapytania możesz połączyć dowolną metodę limit lub range z metodą order-by.

Metoda Wykorzystanie
limitToFirst() Określa maksymalną liczbę elementów do zwrócenia z początku uporządkowanej listy wyników.
limitToLast() Określa maksymalną liczbę elementów do zwrócenia z końca posortowanej listy wyników.
startAt() Zwraca elementy, których wartość jest większa lub równa określonemu kluczowi lub wartości, w zależności od wybranej metody sortowania.
startAfter() Zwraca elementy większe niż określony klucz lub wartość, w zależności od wybranej metody sortowania.
endAt() Zwraca elementy, których klucz lub wartość jest mniejsza lub równa określonemu kluczowi lub wartości, w zależności od wybranej metody sortowania.
endBefore() Zwraca elementy, które są mniejsze niż określony klucz lub wartość, w zależności od wybranej metody sortowania.
equalTo() Zwraca elementy o wartości określonej w kluczu lub wartości, w zależności od wybranej metody sortowania.

W przeciwieństwie do metod porządkowania według kolumny możesz łączyć wiele funkcji limit i zakres. Możesz np. połączyć metody startAt() i endAt(), aby ograniczyć wyniki do określonego zakresu wartości.

Ograniczanie liczby wyników

Za pomocą metod limitToFirst() i limitToLast() możesz ustawić maksymalną liczbę elementów podrzędnych, które mają być synchronizowane w danym zdarzeniu. 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 wywoływane jest zdarzenie onChildAdded.

Gdy elementy się zmieniają, otrzymujesz zdarzenia onChildAdded dotyczące elementów, które wchodzą do zapytania, oraz zdarzenia onChildRemoved dotyczące elementów, które z niego wypadają, dzięki czemu łączna liczba pozostaje na poziomie 100.

Ten 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);

W tym przykładzie zdefiniowano tylko zapytanie. Aby dane mogły być synchronizowane, musi być dołączony odbiorca.

Filtruj według klucza lub wartości

Aby wybrać dowolne punkty początkowe, końcowe i równoważne zapytań, możesz użyć znaczników startAt(), startAfter(), endAt(), endBefore() i equalTo(). Przydaje się to przy dzieleniu danych na strony lub wyszukiwaniu elementów z elementami podrzędnymi, które mają określoną wartość.

Sposób sortowania danych zapytania

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

orderByChild

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

  1. Najpierw są wyświetlane elementy podrzędne, dla których wartość atrybutu podrzędnego null jest równa null.
  2. Następne są elementy podrzędne z wartością false określonego klucza podrzędnego. Jeśli wiele elementów podrzędnych ma wartość false, są one sortowane alfabetycznie według klucza.
  3. Następne są elementy podrzędne z wartością true określonego klucza podrzędnego. Jeśli wiele elementów podrzędnych ma wartość true, są one sortowane alfabetycznie według klucza.
  4. Następnie pojawiają się elementy z wartością liczbową, posortowane w kolejności rosnącej. Jeśli wiele elementów podrzędnych ma tę samą wartość numeryczną w przypadku określonego węzła podrzędnego, są one sortowane według klucza.
  5. Ciągi znaków znajdują się po liczbach i są sortowane leksykograficznie w kolejności rosnącej. Jeśli wiele elementów podrzędnych ma tę samą wartość w wybranym węźle podrzędnym, są one uporządkowane alfabetycznie według klucza.
  6. Obiekty znajdują się na końcu i są posortowane leksykograficznie według klucza w kolejności rosnącej.

orderByKey

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

  1. Najpierw wyświetlane są dzieci, których klucz można przeanalizować jako 32-bitową liczbę całkowitą, w kolejności rosnącej.
  2. Kolejne są elementy podrzędne z wartością ciągu znaków jako kluczem, posortowane leksykograficznie w kolejności rosnącej.

orderByValue

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

Odłącz detektory

Callbacki są usuwane przez wywołanie metody off() w przypadku odwołania do bazy danych Firebase.

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

Wywołanie metody off() w słuchaczu nadrzędnym nie powoduje automatycznego usuwania słuchaczy zarejestrowanych w podrzędnych węzłach. Aby usunąć wywołanie zwrotne, musisz też wywołać metodę off() w słuchaczach podrzędnych.

Dalsze kroki