Praca z listami danych w internecie

Pobieranie odniesienia do bazy danych

Aby móc odczytywać lub zapisywać dane z bazy danych, potrzebujesz instancji firebase.database.Reference:

Web Modular API

import { getDatabase } from "firebase/database";

const database = getDatabase();

Interfejs API internetowej przestrzeni nazw

var database = firebase.database();

Czytam i zapisuję listy

Dołącz do listy danych

Użyj metody push(), aby dołączać dane do listy w aplikacjach, które mają wielu użytkowników. 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 generowany przez funkcję push() jest oparty na sygnaturze czasowej, więc elementy listy są automatycznie porządkowane chronologicznie.

Możesz użyć odwołania do nowych danych zwróconych przez metodę push(), aby uzyskać wartość automatycznie wygenerowanego klucza wydawcy 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ć strukturę danych. Więcej informacji znajdziesz w przykładzie rozpowszechniania danych.

Za pomocą push() można na przykład dodać nowy post do listy postów w aplikacji społecznościowej:

Web Modular API

import { getDatabase, ref, push, set } from "firebase/database";

// Create a new post reference with an auto-generated id
const db = getDatabase();
const postListRef = ref(db, 'posts');
const newPostRef = push(postListRef);
set(newPostRef, {
    // ...
});

Interfejs API internetowej przestrzeni nazw

// Create a new post reference with an auto-generated id
var postListRef = firebase.database().ref('posts');
var newPostRef = postListRef.push();
newPostRef.set({
    // ...
});

Nasłuchuj 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
child_added Pobieranie list elementów lub słuchanie, czy dodano elementy do listy. 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. Detektor przekazuje zrzut zawierający dane nowego elementu podrzędnego.
child_changed Wykrywaj zmiany wprowadzone w elementach na liście. To zdarzenie jest wywoływane za każdym razem, gdy zmodyfikowany jest węzeł podrzędny. Obejmuje to wszelkie modyfikacje elementów podrzędnych węzła podrzędnego. Zrzut przekazany do detektora zdarzeń zawiera zaktualizowane dane obiektu podrzędnego.
child_removed Nasłuchuj elementów usuwanych 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.
child_moved Wykrywaj zmiany kolejności elementów na liście uporządkowanej. Zdarzenia child_moved zawsze występują po zdarzeniu child_changed, które spowodowało zmianę kolejności produktów (na podstawie bieżącej metody sortowania).

Każdy z tych elementów może być przydatny do nasłuchiwania zmian w konkretnym 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:

Web Modular API

import { getDatabase, ref, onChildAdded, onChildChanged, onChildRemoved } from "firebase/database";

const db = getDatabase();
const commentsRef = ref(db, 'post-comments/' + postId);
onChildAdded(commentsRef, (data) => {
  addCommentElement(postElement, data.key, data.val().text, data.val().author);
});

onChildChanged(commentsRef, (data) => {
  setCommentValues(postElement, data.key, data.val().text, data.val().author);
});

onChildRemoved(commentsRef, (data) => {
  deleteComment(postElement, data.key);
});

Interfejs API internetowej przestrzeni nazw

var commentsRef = firebase.database().ref('post-comments/' + postId);
commentsRef.on('child_added', (data) => {
  addCommentElement(postElement, data.key, data.val().text, data.val().author);
});

commentsRef.on('child_changed', (data) => {
  setCommentValues(postElement, data.key, data.val().text, data.val().author);
});

commentsRef.on('child_removed', (data) => {
  deleteComment(postElement, data.key);
});

Wykrywaj zdarzenia dotyczące wartości

Chociaż nasłuchiwanie zdarzeń podrzędnych to zalecany sposób odczytywania list danych, istnieją sytuacje, w których nasłuchiwanie zdarzeń wartości w odwołaniu do listy jest przydatne.

Dołączenie obserwatora value do listy danych spowoduje zwrócenie całej listy danych w formie pojedynczego zrzutu, który można potem zapętlić w celu uzyskania dostępu do poszczególnych elementów podrzędnych.

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 zapętlić wynik:

Web Modular API

import { getDatabase, ref, onValue } from "firebase/database";

const db = getDatabase();
const dbRef = ref(db, '/a/b/c');

onValue(dbRef, (snapshot) => {
  snapshot.forEach((childSnapshot) => {
    const childKey = childSnapshot.key;
    const childData = childSnapshot.val();
    // ...
  });
}, {
  onlyOnce: true
});

Interfejs API internetowej przestrzeni nazw

ref.once('value', (snapshot) => {
  snapshot.forEach((childSnapshot) => {
    var childKey = childSnapshot.key;
    var childData = childSnapshot.val();
    // ...
  });
});

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 Bazy danych czasu rzeczywistego możesz pobrać dane posortowane według klucza, wartości lub wartości elementu podrzędnego. Możesz też filtrować posortowany wynik według określonej liczby wyników lub zakresu kluczy bądź wartości.

Sortowanie danych

Aby pobrać posortowane dane, zacznij od określenia jednej z metod ustalania kolejności wyników:

Metoda Wykorzystanie
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.

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 uzyskać listę najpopularniejszych postów użytkownika, posortowaną według liczby gwiazdek:

Web Modular API

import { getDatabase, ref, query, orderByChild } from "firebase/database";
import { getAuth } from "firebase/auth";

const db = getDatabase();
const auth = getAuth();

