Zapisywanie danych

W tym dokumencie opisano cztery metody zapisywania danych w bazie danych czasu rzeczywistego Firebase: ustawianie, aktualizowanie, wypychanie i obsługa transakcji.

Sposoby zapisywania danych

Zapisywanie danych

Podstawowa operacja zapisu do bazy danych to zestaw, który zapisuje nowe dane do określonego odwołania do bazy danych, zastępując wszelkie istniejące dane w tej ścieżce. Aby zrozumieć zestaw, stworzymy prostą aplikację do blogowania. Dane Twojej aplikacji są przechowywane w tej bazie danych:

final FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("server/saving-data/fireblog");

// Import Admin SDK
const { getDatabase } = require('firebase-admin/database');

// Get a database reference to our blog
const db = getDatabase();
const ref = db.ref('server/saving-data/fireblog');

# Import database module.
from firebase_admin import db

# Get a database reference to our blog.
ref = db.reference('server/saving-data/fireblog')

// Create a database client from App.
client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// Get a database reference to our blog.
ref := client.NewRef("server/saving-data/fireblog")

Zacznijmy od zapisania niektórych danych użytkownika. Będziemy przechowywać każdego użytkownika według unikalnej nazwy użytkownika, a także będziemy przechowywać jego imię i nazwisko oraz datę urodzenia. Ponieważ każdy użytkownik będzie miał unikalną nazwę użytkownika, sensowne jest użycie tutaj metody set zamiast metody push, ponieważ masz już klucz i nie musisz go tworzyć.

Najpierw utwórz odwołanie do bazy danych do danych użytkownika. Następnie użyj set() / setValue() , aby zapisać obiekt użytkownika w bazie danych z nazwą użytkownika, pełnym imieniem i datą urodzenia. Możesz przekazać set string, number, boolean, null , array lub dowolny obiekt JSON. Przekazanie wartości null spowoduje usunięcie danych w określonej lokalizacji. W takim przypadku przekażesz mu obiekt:

public static class User {

  public String date_of_birth;
  public String full_name;
  public String nickname;

  public User(String dateOfBirth, String fullName) {
    // ...
  }

  public User(String dateOfBirth, String fullName, String nickname) {
    // ...
  }

}

DatabaseReference usersRef = ref.child("users");

Map<String, User> users = new HashMap<>();
users.put("alanisawesome", new User("June 23, 1912", "Alan Turing"));
users.put("gracehop", new User("December 9, 1906", "Grace Hopper"));

usersRef.setValueAsync(users);

const usersRef = ref.child('users');
usersRef.set({
  alanisawesome: {
    date_of_birth: 'June 23, 1912',
    full_name: 'Alan Turing'
  },
  gracehop: {
    date_of_birth: 'December 9, 1906',
    full_name: 'Grace Hopper'
  }
});

users_ref = ref.child('users')
users_ref.set({
    'alanisawesome': {
        'date_of_birth': 'June 23, 1912',
        'full_name': 'Alan Turing'
    },
    'gracehop': {
        'date_of_birth': 'December 9, 1906',
        'full_name': 'Grace Hopper'
    }
})

// User is a json-serializable type.
type User struct {
	DateOfBirth string `json:"date_of_birth,omitempty"`
	FullName    string `json:"full_name,omitempty"`
	Nickname    string `json:"nickname,omitempty"`
}

usersRef := ref.Child("users")
err := usersRef.Set(ctx, map[string]*User{
	"alanisawesome": {
		DateOfBirth: "June 23, 1912",
		FullName:    "Alan Turing",
	},
	"gracehop": {
		DateOfBirth: "December 9, 1906",
		FullName:    "Grace Hopper",
	},
})
if err != nil {
	log.Fatalln("Error setting value:", err)
}

Gdy obiekt JSON jest zapisywany w bazie danych, właściwości obiektu są automatycznie mapowane na podrzędne lokalizacje bazy danych w sposób zagnieżdżony. Teraz, jeśli przejdziesz do adresu URL https://docs-examples.firebaseio.com/server/saving-data/fireblog/users/alanisawesome/full_name , zobaczymy wartość „Alan Turing”. Możesz także zapisać dane bezpośrednio w lokalizacji podrzędnej:

usersRef.child("alanisawesome").setValueAsync(new User("June 23, 1912", "Alan Turing"));
usersRef.child("gracehop").setValueAsync(new User("December 9, 1906", "Grace Hopper"));

