Praca z listami danych

Uzyskiwanie odniesienia do bazy danych

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

DatabaseReference ref = FirebaseDatabase.instance.ref();

Odczytywanie i zapisywanie list

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 odniesienia Firebase dodawany jest nowy element podrzędny. Dzięki używaniu tych automatycznie generowanych kluczy do każdego nowego elementu na liście kilku klientów może jednocześnie dodawać elementy podrzędne w 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ć odniesienia do nowych danych zwróconego przez metodę push(), aby uzyskać wartość automatycznie wygenerowanego klucza elementu podrzędnego lub ustawić dane dla elementu podrzędnego. Właściwość .key odniesienia push() zawiera automatycznie wygenerowany klucz.

Możesz użyć tych automatycznie wygenerowanych 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ń podrzędnych

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

Każde z tych zdarzeń może być przydatne 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 przydatne jest nasłuchiwanie zdarzeń wartości w odniesieniu do listy.

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

Nawet jeśli zapytanie znajdzie tylko 1 pasujący element, migawka nadal będzie listą, ale będzie zawierać tylko 1 element. Aby uzyskać dostęp do elementu, musisz iterować 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 ramach jednej operacji, zamiast nasłuchiwać dodatkowych zdarzeń dodania elementu 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ż filtrować posortowany wynik do określonej liczby wyników lub zakresu kluczy lub wartości.

Sortowanie danych

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

W danym momencie możesz używać tylko 1 metody sortowania. Wywołanie metody sortowania kilka razy w tym samym zapytaniu spowoduje błąd.

Poniższy przykład pokazuje, jak można 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 to zapytanie, które w połączeniu z detektorem elementu podrzędnego synchronizuje klienta z postami użytkownika ze ścieżki w bazie danych na podstawie jego identyfikatora użytkownika, posortowanymi według liczby gwiazdek otrzymanych przez każdy post. Ta technika używania identyfikatorów jako kluczy indeksu jest nazywana zwielokrotnieniem wyjściowym danych. Więcej informacji znajdziesz w artykule Struktura bazy danych.

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

"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 posortować elementy listy według wartości zagnieżdżonych pod kluczem metrics, określają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 tym, jak sortowane są inne typy danych, zobacz Jak sortowane są dane zapytań.

Filtrowanie danych

Aby filtrować dane, możesz połączyć dowolną z metod limitu lub zakresu z metodą sortowania podczas tworzenia zapytania.

W przeciwieństwie do metod sortowania możesz łączyć ze sobą kilka funkcji limitu lub zakresu. Na przykład możesz 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 przypadku danego zdarzenia. Jeśli na przykład użyjesz limitToFirst() do ustawienia limitu 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.

Gdy elementy się zmieniają, otrzymujesz zdarzenia onChildAdded dla elementów, które wchodzą w zakres zapytania, oraz zdarzenia onChildRemoved dla elementów, które z niego wypadają, tak aby łączna liczba elementów wynosiła 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, musisz dołączyć do niego detektor.

Filtrowanie według klucza lub wartości

Za pomocą metod startAt(), startAfter(), endAt(), endBefore() i equalTo() możesz wybrać dowolne punkty początkowe, końcowe i równoważności dla zapytań. Może to być przydatne do paginacji danych lub znajdowania elementów z elementami podrzędnymi o określonej wartości.

Jak sortowane są dane zapytań

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

orderByChild

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

1. Najpierw elementy podrzędne z wartością null dla określonego klucza elementu podrzędnego.
2. Następnie elementy podrzędne z wartością false dla określonego klucza elementu podrzędnego. Jeśli kilka elementów podrzędnych ma wartość false, są one sortowane leksykograficznie według klucza.
3. Następnie elementy podrzędne z wartością true dla określonego klucza elementu podrzędnego przychodzą następne. Jeśli kilka elementów podrzędnych ma wartość true, są one sortowane leksykograficznie według klucza.
4. Następnie 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ą dla określonego węzła podrzędnego, są one sortowane według klucza.
5. Po liczbach występują ciągi znaków, które są sortowane leksykograficznie w kolejności rosnącej. Jeśli kilka elementów podrzędnych ma tę samą wartość dla określonego węzła podrzędnego, są one sortowane leksykograficznie według klucza.
6. Na końcu występują obiekty, które są sortowane leksykograficznie według klucza w kolejności rosnącej.

orderByKey

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

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

orderByValue

Gdy używasz orderByValue(), elementy podrzędne są sortowane według ich wartości. Kryteria sortowania są takie same jak w przypadku orderByChild(), z tym że zamiast wartości określonego klucza elementu 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ąć pojedynczy detektor, przekazując go jako parametr do off(). Wywołanie off() w lokalizacji bez argumentów spowoduje usunięcie wszystkich detektorów w tej lokalizacji.

Wywołanie off() w detektorze nadrzędnym nie powoduje automatycznego usunięcia detektorów zarejestrowanych w jego węzłach podrzędnych. Aby usunąć wywołanie zwrotne, należy też wywołać off() w detektorach podrzędnych.

Dalsze kroki

• Dowiedz się, jak strukturyzować dane
• Przechowuj dane offline