const myUserId = auth.currentUser.uid;
const topUserPostsRef = query(ref(db, 'user-posts/' + myUserId), orderByChild('starCount'));

Interfejs API internetowej przestrzeni nazw

var myUserId = firebase.auth().currentUser.uid;
var topUserPostsRef = firebase.database().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ądkowane według liczby gwiazdek otrzymanych przez 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 podrzędnego "starCount". Zapytania mogą być też porządkowane według zagnieżdżonych elementów podrzędnych, jeśli dane wyglądają 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 ścieżkę względną do zagnieżdżonego elementu podrzędnego w wywołaniu orderByChild().

Web Modular API

import { getDatabase, ref, query, orderByChild } from "firebase/database";

const db = getDatabase();
const mostViewedPosts = query(ref(db, 'posts'), orderByChild('metrics/views'));

Interfejs API internetowej przestrzeni nazw

var mostViewedPosts = firebase.database().ref('posts').orderByChild('metrics/views');

Więcej informacji o kolejności innych typów danych znajdziesz w sekcji Informacje o kolejności danych w zapytaniach.

Filtrowanie danych

Aby filtrować dane, podczas tworzenia zapytania możesz połączyć dowolne metody limitów lub zakresów z metodą porządkowania.

Metoda Wykorzystanie
limitToFirst() Określa maksymalną liczbę elementów do zwrócenia od początku uporządkowanej listy wyników.
limitToLast() Określa maksymalną liczbę elementów do zwrócenia na końcu uporządkowanej listy wyników.
startAt() Zwraca elementy większe lub równe 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 mniejsze lub równe podanej wartości klucza bądź wartości w zależności od wybranej metody sortowania.
endBefore() Zwracaj elementy mniejsze niż określony klucz lub wartość w zależności od wybranej metody sortowania.
equalTo() Zwraca elementy równe określonemu kluczowi lub wartościowi w zależności od wybranej metody sortowania.

W przeciwieństwie do metod sortowania według kolejności można łączyć wiele funkcji ograniczeń lub zakresu. Możesz np. łączyć metody startAt() i endAt(), aby ograniczyć wyniki do określonego zakresu wartości.

Ogranicz liczbę 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 funkcji limitToFirst(), aby ustawić limit wynoszący 100, początkowo otrzymasz maksymalnie 100 zdarzeń child_added. Jeśli w bazie danych Firebase masz mniej niż 100 elementów, dla każdego z nich wywoływane jest zdarzenie child_added.

Gdy elementy się zmieniają, będziesz otrzymywać zdarzenia child_added dla elementów, które wpisały zapytanie, i zdarzenia child_removed w przypadku elementów, które z niego nie przejdą. Dzięki temu łączna liczba będzie miała wartość 100.

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

Web Modular API

import { getDatabase, ref, query, limitToLast } from "firebase/database";

const db = getDatabase();
const recentPostsRef = query(ref(db, 'posts'), limitToLast(100));

Interfejs API internetowej przestrzeni nazw

var recentPostsRef = firebase.database().ref('posts').limitToLast(100);

W tym przykładzie zdefiniowano tylko zapytanie służące do synchronizacji danych, które muszą mieć dołączony detektor.

Filtruj według klucza lub wartości

Za pomocą parametrów startAt(), startAfter(), endAt(), endBefore() i equalTo() możesz wybierać dla zapytań dowolne punkty rozpoczęcia, zakończenia i równoważności. Przydaje się to przy dzieleniu danych na strony lub wyszukiwaniu elementów z elementami podrzędnymi, które mają określoną wartość.

Sposób porządkowania danych zapytań

W tej sekcji wyjaśniamy, jak dane są sortowane według metody 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. Jako pierwsze wyświetlają się elementy podrzędne z wartością null określonego klucza podrzędnego.
  2. Następne są elementy podrzędne z wartością false określonego klucza podrzędnego. Jeśli kilka elementów podrzędnych ma wartość false, są one sortowane leksykograficznie według klucza.
  3. Następne są elementy podrzędne z wartością true określonego klucza podrzędnego. Jeśli kilka elementów podrzędnych ma wartość true, są one sortowane leksykograficznie według klucza.
  4. Następne są elementy podrzędne z wartością liczbową, posortowane w kolejności rosnącej. Jeśli wiele elementów podrzędnych ma tę samą wartość liczbową 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 określonym węźle podrzędnym, są one uporządkowane leksykograficznie według klucza.
  6. Obiekty są na końcu i są sortowane leksykograficznie według klucza w kolejności rosnącej.

orderByKey

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

  1. Elementy podrzędne z kluczem, który można przeanalizować jako 32-bitową liczbę całkowitą, są na pierwszym miejscu, posortowane w kolejności rosnącej.
  2. Następnym elementem są elementy podrzędne z wartością w postaci ciągu znaków, 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 orderByChild(), z tą różnicą, że zamiast wartości określonego klucza podrzędnego używana jest wartość węzła.

Odłącz detektory

Wywołania zwrotne są usuwane poprzez 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 powoduje usunięcie wszystkich detektorów w tej lokalizacji.

Wywołanie off() w detektorze nadrzędnym nie powoduje automatycznego usunięcia detektorów zarejestrowanych w węzłach podrzędnych. Aby usunąć wywołanie zwrotne, funkcja off() musi też zostać wywołana we wszystkich detektorach podrzędnych.

Dalsze kroki