const usersRef = ref.child('users');
usersRef.child('alanisawesome').set({
  date_of_birth: 'June 23, 1912',
  full_name: 'Alan Turing'
});
usersRef.child('gracehop').set({
  date_of_birth: 'December 9, 1906',
  full_name: 'Grace Hopper'
});

users_ref.child('alanisawesome').set({
    'date_of_birth': 'June 23, 1912',
    'full_name': 'Alan Turing'
})
users_ref.child('gracehop').set({
    'date_of_birth': 'December 9, 1906',
    'full_name': 'Grace Hopper'
})

if err := usersRef.Child("alanisawesome").Set(ctx, &User{
	DateOfBirth: "June 23, 1912",
	FullName:    "Alan Turing",
}); err != nil {
	log.Fatalln("Error setting value:", err)
}

if err := usersRef.Child("gracehop").Set(ctx, &User{
	DateOfBirth: "December 9, 1906",
	FullName:    "Grace Hopper",
}); err != nil {
	log.Fatalln("Error setting value:", err)
}

Powyższe dwa przykłady - zapisanie obu wartości w tym samym czasie jako obiekt i zapisanie ich oddzielnie w lokalizacjach podrzędnych - spowodują zapisanie tych samych danych w bazie danych:

{
  "users": {
    "alanisawesome": {
      "date_of_birth": "June 23, 1912",
      "full_name": "Alan Turing"
    },
    "gracehop": {
      "date_of_birth": "December 9, 1906",
      "full_name": "Grace Hopper"
    }
  }
}

Pierwszy przykład wyzwoli tylko jedno zdarzenie na klientach, którzy oglądają dane, podczas gdy drugi przykład wyzwoli dwa. Należy zauważyć, że jeśli dane już istniały w usersRef , pierwsze podejście spowodowałoby ich zastąpienie, ale druga metoda zmodyfikowałaby tylko wartość każdego oddzielnego węzła podrzędnego, pozostawiając inne elementy podrzędne usersRef bez zmian.

Aktualizowanie zapisanych danych

Jeśli chcesz zapisywać do wielu elementów podrzędnych lokalizacji bazy danych w tym samym czasie bez nadpisywania innych węzłów podrzędnych, możesz użyć metody aktualizacji, jak pokazano poniżej:

DatabaseReference hopperRef = usersRef.child("gracehop");
Map<String, Object> hopperUpdates = new HashMap<>();
hopperUpdates.put("nickname", "Amazing Grace");

hopperRef.updateChildrenAsync(hopperUpdates);

const usersRef = ref.child('users');
const hopperRef = usersRef.child('gracehop');
hopperRef.update({
  'nickname': 'Amazing Grace'
});

hopper_ref = users_ref.child('gracehop')
hopper_ref.update({
    'nickname': 'Amazing Grace'
})

hopperRef := usersRef.Child("gracehop")
if err := hopperRef.Update(ctx, map[string]interface{}{
	"nickname": "Amazing Grace",
}); err != nil {
	log.Fatalln("Error updating child:", err)
}

Spowoduje to zaktualizowanie danych Grace o jej pseudonim. Gdybyś użył set tutaj zamiast update, usunąłby zarówno full_name , jak i date_of_birth z twojego hopperRef .

Baza danych czasu rzeczywistego Firebase obsługuje również aktualizacje wielościeżkowe. Oznacza to, że aktualizacja może teraz aktualizować wartości w wielu lokalizacjach w bazie danych w tym samym czasie, co jest potężną funkcją, która pomaga w denormalizacji danych . Korzystając z aktualizacji wielościeżkowych, możesz jednocześnie dodawać pseudonimy do Grace i Alana:

Map<String, Object> userUpdates = new HashMap<>();
userUpdates.put("alanisawesome/nickname", "Alan The Machine");
userUpdates.put("gracehop/nickname", "Amazing Grace");

usersRef.updateChildrenAsync(userUpdates);

const usersRef = ref.child('users');
usersRef.update({
  'alanisawesome/nickname': 'Alan The Machine',
  'gracehop/nickname': 'Amazing Grace'
});

users_ref.update({
    'alanisawesome/nickname': 'Alan The Machine',
    'gracehop/nickname': 'Amazing Grace'
})

if err := usersRef.Update(ctx, map[string]interface{}{
	"alanisawesome/nickname": "Alan The Machine",
	"gracehop/nickname":      "Amazing Grace",
}); err != nil {
	log.Fatalln("Error updating children:", err)
}

