Підручник з JavaScript + Firestore на 2020 рік: навчіться на прикладі

Cloud Firestore - це надзвичайно швидка, безсерверна база даних NoSQL, ідеально підходить для роботи в Інтернеті та мобільних додатках будь-якого розміру. Візьміть повний посібник із вивчення Firestore, створений, щоб показати вам, як використовувати Firestore як двигун для ваших власних дивовижних проектів спереду назад.

Зміст

Початок роботи з Firestore

  • Що таке Firestore? Чому ви повинні це використовувати?
  • Налаштування Firestore у проекті JavaScript
  • Документи та колекції Firestore
  • Управління нашою базою даних за допомогою консолі Firebase

Отримання даних за допомогою Firestore

  • Отримання даних із колекції за допомогою .get ()
  • Підписка на колекцію за допомогою .onSnapshot ()
  • Різниця між .get () та .onSnapshot ()
  • Скасування підписки на колекцію
  • Отримання індивідуальних документів

Зміна даних за допомогою Firestore

  • Додавання документа до колекції за допомогою .add ()
  • Додавання документа до колекції за допомогою .set ()
  • Оновлення наявних даних
  • Видалення даних

Основні візерунки

  • Робота з підколекціями
  • Корисні методи для полів Firestore
  • Запит за допомогою .where ()
  • Впорядкування та обмеження даних

Примітка: ви можете завантажити PDF-версію цього підручника, щоб читати його в автономному режимі.

Що таке Firestore? Чому ви повинні це використовувати?

Firestore - це дуже гнучка, проста у використанні база даних для мобільних, веб- та серверних розробок. Якщо ви знайомі з базою даних у реальному часі Firebase, Firestore має багато подібностей, але з іншим (можливо більш декларативним) API.

Ось деякі функції, які Firestore пропонує до таблиці:

⚡️ Легко отримуйте дані в режимі реального часу

Подібно до бази даних Firebase у реальному часі, Firestore пропонує такі корисні методи, як .onSnapshot (), які змушують слухати оновлення ваших даних у режимі реального часу. Це робить Firestore ідеальним вибором для проектів, які надають перевагу відображенню та використанню найсвіжіших даних (наприклад, програми для чату).

? Гнучкість як база даних NoSQL

Firestore - це дуже гнучкий варіант для бекенда, оскільки це база даних NoSQL. NoSQL означає, що дані не зберігаються в таблицях і стовпцях, як це було б у стандартній базі даних SQL. Він структурований як сховище ключ-значення, ніби це один великий об'єкт JavaScript.

Іншими словами, немає схеми або потрібно описувати, які дані буде зберігати наша база даних. Поки ми надаємо дійсні ключі та значення, Firestore зберігатиме їх.

↕️ Легко масштабований

Однією з великих переваг вибору Firestore для вашої бази даних є дуже потужна інфраструктура, на якій вона базується, що дозволяє дуже легко масштабувати вашу програму. Як вертикально, так і горизонтально. Незалежно від того, чи є у вас сотні чи мільйони користувачів. Сервери Google зможуть обробляти будь-яке навантаження, яке ви на нього покладете.

Коротше кажучи, Firestore - чудовий варіант для малих і великих додатків. Для невеликих додатків це потужне рішення, оскільки ми можемо зробити багато, не вимагаючи особливих налаштувань, і дуже швидко створювати з ними проекти. Firestore добре підходить для великих проектів завдяки своїй масштабованості.

Налаштування Firestore у проекті JavaScript

Ми будемо використовувати Firestore SDK для JavaScript. У цій шпаргалці ми розглянемо, як використовувати Firestore у контексті проекту JavaScript. Незважаючи на це, концепції, які ми тут розглянемо, легко перенести в будь-яку з доступних клієнтських бібліотек Firestore.

Щоб розпочати роботу з Firestore, ми перейдемо до консолі Firebase. Ви можете відвідати це, перейшовши на firebase.google.com. Для входу потрібно мати обліковий запис Google.

Після входу в систему ми створимо новий проект і дамо йому назву.

Після створення нашого проекту ми його відберемо. Після цього на інформаційній панелі нашого проекту ми виберемо кнопку коду.

Це дасть нам код, необхідний для інтеграції Firestore з нашим проектом JavaScript.

Зазвичай, якщо ви налаштовуєте це в будь-якій програмі JavaScript, ви хочете помістити це у спеціальний файл, який називається firebase.js. Якщо ви використовуєте будь-яку бібліотеку JavaScript, яка має файл package.json, вам потрібно встановити залежність Firebase за допомогою npm або yarn.

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

Firestore можна використовувати як на клієнті, так і на сервері. Якщо ви використовуєте Firestore з Node, вам потрібно буде використовувати синтаксис CommonJS з require. В іншому випадку, якщо ви використовуєте JavaScript у клієнті, ви імпортуєте firebase за допомогою модулів 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);

Колекції та документи Firestore

Для розуміння того, як працювати з Firestore, є два ключові терміни: документи та колекції .

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.

Я рекомендую створити спеціальну змінну для зберігання єдиного посилання на Firestore. Це допомагає зменшити кількість коду, який ви пишете у своєму додатку.

const db = firebase.firestore(); 
Однак у цій шпаргалці я збираюся дотримуватися методу firestore кожного разу, щоб бути якомога чіткішим.

Для посилання на колекцію ми використовуємо .collection()метод і в якості аргументу надаємо ідентифікатор колекції. Щоб отримати посилання на створену нами колекцію книг, просто введіть рядок „книги”.

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

Щоб отримати всі дані документа зі збірки, ми можемо застосувати .get()метод.

.get()повертає обіцянку, що означає, що ми можемо вирішити її або за допомогою .then()зворотного виклику, або ми можемо використовувати синтаксис async-await, якщо ми виконуємо наш код в рамках функції асинхронізації.

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.

Корисним у використанні .update()є те, що, на відміну від цього .set(), він не перезапише весь документ. Крім того .set(), нам потрібно посилатися на окремий документ.

Коли ви використовуєте .update(), важливо використовувати певну обробку помилок, наприклад .catch()зворотний виклик, якщо документ не існує.

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

Видалення даних за допомогою .delete ()

Ми можемо видалити дану колекцію документів, посилаючись на неї за ідентифікатором та виконуючи .delete()простий метод. Це також повертає обіцянку.

Ось основний приклад видалення книги з ідентифікатором "інша книга":

firebase .firestore() .collection("books") .doc("another book") .delete() .then(() => console.log("Document deleted")) // Document deleted .catch((error) => console.error("Error deleting document", error));
Зверніть увагу, що офіційна документація Firestore не рекомендує видаляти цілі колекції, лише окремі документи.

Робота з підколекціями

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.

Ми можемо використовувати будь-який з наступних операторів, і поля, які ми використовуємо, можуть бути примітивними значеннями, а також масивами.

<, <=, ==, >, >=, array-contains, in, Абоarray-contains-any

Щоб отримати всіх користувачів, які подали більше однієї книги, ми можемо використати такий запит.

Після того, як .where()нам потрібно прикути .get(). Після вирішення нашої обіцянки ми повертаємо те, що називається querySnapshot .

Подібно до отримання колекції, ми можемо перебирати querySnapshot, .map()щоб отримати ідентифікатор кожного документа та дані (поля):

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 } ] });
Зверніть увагу, що .where()для створення складених запитів ви можете застосувати кілька методів.

Обмеження та впорядкування запитів

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