Tutorialul JavaScript + Firestore pentru 2020: Aflați de exemplu

Cloud Firestore este o bază de date NoSQL rapidă, fără server, perfectă pentru alimentarea aplicațiilor web și mobile de orice dimensiune. Luați ghidul complet pentru învățarea Firestore, creat pentru a vă arăta cum să utilizați Firestore ca motor pentru propriile dvs. proiecte uimitoare din față în spate.

Cuprins

Noțiuni introductive despre Firestore

  • Ce este Firestore? De ce ar trebui să-l folosiți?
  • Configurarea Firestore într-un proiect JavaScript
  • Documente și colecții Firestore
  • Gestionarea bazei de date cu ajutorul consolei Firebase

Preluarea datelor cu Firestore

  • Obținerea datelor dintr-o colecție cu .get ()
  • Abonarea la o colecție cu .onSnapshot ()
  • Diferența dintre .get () și .onSnapshot ()
  • Dezabonarea de la o colecție
  • Obținerea de documente individuale

Schimbarea datelor cu Firestore

  • Adăugarea documentului la o colecție cu .add ()
  • Adăugarea unui document într-o colecție cu .set ()
  • Actualizarea datelor existente
  • Ștergerea datelor

Modele esențiale

  • Lucrul cu subcolecțiile
  • Metode utile pentru câmpurile Firestore
  • Interogarea cu .where ()
  • Comandarea și limitarea datelor

Notă: puteți descărca o versiune PDF a acestui tutorial, astfel încât să o puteți citi offline.

Ce este Firestore? De ce ar trebui să-l folosiți?

Firestore este o bază de date foarte flexibilă, ușor de utilizat, pentru dezvoltarea de dispozitive mobile, web și server. Dacă sunteți familiarizat cu baza de date Firebase în timp real, Firestore are multe asemănări, dar cu un API diferit (probabil mai declarativ).

Iată câteva dintre caracteristicile pe care Firestore le aduce la masă:

⚡️ Obțineți cu ușurință date în timp real

La fel ca baza de date Firebase în timp real, Firestore oferă metode utile, cum ar fi .onSnapshot (), ceea ce face ușor să ascultați actualizările datelor dvs. în timp real. Face din Firestore o alegere ideală pentru proiectele care acordă o prioritate afișării și utilizării celor mai recente date (aplicații de chat, de exemplu).

? Flexibilitate ca bază de date NoSQL

Firestore este o opțiune foarte flexibilă pentru un backend, deoarece este o bază de date NoSQL. NoSQL înseamnă că datele nu sunt stocate în tabele și coloane așa cum ar fi o bază de date SQL standard. Este structurat ca un magazin cheie-valoare, ca și cum ar fi un obiect JavaScript mare.

Cu alte cuvinte, nu există nicio schemă sau nu este nevoie să descrie ce date vor stoca baza noastră de date. Atâta timp cât furnizăm chei și valori valide, Firestore le va stoca.

↕️ scalabil fără efort

Un mare avantaj al alegerii Firestore pentru baza dvs. de date este infrastructura foarte puternică pe care se bazează, care vă permite să vă scalați aplicația foarte ușor. Atât pe verticală, cât și pe orizontală. Indiferent dacă aveți sute sau milioane de utilizatori. Serverele Google vor putea face față oricărei încărcări pe care le așezați.

Pe scurt, Firestore este o opțiune excelentă atât pentru aplicații mici, cât și mari. Pentru aplicațiile mici este puternic, deoarece putem face multe lucruri fără prea multe setări și putem crea proiecte foarte rapid cu ele. Firestore este potrivit pentru proiecte mari datorită scalabilității sale.

Configurarea Firestore într-un proiect JavaScript

Vom folosi SDK-ul Firestore pentru JavaScript. De-a lungul acestei fișe de cheats, vom prezenta cum să utilizați Firestore în contextul unui proiect JavaScript. În ciuda acestui fapt, conceptele pe care le vom aborda aici sunt ușor de transferat către oricare dintre bibliotecile client Firestore disponibile.

