Praca z listami danych

Uzyskaj odniesienie do bazy danych

Aby odczytać lub zapisać dane z bazy danych, potrzebujesz instancji DatabaseReference :

DatabaseReference ref = FirebaseDatabase.instance.ref();

Czytanie i pisanie list

Dołącz do listy danych

Użyj metody push() , aby dołączyć dane do listy w aplikacjach obsługujących wielu użytkowników. Metoda push() generuje unikalny klucz za każdym razem, gdy do określonego odniesienia Firebase dodawany jest nowy element podrzędny. Używając automatycznie generowanych kluczy dla każdego nowego elementu na liście, kilku klientów może dodać elementy podrzędne do tej samej lokalizacji w tym samym czasie, bez konfliktów zapisu. Unikalny klucz generowany przez push() opiera się na znaczniku czasu, więc elementy listy są automatycznie porządkowane chronologicznie.

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

Możesz użyć tych automatycznie wygenerowanych kluczy, aby uprościć spłaszczanie struktury danych. Aby uzyskać więcej informacji, zobacz przykład rozłożenia danych .

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

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

Słuchaj wydarzeń podrzędnych

Zdarzenia podrzędne są wyzwalane w odpowiedzi na określone operacje, które mają miejsce na elementach podrzędnych węzła w wyniku operacji, takiej jak dodanie nowego elementu podrzędnego za pomocą metody push() lub aktualizacja elementu podrzędnego za pomocą metody update() .

Wydarzenie Typowe użycie
onChildAdded Pobieraj listy elementów lub słuchaj dodatków do listy elementów. To zdarzenie jest wyzwalane raz dla każdego istniejącego elementu podrzędnego, a następnie ponownie za każdym razem, gdy do określonej ścieżki dodawane jest nowe dziecko. Do słuchacza przekazywana jest migawka zawierająca dane nowego dziecka.
onChildChanged Słuchaj zmian w elementach na liście. To zdarzenie jest wyzwalane za każdym razem, gdy modyfikuje się węzeł podrzędny. Obejmuje to wszelkie modyfikacje elementów podrzędnych węzła podrzędnego. Migawka przekazana do detektora zdarzeń zawiera zaktualizowane dane elementu podrzędnego.
onChildRemoved Posłuchaj, czy elementy są usuwane z listy. To zdarzenie jest wywoływane w przypadku usunięcia bezpośredniego dziecka. Migawka przekazana do bloku wywołania zwrotnego zawiera dane usuniętego dziecka.
onChildMoved Słuchaj zmian w kolejności elementów na uporządkowanej liście. Zdarzenia onChildMoved zawsze następują po zdarzeniu onChildChanged, które spowodowało zmianę kolejności elementu (w oparciu o bieżącą metodę zamawiania).

Każdy z nich razem może być przydatny 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 łącznie do monitorowania aktywności w komentarzach do wpisu, 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.
});

Słuchaj wydarzeń wartościowych

Chociaż nasłuchiwanie zdarzeń podrzędnych jest zalecanym sposobem odczytywania list danych, w niektórych sytuacjach przydatne jest nasłuchiwanie zdarzeń wartościowych na liście.

Dołączenie detektora value do listy danych spowoduje zwrócenie całej listy danych w postaci pojedynczej migawki, którą można następnie zapętlić, aby uzyskać dostęp do poszczególnych elementów podrzędnych.

Nawet jeśli zapytanie odpowiada tylko jednemu dopasowaniu, zrzut ekranu nadal jest listą; zawiera tylko jeden element. Aby uzyskać dostęp do elementu, musisz zapętlić wynik:

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 jednej operacji, zamiast nasłuchiwać dodatkowych zdarzeń dodanych podrzędnie.

Sortowanie i filtrowanie danych

Za pomocą klasy Query można pobierać dane posortowane według klucza, wartości lub wartości elementu podrzędnego. Możesz także filtrować posortowane wyniki według określonej liczby wyników lub zakresu kluczy lub wartości.

Sortuj dane

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

metoda Stosowanie
orderByChild() Uporządkuj wyniki według wartości określonego klucza podrzędnego lub zagnieżdżonej ścieżki podrzędnej.
orderByKey() Uporządkuj wyniki według kluczy podrzędnych.
orderByValue() Uporządkuj wyniki według wartości podrzędnych.

Można używać tylko jednej metody zamawiania na raz. Wielokrotne wywołanie metody sortowania według tego samego zapytania powoduje błąd.

Poniższy przykład ilustruje sposób pobrania listy 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 to zapytanie, które w połączeniu z odbiornikiem podrzędnym synchronizuje klienta z postami użytkownika ze ścieżki w bazie danych na podstawie jego identyfikatora użytkownika, uporządkowanego według liczby gwiazdek otrzymanych przez każdy post. Ta technika używania identyfikatorów jako kluczy indeksujących nazywa się rozdzielaniem danych, możesz przeczytać więcej na ten temat w Strukturuj swoją bazę danych .