Po tej aktualizacji zarówno Alan, jak i Grace mają dodane pseudonimy:

{
  "users": {
    "alanisawesome": {
      "date_of_birth": "June 23, 1912",
      "full_name": "Alan Turing",
      "nickname": "Alan The Machine"
    },
    "gracehop": {
      "date_of_birth": "December 9, 1906",
      "full_name": "Grace Hopper",
      "nickname": "Amazing Grace"
    }
  }
}

Należy zauważyć, że próba aktualizacji obiektów przez zapisanie obiektów z dołączonymi ścieżkami spowoduje inne zachowanie. Przyjrzyjmy się, co się stanie, jeśli zamiast tego spróbujesz zaktualizować Grace i Alana w ten sposób:

Map<String, Object> userNicknameUpdates = new HashMap<>();
userNicknameUpdates.put("alanisawesome", new User(null, null, "Alan The Machine"));
userNicknameUpdates.put("gracehop", new User(null, null, "Amazing Grace"));

usersRef.updateChildrenAsync(userNicknameUpdates);

const usersRef = ref.child('users');
usersRef.update({
  'alanisawesome': {
    'nickname': 'Alan The Machine'
  },
  'gracehop': {
    'nickname': 'Amazing Grace'
  }
});

users_ref.update({
    'alanisawesome': {
        'nickname': 'Alan The Machine'
    },
    'gracehop': {
        'nickname': 'Amazing Grace'
    }
})

if err := usersRef.Update(ctx, map[string]interface{}{
	"alanisawesome": &User{Nickname: "Alan The Machine"},
	"gracehop":      &User{Nickname: "Amazing Grace"},
}); err != nil {
	log.Fatalln("Error updating children:", err)
}

Powoduje to inne zachowanie, a mianowicie nadpisanie całego węzła /users :

{
  "users": {
    "alanisawesome": {
      "nickname": "Alan The Machine"
    },
    "gracehop": {
      "nickname": "Amazing Grace"
    }
  }
}

Dodanie wywołania zwrotnego zakończenia

W Node.js i Java Admin SDK, jeśli chcesz wiedzieć, kiedy Twoje dane zostały zatwierdzone, możesz dodać wywołanie zwrotne zakończenia. Obie metody set i update w tych zestawach SDK pobierają opcjonalne wywołanie zwrotne zakończenia, które jest wywoływane, gdy zapis został zatwierdzony w bazie danych. Jeśli wywołanie nie powiodło się z jakiegoś powodu, wywołanie zwrotne przekazuje obiekt błędu wskazujący przyczynę niepowodzenia. W pakietach Python i Go Admin SDK wszystkie metody zapisu są blokowane. Oznacza to, że metody zapisu nie zwracają wartości, dopóki zapisy nie zostaną zatwierdzone w bazie danych.

DatabaseReference dataRef = ref.child("data");
dataRef.setValue("I'm writing data", new DatabaseReference.CompletionListener() {
  @Override
  public void onComplete(DatabaseError databaseError, DatabaseReference databaseReference) {
    if (databaseError != null) {
      System.out.println("Data could not be saved " + databaseError.getMessage());
    } else {
      System.out.println("Data saved successfully.");
    }
  }
});

dataRef.set('I\'m writing data', (error) => {
  if (error) {
    console.log('Data could not be saved.' + error);
  } else {
    console.log('Data saved successfully.');
  }
});

Zapisywanie list danych

Podczas tworzenia list danych należy pamiętać o wieloużytkownikowym charakterze większości aplikacji i odpowiednio dostosować strukturę listy. Rozwijając powyższy przykład, dodajmy posty na blogu do Twojej aplikacji. Twoim pierwszym odruchem może być użycie zestawu do przechowywania dzieci z automatycznie zwiększającymi się indeksami liczb całkowitych, jak poniżej:

// NOT RECOMMENDED - use push() instead!
{
  "posts": {
    "0": {
      "author": "gracehop",
      "title": "Announcing COBOL, a New Programming Language"
    },
    "1": {
      "author": "alanisawesome",
      "title": "The Turing Machine"
    }
  }
}

Jeśli użytkownik doda nowy post, zostanie on zapisany jako /posts/2 . Działałoby to, gdyby posty dodawał tylko jeden autor, ale w Twojej aplikacji do wspólnego blogowania wielu użytkowników może dodawać posty w tym samym czasie. Jeśli dwóch autorów napisze jednocześnie do /posts/2 , jeden z postów zostanie usunięty przez drugiego.