Pentru a începe cu Firestore, ne vom îndrepta către consola Firebase. Puteți vizita acest lucru accesând firebase.google.com. Va trebui să aveți un cont Google pentru a vă conecta.

După ce ne-am conectat, vom crea un proiect nou și îi vom da un nume.

Odată ce proiectul nostru este creat, îl vom selecta. După aceea, în tabloul de bord al proiectului nostru, vom selecta butonul de cod.

Acest lucru ne va oferi codul de care avem nevoie pentru a integra Firestore în proiectul nostru JavaScript.

De obicei, dacă configurați acest lucru în orice fel de aplicație JavaScript, veți dori să introduceți acest lucru într-un fișier dedicat numit firebase.js. Dacă utilizați orice bibliotecă JavaScript care are un fișier package.json, veți dori să instalați dependența Firebase cu npm sau yarn.

// with npm npm i firebase // with yarn yarn add firebase

Firestore poate fi utilizat fie pe client, fie pe server. Dacă utilizați Firestore cu Node, va trebui să utilizați sintaxa CommonJS cu require. În caz contrar, dacă utilizați JavaScript în client, veți importa firebase utilizând module ES.

// with Commonjs syntax (if using Node) const firebase = require("firebase/app"); require("firebase/firestore"); // with ES Modules (if using client-side JS, like React) import firebase from 'firebase/app'; import 'firebase/firestore'; var firebaseConfig = { apiKey: "AIzaSyDpLmM79mUqbMDBexFtOQOkSl0glxCW_ds", authDomain: "lfasdfkjkjlkjl.firebaseapp.com", databaseURL: "//lfasdlkjkjlkjl.firebaseio.com", projectId: "lfasdlkjkjlkjl", storageBucket: "lfasdlkjkjlkjl.appspot.com", messagingSenderId: "616270824980", appId: "1:616270824990:web:40c8b177c6b9729cb5110f", }; // Initialize Firebase firebase.initializeApp(firebaseConfig);

Colecții și documente Firestore

Există doi termeni cheie care sunt esențiali pentru a înțelege cum să lucrați cu Firestore: documente și colecții .

Documents are individual pieces of data in our database. You can think of documents to be much like simple JavaScript objects. They consist of key-value pairs, which we refer to as fields. The values of these fields can be strings, numbers, Booleans, objects, arrays, and even binary data.

document -> { key: value } 

Sets of these documents of these documents are known as collections. Collections are very much like arrays of objects. Within a collection, each document is linked to a given identifier (id).

collection -> [{ id: doc }, { id: doc }]

Managing our database with the Firestore Console

Before we can actually start working with our database we need to create it.

Within our Firebase console, go to the 'Database' tab and create your Firestore database.

Once you've done that, we will start in test mode and enable all reads and writes to our database. In other words, we will have open access to get and change data in our database. If we were to add Firebase authentication, we could restrict access only to authenticated users.

After that, we'll be taken to our database itself, where we can start creating collections and documents. The root of our database will be a series of collections, so let's make our first collection.

We can select 'Start collection' and give it an id. Every collection is going to have an id or a name. For our project, we're going to keep track of our users' favorite books. We'll give our first collection the id 'books'.

Next, we'll add our first document with our newly-created 'books' collection.

Each document is going to have an id as well, linking it to the collection in which it exists.

In most cases we're going to use an  option to give it an automatically generated ID. So we can hit the button 'auto id' to do so, after which we need to provide a field, give it a type, as well as a value.

For our first book, we'll make a 'title' field of type 'string', with the value 'The Great Gatsby', and hit save.

After that, we should see our first item in our database.

Getting data from a collection with .get()

To get access Firestore use all of the methods it provides, we use firebase.firestore(). This method need to be executed every time we want to interact with our Firestore database.

Aș recomanda crearea unei variabile dedicate pentru a stoca o singură referință la Firestore. Acest lucru vă ajută să reduceți cantitatea de cod pe care îl scrieți în aplicație.

const db = firebase.firestore(); 
Cu toate acestea, în această foaie de cheats, voi respecta metoda de stocare a focului de fiecare dată pentru a fi cât mai clar posibil.