Wywołanie metody orderByChild() określa klucz podrzędny, według którego mają zostać uporządkowane wyniki. W tym przypadku posty są sortowane według wartości odpowiedniego elementu podrzędnego "starCount" . Zapytania można także porządkować według zagnieżdżonych elementów podrzędnych, 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 w kluczu metrics , określając względną ścieżkę do zagnieżdżonego elementu podrzędnego w naszym wywołaniu orderByChild() .

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

Więcej informacji na temat porządkowania innych typów danych można znaleźć w artykule Jak uporządkowane są dane zapytań .

Filtrowanie danych

Aby filtrować dane, podczas konstruowania zapytania możesz połączyć dowolną metodę limitu lub zakresu z metodą porządkowania.

metoda Stosowanie
limitToFirst() Ustawia maksymalną liczbę elementów do zwrócenia od początku uporządkowanej listy wyników.
limitToLast() Ustawia maksymalną liczbę elementów zwracanych z końca uporządkowanej listy wyników.
startAt() Zwróć elementy większe lub równe określonemu kluczowi lub wartości, w zależności od wybranej metody sortowania.
startAfter() Zwróć pozycje większe niż określony klucz lub wartość, w zależności od wybranej metody sortowania.
endAt() Zwróć produkty mniejsze lub równe określonemu kluczowi lub wartości, w zależności od wybranej metody zamawiania.
endBefore() Zwróć pozycje mniejsze niż określony klucz lub wartość, w zależności od wybranej metody zamawiania.
equalTo() Zwróć pozycje równe określonemu kluczowi lub wartości, w zależności od wybranej metody sortowania.

W przeciwieństwie do metod sortowania, można łączyć wiele funkcji limitów lub zakresów. Można na przykład połączyć metody startAt() i endAt() , aby ograniczyć wyniki do określonego zakresu wartości.

Ogranicz liczbę wyników

Możesz użyć metod limitToFirst() i limitToLast() , aby ustawić maksymalną liczbę dzieci, które mają być synchronizowane dla danego zdarzenia. Na przykład, jeśli użyjesz limitToFirst() do ustawienia limitu na 100, początkowo otrzymasz tylko do 100 zdarzeń onChildAdded . Jeśli w bazie danych Firebase przechowywanych jest mniej niż 100 elementów, dla każdego elementu uruchamiane jest zdarzenie onChildAdded .

Gdy elementy się zmieniają, otrzymujesz zdarzenia onChildAdded dla elementów, które wchodzą do zapytania, oraz zdarzenia onChildRemoved dla elementów, które z niego wypadają, tak że łączna liczba pozostaje na poziomie 100.

Poniższy przykład ilustruje, jak przykładowa aplikacja do blogowania definiuje zapytanie w celu pobrania listy 100 najnowszych postów wszystkich użytkowników:

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

Ten przykład definiuje jedynie zapytanie, aby faktycznie zsynchronizować dane, musi mieć podłączony słuchacz .

Filtruj według klucza lub wartości

Możesz użyć startAt() , startAfter() , endAt() , endBefore() i equalTo() , aby wybrać dowolne punkty początkowe, końcowe i równoważne dla zapytań. Może to być przydatne do dzielenia danych na strony lub znajdowania elementów z elementami podrzędnymi, które mają określoną wartość.

Sposób uporządkowania danych zapytania

W tej sekcji wyjaśniono, w jaki sposób dane są sortowane według każdej metody porządkowania w klasie Query .

orderByChild

Podczas korzystania z orderByChild() dane zawierające określony klucz podrzędny są porządkowane w następujący sposób:

  1. Dzieci z wartością null dla określonego klucza podrzędnego są traktowane jako pierwsze.
  2. Następne 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ępne są dzieci z wartością true dla określonego klucza podrzędnego. Jeśli wiele elementów podrzędnych ma wartość true , są one sortowane leksykograficznie według klucza.
  4. Następne są dzieci z wartością liczbową, posortowane w kolejności rosnącej. Jeśli wiele elementów podrzędnych ma tę samą wartość liczbową dla 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 elementó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 są sortowane leksykograficznie według kluczy w kolejności rosnącej.

orderByKey

Jeśli do sortowania danych używana jest orderByKey() , dane są zwracane w kolejności rosnącej według klucza.

  1. Na pierwszym miejscu znajdują się dzieci z kluczem, który można przeanalizować jako 32-bitową liczbę całkowitą, posortowane w kolejności rosnącej.
  2. Następne są dzieci, których kluczem jest wartość ciągu, posortowane leksykograficznie w kolejności rosnącej.

orderByValue

Podczas korzystania z orderByValue() elementy podrzędne są porządkowane według ich wartości. Kryteria porządkowania są takie same jak w przypadku orderByChild() , z tą różnicą, że zamiast wartości określonego klucza podrzędnego używana jest wartość węzła.

Odłącz słuchaczy

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

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

Wywołanie funkcji off() na odbiorniku nadrzędnym nie powoduje automatycznego usunięcia odbiorników zarejestrowanych w jego węzłach podrzędnych; off() należy również wywołać na wszystkich odbiornikach podrzędnych, aby usunąć wywołanie zwrotne.

Następne kroki