Aby rozwiązać ten problem, klienci Firebase udostępniają funkcję push() , która generuje unikalny klucz dla każdego nowego dziecka . Używając unikalnych kluczy podrzędnych, kilku klientów może jednocześnie dodawać elementy podrzędne do tej samej lokalizacji bez martwienia się o konflikty zapisu.

public static class Post {

  public String author;
  public String title;

  public Post(String author, String title) {
    // ...
  }

}

DatabaseReference postsRef = ref.child("posts");

DatabaseReference newPostRef = postsRef.push();
newPostRef.setValueAsync(new Post("gracehop", "Announcing COBOL, a New Programming Language"));

// We can also chain the two calls together
postsRef.push().setValueAsync(new Post("alanisawesome", "The Turing Machine"));

const newPostRef = postsRef.push();
newPostRef.set({
  author: 'gracehop',
  title: 'Announcing COBOL, a New Programming Language'
});

// we can also chain the two calls together
postsRef.push().set({
  author: 'alanisawesome',
  title: 'The Turing Machine'
});

posts_ref = ref.child('posts')

new_post_ref = posts_ref.push()
new_post_ref.set({
    'author': 'gracehop',
    'title': 'Announcing COBOL, a New Programming Language'
})

# We can also chain the two calls together
posts_ref.push().set({
    'author': 'alanisawesome',
    'title': 'The Turing Machine'
})

// Post is a json-serializable type.
type Post struct {
	Author string `json:"author,omitempty"`
	Title  string `json:"title,omitempty"`
}

postsRef := ref.Child("posts")

newPostRef, err := postsRef.Push(ctx, nil)
if err != nil {
	log.Fatalln("Error pushing child node:", err)
}

if err := newPostRef.Set(ctx, &Post{
	Author: "gracehop",
	Title:  "Announcing COBOL, a New Programming Language",
}); err != nil {
	log.Fatalln("Error setting value:", err)
}

// We can also chain the two calls together
if _, err := postsRef.Push(ctx, &Post{
	Author: "alanisawesome",
	Title:  "The Turing Machine",
}); err != nil {
	log.Fatalln("Error pushing child node:", err)
}

Unikalny klucz jest oparty na sygnaturze czasowej, więc elementy listy będą automatycznie uporządkowane chronologicznie. Ponieważ Firebase generuje unikalny klucz dla każdego posta na blogu, nie wystąpią żadne konflikty zapisu, jeśli wielu użytkowników doda post w tym samym czasie. Twoje dane bazy danych wyglądają teraz tak:

{
  "posts": {
    "-JRHTHaIs-jNPLXOQivY": {
      "author": "gracehop",
      "title": "Announcing COBOL, a New Programming Language"
    },
    "-JRHTHaKuITFIhnj02kE": {
      "author": "alanisawesome",
      "title": "The Turing Machine"
    }
  }
}

W JavaScript, Pythonie i Go wzorzec wywoływania push() i natychmiastowego wywoływania set() jest tak powszechny, że Firebase SDK pozwala łączyć je, przekazując dane do ustawienia bezpośrednio do push() w następujący sposób:

// No Java equivalent

// This is equivalent to the calls to push().set(...) above
postsRef.push({
  author: 'gracehop',
  title: 'Announcing COBOL, a New Programming Language'
});;

# This is equivalent to the calls to push().set(...) above
posts_ref.push({
    'author': 'gracehop',
    'title': 'Announcing COBOL, a New Programming Language'
})

if _, err := postsRef.Push(ctx, &Post{
	Author: "gracehop",
	Title:  "Announcing COBOL, a New Programming Language",
}); err != nil {
	log.Fatalln("Error pushing child node:", err)
}

Uzyskanie unikalnego klucza wygenerowanego przez push()

Wywołanie push() zwróci odwołanie do nowej ścieżki danych, której możesz użyć, aby uzyskać klucz lub ustawić w niej dane. Poniższy kod zwróci te same dane, co w powyższym przykładzie, ale teraz będziemy mieć dostęp do wygenerowanego unikalnego klucza:

// Generate a reference to a new location and add some data using push()
DatabaseReference pushedPostRef = postsRef.push();

// Get the unique ID generated by a push()
String postId = pushedPostRef.getKey();

// Generate a reference to a new location and add some data using push()
const newPostRef = postsRef.push();

// Get the unique key generated by push()
const postId = newPostRef.key;

# Generate a reference to a new location and add some data using push()
new_post_ref = posts_ref.push()