Pentru a face referire la o colecție, folosim .collection()metoda și oferim codul unei colecții ca argument. Pentru a obține o referință la colecția de cărți pe care am creat-o, trebuie doar să treceți în șirul „cărți”.

const booksRef = firebase.firestore().collection('books');

Pentru a obține toate datele documentelor dintr-o colecție, putem încerca .get()metoda.

.get()returnează o promisiune, ceea ce înseamnă că o putem rezolva fie utilizând un .then()callback, fie putem folosi sintaxa async-await dacă executăm codul nostru într-o funcție async.

Once our promises is resolved in one way or another, we get back what's known as a snapshot.

For a collection query that snapshot is going to consist of a number of individual documents. We can access them by saying snapshot.docs.

From each document, we can get the id as a separate property, and the rest of the data using the .data() method.

Here's what our entire query looks like:

const booksRef = firebase .firestore() .collection("books"); booksRef .get() .then((snapshot) => { const data = snapshot.docs.map((doc) => ({ id: doc.id, ...doc.data(), })); console.log("All data in 'books' collection", data); // [ { id: 'glMeZvPpTN1Ah31sKcnj', title: 'The Great Gatsby' } ] });

Subscribing to a collection with .onSnapshot()

The .get() method simply returns all the data within our collection.

To leverage some of Firestore's realtime capabilities we can subscribe to a collection, which gives us the current value of the documents in that collection, whenever they are updated.

Instead of using the .get() method, which is for querying a single time, we use the .onSnapshot() method.

firebase .firestore() .collection("books") .onSnapshot((snapshot) => { const data = snapshot.docs.map((doc) => ({ id: doc.id, ...doc.data(), })); console.log("All data in 'books' collection", data); });

In the code above, we're using what's known as method chaining instead of creating a separate variable to reference the collection.

What's powerful about using firestore is that we can chain a bunch of methods one after another, making for more declarative, readable code.

Within onSnapshot's callback, we get direct access to the snapshot of our collection, both now and whenever it's updated in the future. Try manually updating our one document and you'll see that .onSnapshot() is listening for any changes in this collection.

Difference between .get() and .onSnapshot()

The difference between the get and the snapshot methods is that get returns a promise, which needs to be resolved, and only then we get the snapshot data.

.onSnapshot, however, utilizes synchronous callback function, which gives us direct access to the snapshot.

This is important to keep in mind when it comes to these different methods--we have to know which of them return a promise and which are synchronous.

Unsubscribing from a collection with unsubscribe()

Note additionally that .onSnapshot() returns a function which we can use to unsubscribe and stop listening on a given collection.

This is important in cases where the user, for example, goes away from a given page where we're displaying a collection's data. Here's an example, using the library React were we are calling unsubscribe within the useEffect hook.

When we do so this is going to make sure that when our component is unmounted (no longer displayed within the context of our app) that we're no longer listening on the collection data that we're using in this component.

function App() { const [books, setBooks] = React.useState([]); React.useEffect(() => { const unsubscribe = firebase .firestore() .collection("books") .onSnapshot((snapshot) => { const data = snapshot.docs.map((doc) => ({ id: doc.id, ...doc.data(), })); setBooks(data); }); }, []); return books.map(book => ) }

Getting Individual Documents with .doc()

When it comes to getting a document within a collection., the process is just the same as getting an entire collection: we need to first create a reference to that document, and then use the get method to grab it.

After that, however, we use the .doc() method chained on to the collection method. In order to create a reference, we need to grab this id from the database if it was auto generated. After that, we can chain on .get() and resolve the promise.

const bookRef = firebase .firestore() .collection("books") .doc("glMeZvPpTN1Ah31sKcnj"); bookRef.get().then((doc) => { if (!doc.exists) return; console.log("Document data:", doc.data()); // Document data: { title: 'The Great Gatsby' } });

Notice the conditional if (!doc.exists) return; in the code above.

Once we get the document back, it's essential to check to see whether it exists.

If we don't, there'll be an error in getting our document data. The way to check and see if our document exists is by saying, if doc.exists, which returns a true or false value.

If this expression returns false, we want to return from the function or maybe throw an error. If doc.exists is true, we can get the data from doc.data.

Adding document to a collection with .add()

Next, let's move on to changing data. The easiest way to add a new document to a collection is with the .add() method.

All you need to do is select a collection reference (with .collection()) and chain on .add().

Going back to our definition of documents as being like JavaScript objects, we need to pass an object to the .add() method and specify all the fields we want to be on the document.

Let's say we want to add another book, 'Of Mice and Men':

firebase .firestore() .collection("books") .add({ title: "Of Mice and Men", }) .then((ref) => { console.log("Added doc with ID: ", ref.id); // Added doc with ID: ZzhIgLqELaoE3eSsOazu });

The .add method returns a promise and from this resolved promise, we get back a reference to the created document, which gives us information such as the created id.

The .add() method auto generates an id for us. Note that we can't use this ref directly to get data. We can however pass the ref to the doc method to create another query.

Adding a document to a collection with .set()

Another way to add a document to a collection is with the .set() method.

Where set differs from add lies in the need to specify our own id upon adding the data.

This requires chaining on the .doc() method with the id that you want to use. Also, note how when the promise is resolved from .set(), we don't get a reference to the created document:

firebase .firestore() .collection("books") .doc("another book") .set({ title: "War and Peace", }) .then(() => { console.log("Document created"); });

Additionally, when we use .set() with an existing document, it will, by default, overwrite that document.

If we want to merge, an old document with a new document instead of overwriting it, we need to pass an additional argument to .set() and provide the property merge set to true.

// use .set() to merge data with existing document, not overwrite const bookRef = firebase .firestore() .collection("books") .doc("another book"); bookRef .set({ author: "Lev Nikolaevich Tolstoy" }, { merge: true }) .then(() => { console.log("Document merged"); bookRef .get() .then(doc => { console.log("Merged document: ", doc.data()); // Merged document: { title: 'War and Peace', author: 'Lev Nikolaevich Tolstoy' } }); });

Updating existing data with .update()

When it comes to updating data we use the update method, like .add() and .set() it returns a promise.

Ce este util la utilizarea .update()este că, spre deosebire de .set()acesta, nu va suprascrie întregul document. De asemenea .set(), trebuie să facem referire la un document individual.

Când utilizați .update(), este important să utilizați o anumită gestionare a erorilor, cum ar fi .catch()apelul invers în cazul în care documentul nu există.

const bookRef = firebase.firestore().collection("books").doc("another book"); bookRef .update({ year: 1869, }) .then(() => { console.log("Document updated"); // Document updated }) .catch((error) => { console.error("Error updating doc", error); }); 

Ștergerea datelor cu .delete ()

Putem șterge o anumită colecție de documente făcând referire la ea prin id-ul său și executând .delete()metoda, la fel de simplă. De asemenea, returnează o promisiune.

Iată un exemplu de bază pentru ștergerea unei cărți cu id-ul „altă carte”:

firebase .firestore() .collection("books") .doc("another book") .delete() .then(() => console.log("Document deleted")) // Document deleted .catch((error) => console.error("Error deleting document", error));
Rețineți că documentația oficială Firestore nu recomandă ștergerea colecțiilor întregi, ci doar a documentelor individuale.

Lucrul cu colecțiile secundare

Let's say that we made a misstep in creating our application, and instead of just adding books we also want to connect them to the users that made them. T

The way that we want to restructure the data is by making a collection called 'users' in the root of our database, and have 'books' be a subcollection of 'users'. This will allow users to have their own collections of books. How do we set that up?

References to the subcollection 'books' should look something like this:

const userBooksRef = firebase .firestore() .collection('users') .doc('user-id') .collection('books');

Note additionally that we can write this all within a single .collection() call using forward slashes.

The above code is equivalent to the follow, where the collection reference must have an odd number of segments. If not, Firestore will throw an error.

const userBooksRef = firebase .firestore() .collection('users/user-id/books');

To create the subcollection itself, with one document (another Steinbeck novel, 'East of Eden') run the following.

firebase.firestore().collection("users/user-1/books").add({ title: "East of Eden", });

Then, getting that newly created subcollection would look like the following based off of the user's ID.

firebase .firestore() .collection("users/user-1/books") .get() .then((snapshot) => { const data = snapshot.docs.map((doc) => ({ id: doc.id, ...doc.data(), })); console.log(data); // [ { id: 'UO07aqpw13xvlMAfAvTF', title: 'East of Eden' } ] });

Useful methods for Firestore fields

There are some useful tools that we can grab from Firestore that enables us to work with our field values a little bit easier.

For example, we can generate a timestamp for whenever a given document is created or updated with the following helper from the FieldValue property.

We can of course create our own date values using JavaScript, but using a server timestamp lets us know exactly when data is changed or created from Firestore itself.

firebase .firestore() .collection("users") .doc("user-2") .set({ created: firebase.firestore.FieldValue.serverTimestamp(), }) .then(() => { console.log("Added user"); // Added user });

Additionally, say we have a field on a document which keeps track of a certain number, say the number of books a user has created. Whenever a user creates a new book we want to increment that by one.

An easy way to do this, instead of having to first make a .get() request, is to use another field value helper called .increment():

const userRef = firebase.firestore().collection("users").doc("user-2"); userRef .set({ count: firebase.firestore.FieldValue.increment(1), }) .then(() => { console.log("Updated user"); userRef.get().then((doc) => { console.log("Updated user data: ", doc.data()); }); }); 

Querying with .where()

What if we want to get data from our collections based on certain conditions? For example, say we want to get all of the users that have submitted one or more books?

We can write such a query with the help of the .where() method. First we reference a collection and then chain on .where().

The where method takes three arguments--first, the field that we're searching on an operation, an operator, and then the value on which we want to filter our collection.

Putem folosi oricare dintre următorii operatori, iar câmpurile pe care le folosim pot fi atât valori primitive, cât și tablouri.

<, <=, ==, >, >=, array-contains, in, Sauarray-contains-any

Pentru a prelua toți utilizatorii care au trimis mai multe cărți, putem folosi următoarea interogare.

După .where()ce trebuie să ne legăm .get(). După ce ne-am rezolvat promisiunea, vom primi înapoi ceea ce este cunoscut sub numele de querySnapshot .

La fel ca și obținerea unei colecții, putem itera peste querySnapshot cu .map()pentru a obține fiecare document de identificare și date (câmpuri):

firebase .firestore() .collection("users") .where("count", ">=", 1) .get() .then((querySnapshot) => { const data = querySnapshot.docs.map((doc) => ({ id: doc.id, ...doc.data(), })); console.log("Users with > 1 book: ", data); // Users with > 1 book: [ { id: 'user-1', count: 1 } ] });
Rețineți că puteți conecta mai multe .where()metode pentru a crea interogări compuse.

Limitarea și ordonarea interogărilor

Another method for effectively querying our collections is to limit them. Let's say we want to limit a given query to a certain amount of documents.

If we only want to return a few items from our query, we just need to add on the .limit() method, after a given reference.

If we wanted to do that through our query for fetching users that have submitted at least one book, it would look like the following.

const usersRef = firebase .firestore() .collection("users") .where("count", ">=", 1); usersRef.limit(3)

Another powerful feature is to order our queried data according to document fields using .orderBy().

If we want to order our created users by when they were first made, we can use the orderBy method with the 'created' field as the first argument. For the second argument, we specify whether it should be in ascending or descending order.

To get all of the users ordered by when they were created from newest to oldest, we can execute the following query:

const usersRef = firebase .firestore() .collection("users") .where("count", ">=", 1); usersRef.orderBy("created", "desc").limit(3);

We can chain .orderBy() with .limit(). For this to work properly, .limit() should be called last and not before .orderBy().

Want your own copy? ?

If you would like to have this guide for future reference, download a cheatsheet of this entire tutorial here.

Click to grab the cheatsheet