A JavaScript + Firestore oktatóanyag 2020-ig: Tanulj példával

A Cloud Firestore egy lángoló, gyors, szerver nélküli NoSQL adatbázis, amely tökéletes bármilyen méretű webes és mobilalkalmazások áramellátására. Fogja meg a Firestore megtanulásának teljes útmutatóját, amely azért készült, hogy megmutassa, hogyan kell használni a Firestore-t saját elképesztő projektjeinek motorjaként elölről hátra.

Tartalomjegyzék

A Firestore használatának megkezdése

  • Mi az a Firestore? Miért érdemes használni?
  • A Firestore beállítása JavaScript-projektben
  • Firestore dokumentumok és gyűjtemények
  • Adatbázisunk kezelése a Firebase Console segítségével

Adatok lekérése a Firestore szolgáltatással

  • Adatok beszerzése egy gyűjteményből a .get () használatával
  • Feliratkozás egy gyűjteményre az .onSnapshot () használatával
  • Különbség a .get () és az .onSnapshot () között
  • Leiratkozás egy gyűjteményről
  • Egyedi dokumentumok beszerzése

Adatok módosítása a Firestore segítségével

  • Dokumentum hozzáadása az .add () fájlt tartalmazó gyűjteményhez
  • Dokumentum hozzáadása a .set () használatú gyűjteményhez
  • Meglévő adatok frissítése
  • Adatok törlése

Alapvető minták

  • Részgyűjteményekkel való munka
  • Hasznos módszerek a Firestore mezőkhöz
  • Lekérdezés a .where () használatával
  • Adatok rendelése és korlátozása

Megjegyzés: Az oktatóanyag PDF-változatát letöltheti, így offline módon is olvashatja.

Mi az a Firestore? Miért érdemes használni?

A Firestore egy nagyon rugalmas, könnyen használható adatbázis mobil, webes és szerver fejlesztéshez. Ha ismeri a Firebase valós idejű adatbázisát, a Firestore sok hasonlóságot mutat, de egy másik (vitathatatlanul deklaratívabb) API-val rendelkezik.

Íme néhány olyan szolgáltatás, amelyet a Firestore az asztalra hoz:

⚡️Könnyen valós időben kap adatokat

A Firebase valós idejű adatbázishoz hasonlóan a Firestore is olyan hasznos módszereket kínál, mint az .onSnapshot (), amelyek szellősebbé teszik az adatok valós időben történő frissítésének hallgatását. Ideális választássá teszi a Firestore-t azokhoz a projektekhez, amelyek kiemelkedő fontosságot élveznek a legfrissebb adatok megjelenítésében és felhasználásában (például csevegőalkalmazások).

? Rugalmasság, mint NoSQL adatbázis

A Firestore egy nagyon rugalmas lehetőség a háttérprogram számára, mert NoSQL adatbázis. A NoSQL azt jelenti, hogy az adatokat nem úgy tárolják táblákban és oszlopokban, mint egy szokásos SQL adatbázisban. Úgy épül fel, mint egy kulcsérték tároló, mintha egy nagy JavaScript objektumról lenne szó.

Más szavakkal, nincs séma vagy szükség annak leírására, hogy az adatbázisunk mely adatokat tárolja. Amíg érvényes kulcsokat és értékeket adunk meg, a Firestore tárolja azokat.

↕️ Könnyedén méretezhető

Az egyik nagy előnye annak, ha a Firestore-t választja az adatbázisához, az a nagyon hatékony infrastruktúra, amelyre épít, és amely lehetővé teszi az alkalmazás nagyon egyszerű méretezését. Függőlegesen és vízszintesen egyaránt. Nem számít, hogy több száz vagy több millió felhasználóval rendelkezik-e. A Google szerverei képesek lesznek kezelni a terhelést.

Röviden: a Firestore remek lehetőség mind kicsi, mind nagy alkalmazásokhoz. Kicsi alkalmazások esetén nagy teljesítményű, mert sok mindent el tudunk végezni sok beállítás nélkül, és nagyon gyorsan létrehozhatunk velük projekteket. A Firestore méretezhetőségének köszönhetően kiválóan alkalmas nagy projektekhez.

A Firestore beállítása JavaScript-projektben

A Firestore SDK-t fogjuk használni a JavaScript-hez. Ebben a cheatsheet-ben áttekintjük a Firestore használatát egy JavaScript-projekt keretében. Ennek ellenére az itt bemutatott fogalmak könnyen átvihetők az elérhető Firestore ügyfélkönyvtárak bármelyikébe.