# Get the unique key generated by push()
post_id = new_post_ref.key

// Generate a reference to a new location and add some data using Push()
newPostRef, err := postsRef.Push(ctx, nil)
if err != nil {
	log.Fatalln("Error pushing child node:", err)
}

// Get the unique key generated by Push()
postID := newPostRef.Key

Jak widać, możesz uzyskać wartość unikalnego klucza z odniesienia push() .

W następnej sekcji dotyczącej pobierania danych dowiemy się, jak odczytywać te dane z bazy danych Firebase.

Zapisywanie danych transakcyjnych

Podczas pracy ze złożonymi danymi, które mogą zostać uszkodzone przez jednoczesne modyfikacje, takie jak liczniki przyrostowe, SDK zapewnia operację transakcji .

W Javie i Node.js operacji transakcyjnej nadajesz dwa wywołania zwrotne: funkcję aktualizacji i opcjonalne wywołanie zwrotne zakończenia. W Pythonie i Go operacja transakcji jest blokowana i dlatego akceptuje tylko funkcję aktualizacji.

Funkcja aktualizacji przyjmuje jako argument bieżący stan danych i powinna zwrócić nowy żądany stan, który chcesz zapisać. Na przykład, jeśli chcesz zwiększyć liczbę głosów pozytywnych dla określonego posta na blogu, napisałbyś transakcję podobną do następującej:

DatabaseReference upvotesRef = ref.child("server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes");
upvotesRef.runTransaction(new Transaction.Handler() {
  @Override
  public Transaction.Result doTransaction(MutableData mutableData) {
    Integer currentValue = mutableData.getValue(Integer.class);
    if (currentValue == null) {
      mutableData.setValue(1);
    } else {
      mutableData.setValue(currentValue + 1);
    }

    return Transaction.success(mutableData);
  }

  @Override
  public void onComplete(
      DatabaseError databaseError, boolean committed, DataSnapshot dataSnapshot) {
    System.out.println("Transaction completed");
  }
});

const upvotesRef = db.ref('server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes');
upvotesRef.transaction((current_value) => {
  return (current_value || 0) + 1;
});

def increment_votes(current_value):
    return current_value + 1 if current_value else 1

upvotes_ref = db.reference('server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes')
try:
    new_vote_count = upvotes_ref.transaction(increment_votes)
    print('Transaction completed')
except db.TransactionAbortedError:
    print('Transaction failed to commit')

fn := func(t db.TransactionNode) (interface{}, error) {
	var currentValue int
	if err := t.Unmarshal(&currentValue); err != nil {
		return nil, err
	}
	return currentValue + 1, nil
}

ref := client.NewRef("server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes")
if err := ref.Transaction(ctx, fn); err != nil {
	log.Fatalln("Transaction failed to commit:", err)
}

Powyższy przykład sprawdza, czy licznik ma null lub czy nie został jeszcze zwiększony, ponieważ transakcje można wywoływać z null , jeśli nie została zapisana żadna wartość domyślna.

Gdyby powyższy kod został uruchomiony bez funkcji transakcyjnej i dwóch klientów próbowało go jednocześnie zwiększyć, obaj zapisaliby 1 jako nową wartość, co dałoby jeden przyrost zamiast dwóch.

Łączność sieciowa i zapisy offline

Klienci Firebase Node.js i Java utrzymują własne wewnętrzne wersje wszelkich aktywnych danych. Kiedy dane są zapisywane, są one najpierw zapisywane w tej wersji lokalnej. Następnie klient synchronizuje te dane z bazą danych i innymi klientami na zasadzie „najlepszych starań”.

W rezultacie wszystkie zapisy do bazy danych natychmiast wyzwalają zdarzenia lokalne, zanim jakiekolwiek dane zostaną zapisane w bazie danych. Oznacza to, że gdy napiszesz aplikację za pomocą Firebase, Twoja aplikacja pozostanie responsywna niezależnie od opóźnienia sieci lub połączenia z Internetem.

Po przywróceniu łączności otrzymamy odpowiedni zestaw zdarzeń, dzięki którym klient „dogoni” aktualny stan serwera, bez konieczności pisania niestandardowego kodu.

Zabezpieczanie Twoich danych

Baza danych czasu rzeczywistego Firebase ma język zabezpieczeń, który pozwala określić, którzy użytkownicy mają dostęp do odczytu i zapisu różnych węzłów danych. Możesz przeczytać więcej na ten temat w Bezpieczne Twoje Dane .