A Firestore használatának megkezdéséhez a Firebase konzolhoz megyünk. Ezt felkeresheti a firebase.google.com webhelyen. A bejelentkezéshez Google-fiókkal kell rendelkeznie.

Miután bejelentkeztünk, létrehozunk egy új projektet, és nevet adunk neki.

Miután elkészült a projektünk, kiválasztjuk. Ezt követően a projekt irányítópultján kiválasztjuk a kód gombot.

Ez megadja nekünk a Firestore és a JavaScript projektünk integrálásához szükséges kódot.

Általában, ha ezt bármilyen JavaScript-alkalmazásban állítja be, akkor ezt egy dedikált fájlba kell foglalnia, amely a firebase.js nevet viseli. Ha olyan JavaScript könyvtárat használ, amely rendelkezik a package.json fájllal, akkor telepítenie kell a Firebase függőséget npm vagy fonal segítségével.

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

A Firestore az ügyfélen vagy a kiszolgálón is használható. Ha a Firestore-ot Node-tal használja, akkor a CommonJS szintaxist kell használnia. Ellenkező esetben, ha JavaScriptet használ az ügyfélben, akkor a Firebase-t az ES modulok segítségével importálja.

// 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);

Firestore gyűjtemények és dokumentumok

Két alapvető kifejezés létfontosságú a Firestore használatának megértéséhez: dokumentumok és gyűjtemények .

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.

Azt javaslom, hogy hozzon létre egy dedikált változót a Firestore egyetlen hivatkozásának tárolásához. Ez segít csökkenteni az alkalmazásban írt kód mennyiségét.

const db = firebase.firestore(); 
Ebben a cheatsheet-ben azonban ragaszkodni fogok a firestore módszer minden egyes alkalmazásához, hogy a lehető legtisztább legyen.

A gyűjtemény hivatkozására a .collection()módszert használjuk, és argumentumként megadjuk a gyűjtemény azonosítóját. Ha hivatkozást szeretne kapni az általunk létrehozott könyvgyűjteményre, egyszerűen írja be a „könyvek” karakterláncot.

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

Ahhoz, hogy az összes dokumentumadatot megszerezzük egy gyűjteményből, láncolhatjuk a .get()módszert.

.get()ígéretet ad vissza, ami azt jelenti, hogy akár .then()visszahívással is megoldhatjuk, akár használhatjuk az async-await szintaxist, ha a kódunkat async függvényen belül hajtjuk végre.

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.

A használatban az hasznos .update(), hogy ellentétben .set()nem írja felül az egész dokumentumot. Ehhez hasonlóan .set()hivatkoznunk kell egy egyedi dokumentumra is.

Használatakor .update()fontos néhány hibakezelést használni, például a .catch()visszahívást abban az esetben, ha a dokumentum nem létezik.

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); }); 

Adatok törlése a .delete () paranccsal

Törölhetünk egy adott dokumentumgyűjteményt, ha azonosítóval hivatkozunk rá, és végrehajtjuk a .delete()metódust. Ez ígéretet is hoz.

Itt van egy alapvető példa egy "másik könyv" azonosítójú könyv törlésére:

firebase .firestore() .collection("books") .doc("another book") .delete() .then(() => console.log("Document deleted")) // Document deleted .catch((error) => console.error("Error deleting document", error));
Ne feledje, hogy a Firestore hivatalos dokumentációja nem javasolja a teljes gyűjtemény törlését, csak az egyes dokumentumokat.

Algyűjteményekkel való munka

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.

A következő operátorok bármelyikét használhatjuk, és az általunk használt mezők lehetnek primitív értékek, valamint tömbök is.

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

Az összes felhasználó letöltéséhez, aki egynél több könyvet küldött be, a következő lekérdezést használhatjuk.

Miután .where()be kell láncolnunk .get(). Ígéretünk megoldása után visszakapjuk az úgynevezett querySnapshot nevet .

A gyűjtemény megszerzéséhez hasonlóan iterálhatunk a querySnapshot segítségével, .map()hogy megkapjuk az egyes dokumentumok azonosítóját és adatait (mezőket):

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 } ] });
Ne feledje, hogy .where()összetett lekérdezések létrehozásához több módszer is összekapcsolható.

Lekérdezések korlátozása és megrendelése

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