1. Omówienie
W ramach tego ćwiczenia w programie poznasz podstawy Firebase do tworzenia interaktywnych aplikacji internetowych. Za pomocą kilku usług Firebase utworzysz odpowiedź na zaproszenie i aplikację czatu z księgą gości.
Czego się nauczysz
- Uwierzytelniaj użytkowników za pomocą Uwierzytelniania Firebase i interfejsu FirebaseUI.
- Synchronizuj dane przy użyciu Cloud Firestore.
- Zapis reguł zabezpieczeń Firebase w celu zabezpieczenia bazy danych.
Czego potrzebujesz
- wybraną przeglądarkę, na przykład Chrome;
- Dostęp do strony stackblitz.com (bez logowania się i konta).
- Konto Google, np. konto Gmail. Zalecamy użycie konta e-mail, którego używasz już w przypadku konta GitHub. Pozwoli Ci to korzystać z zaawansowanych funkcji StackBlitz.
- Przykładowy kod z ćwiczeń w Codelabs. Aby uzyskać kod, przejdź do kolejnego kroku.
2. Pobierz kod początkowy
W ramach tego ćwiczenia w programie utworzysz aplikację za pomocą StackBlitz – edytora online ze zintegrowanym kilkoma przepływami pracy Firebase. Stackblitz nie wymaga instalacji oprogramowania ani specjalnego konta StackBlitz.
StackBlitz pozwala udostępniać projekty innym osobom. Inne osoby, które znają adres URL Twojego projektu StackBlitz, mogą zobaczyć Twój kod i utworzyć rozwidlenie projektu, ale nie mogą edytować Twojego projektu w StackBlitz.
- Kod początkowy znajdziesz na stronie https://stackblitz.com/edit/firebase-gtk-web-start.
- U góry strony StackBlitz kliknij Fork:
Masz teraz kopię kodu początkowego jako własny projekt StackBlitz, który ma unikalną nazwę i unikalny URL. Wszystkie Twoje pliki i zmiany są zapisywane w tym projekcie StackBlitz.
3. Edytuj informacje o zdarzeniu
Materiały początkowe do tego ćwiczenia z programowania zawierają strukturę aplikacji internetowej, w tym arkusze stylów i kilka kontenerów HTML. W dalszej części tego ćwiczenia w programie połączysz te kontenery z Firebase.
Zacznijmy od zapoznania się z interfejsem StackBlitz.
- W StackBlitz otwórz plik
index.html
. - Odszukaj
event-details-container
idescription-container
, a następnie spróbuj edytować niektóre szczegóły wydarzenia.
Gdy edytujesz tekst, automatyczne ponowne załadowanie strony w StackBlitz spowoduje wyświetlenie szczegółów nowego wydarzenia. Fajne, tak?
<!-- ... -->
<div id="app">
<img src="..." />
<section id="event-details-container">
<h1>Firebase Meetup</h1>
<p><i class="material-icons">calendar_today</i> October 30</p>
<p><i class="material-icons">location_city</i> San Francisco</p>
</section>
<hr>
<section id="firebaseui-auth-container"></section>
<section id="description-container">
<h2>What we'll be doing</h2>
<p>Join us for a day full of Firebase Workshops and Pizza!</p>
</section>
</div>
<!-- ... -->
Podgląd aplikacji powinien wyglądać mniej więcej tak:
Podgląd aplikacji
4. Tworzenie i konfigurowanie projektu Firebase
Wyświetlanie informacji o wydarzeniach jest bardzo przydatne dla gości, ale samo pokazywanie informacji o wydarzeniach nie jest dla nikogo zbyt przydatne. Dodajmy do tej aplikacji kilka funkcji dynamicznych. Aby to zrobić, musisz połączyć Firebase ze swoją aplikacją. Aby zacząć korzystać z Firebase, musisz utworzyć i skonfigurować projekt Firebase.
Tworzenie projektu Firebase
- Zaloguj się w Firebase.
- W konsoli Firebase kliknij Dodaj projekt (lub Utwórz projekt) i nadaj projektowi Firebase nazwę Firebase-Web-Codelab.
- Klikaj opcje tworzenia projektów. Zaakceptuj warunki korzystania z Firebase, jeśli pojawi się taka prośba. Na ekranie Google Analytics kliknij „Nie włączaj”, ponieważ nie będziesz korzystać z Analytics w tej aplikacji.
Więcej informacji o projektach Firebase znajdziesz w artykule Omówienie projektów Firebase.
Włączanie i konfigurowanie usług Firebase w konsoli
Tworzona aplikacja korzysta z kilku usług Firebase dostępnych dla aplikacji internetowych:
- Uwierzytelnianie Firebase i interfejs Firebase ułatwiające użytkownikom logowanie się w Twojej aplikacji.
- Cloud Firestore pozwala zapisywać uporządkowane dane w chmurze i otrzymywać natychmiastowe powiadomienia o zmianach danych.
- Reguły zabezpieczeń Firebase, które zabezpieczą bazę danych.
Niektóre z tych usług wymagają specjalnej konfiguracji lub trzeba włączyć je w konsoli Firebase.
Włączanie logowania przez e-mail w Uwierzytelnianiu Firebase
Aby umożliwić użytkownikom logowanie się w aplikacji internetowej, w tym ćwiczeniu z programowania wykorzystasz metodę logowania E-mail/hasło:
- W panelu bocznym po lewej stronie konsoli Firebase kliknij Kompilacja > Authentication (Uwierzytelnianie). Następnie kliknij Get Started (Rozpocznij). Zostanie otwarty panel uwierzytelniania, w którym możesz wyświetlić zarejestrowanych użytkowników, skonfigurować dostawców logowania i zarządzać ustawieniami.
- Wybierz kartę Metoda logowania (lub kliknij tutaj, aby przejść bezpośrednio do tej karty).
- W opcjach dostawcy kliknij E-mail/hasło, ustaw przełącznik w pozycji Włącz, a potem kliknij Zapisz.
Konfigurowanie Cloud Firestore
Aplikacja internetowa używa Cloud Firestore do zapisywania wiadomości czatu i odbierania nowych wiadomości.
Aby skonfigurować Cloud Firestore:
- W panelu bocznym po lewej stronie konsoli Firebase kliknij Kompilacja > Baza danych Firestore. Następnie kliknij Utwórz bazę danych.
- Kliknij Utwórz bazę danych.
- Kliknij opcję Rozpocznij w trybie testowym. Przeczytaj wyłączenie odpowiedzialności dotyczące reguł zabezpieczeń. Tryb testowy umożliwia swobodne zapisywanie w bazie danych podczas programowania. Kliknij Dalej.
- Wybierz lokalizację bazy danych (możesz po prostu użyć lokalizacji domyślnej). Pamiętaj, że tej lokalizacji nie można później zmienić.
- Kliknij Gotowe.
5. Dodaj i skonfiguruj Firebase
Po utworzeniu projektu Firebase i włączeniu niektórych usług musisz wskazać kodowi, że chcesz używać Firebase, i wskazać projekt Firebase, którego chcesz użyć.
Dodawanie bibliotek Firebase
Aby Twoja aplikacja mogła korzystać z Firebase, musisz dodać do niej biblioteki Firebase. Możesz to zrobić na kilka sposobów zgodnie z opisem w dokumentacji Firebase. Możesz na przykład dodać biblioteki z sieci CDN Google lub zainstalować je lokalnie przy użyciu npm, a następnie spakować je w swojej aplikacji, jeśli używasz Browserify.
StackBlitz automatycznie scala się w pakiety, więc możesz dodawać biblioteki Firebase za pomocą instrukcji importowania. Będziesz korzystać z modułowych wersji bibliotek (v9), które pomagają zmniejszyć ogólny rozmiar strony internetowej w ramach procesu zwanego „potrząsaniem drzewa”. Więcej informacji o modułowych pakietach SDK znajdziesz w dokumentacji.
Do utworzenia tej aplikacji użyjesz bibliotek Uwierzytelniania Firebase, FirebaseUI i Cloud Firestore. Na potrzeby tych ćwiczeń w programie podane niżej instrukcje importowania znajdują się już na początku pliku index.js
, a w miarę rozwoju będziemy importować kolejne metody z każdej biblioteki Firebase:
// Import stylesheets
import './style.css';
// Firebase App (the core Firebase SDK) is always required
import { initializeApp } from 'firebase/app';
// Add the Firebase products and methods that you want to use
import {} from 'firebase/auth';
import {} from 'firebase/firestore';
import * as firebaseui from 'firebaseui';
Dodawanie aplikacji internetowej Firebase do projektu Firebase
- Z powrotem w konsoli Firebase otwórz stronę przeglądu projektu, klikając w lewym górnym rogu Przegląd projektu.
- Na środku strony przeglądu projektu kliknij ikonę witryny , aby utworzyć nową aplikację internetową Firebase.
- Zarejestruj aplikację pod pseudonimem Web App (Aplikacja internetowa).
- W przypadku tego ćwiczenia w programie NIE zaznaczaj pola Również skonfiguruj Hosting Firebase dla tej aplikacji. Teraz użyjesz panelu podglądu StackBlitz.
- Kliknij Zarejestruj aplikację.
- Skopiuj obiekt konfiguracyjny Firebase do schowka.
- Kliknij Przejdź do konsoli.Dodaj do swojej aplikacji obiekt konfiguracji Firebase:
- Wróć do StackBlitz, przejdź do pliku
index.js
. - Znajdź wiersz komentarza
Add Firebase project configuration object here
i wklej fragment kodu konfiguracji tuż pod komentarzem. - Dodaj wywołanie funkcji
initializeApp
, aby skonfigurować Firebase, korzystając z unikalnej konfiguracji projektu Firebase.// ... // Add Firebase project configuration object here const firebaseConfig = { apiKey: "random-unique-string", authDomain: "your-projectId.firebaseapp.com", databaseURL: "https://your-projectId.firebaseio.com", projectId: "your-projectId", storageBucket: "your-projectId.appspot.com", messagingSenderId: "random-unique-string", appId: "random-unique-string", }; // Initialize Firebase initializeApp(firebaseConfig);
6. Dodaj logowanie użytkownika (odpowiedź)
Po dodaniu Firebase do aplikacji możesz skonfigurować przycisk odpowiedzi, który spowoduje zarejestrowanie osób korzystających z uwierzytelniania Firebase.
Uwierzytelnianie użytkowników za pomocą logowania przez e-maila i interfejsu FirebaseUI
Musisz mieć przycisk odpowiedzi, który powoduje wyświetlenie prośby o zalogowanie się za pomocą adresu e-mail użytkownika. Możesz to zrobić, łącząc FirebaseUI z przyciskiem Odpowiedz.FirebaseUI to biblioteka, która oprócz uwierzytelnienia Firebase zawiera gotowy interfejs użytkownika.
FirebaseUI wymaga konfiguracji (patrz opcje w dokumentacji), która spełnia 2 czynności:
- Informuje FirebaseUI, że chcesz użyć metody logowania E-mail/hasło.
- Obsługuje wywołanie zwrotne w przypadku udanego logowania i zwraca wartość false, aby uniknąć przekierowania. Nie chcesz odświeżać strony, ponieważ tworzysz aplikację internetową zawierającą jedną stronę.
Dodaj kod, aby zainicjować Uwierzytelnianie FirebaseUI
- W StackBlitz otwórz plik
index.js
. - Na górze znajdź instrukcję importowania
firebase/auth
, a następnie dodajgetAuth
iEmailAuthProvider
w następujący sposób:// ... // Add the Firebase products and methods that you want to use import { getAuth, EmailAuthProvider } from 'firebase/auth'; import {} from 'firebase/firestore';
- Zapisz odwołanie do obiektu uwierzytelniania tuż po
initializeApp
, na przykład:initializeApp(firebaseConfig); auth = getAuth();
- Zwróć uwagę, że konfiguracja FirebaseUI znajduje się już w kodzie początkowym. Dostawca uwierzytelniania poczty e-mail jest już skonfigurowany.
- Na dole funkcji
main()
windex.js
dodaj instrukcję inicjowania FirebaseUI w następujący sposób:async function main() { // ... // Initialize the FirebaseUI widget using Firebase const ui = new firebaseui.auth.AuthUI(auth); } main();
Dodaj przycisk odpowiedzi do kodu HTML
- W StackBlitz otwórz plik
index.html
. - Dodaj kod HTML przycisku odpowiedzi w elemencie
event-details-container
, jak pokazano w poniższym przykładzie.
Pamiętaj, aby użyć tych samych wartościid
co poniżej, ponieważ na potrzeby tego ćwiczenia z programowania w plikuindex.js
znajdują się już punkty zaczepienia dla tych konkretnych identyfikatorów.
Pamiętaj, że w plikuindex.html
znajduje się kontener o identyfikatorzefirebaseui-auth-container
. Jest to identyfikator, który przekażesz do FirebaseUI w celu przechowywania danych logowania. Podgląd aplikacji<!-- ... --> <section id="event-details-container"> <!-- ... --> <!-- ADD THE RSVP BUTTON HERE --> <button id="startRsvp">RSVP</button> </section> <hr> <section id="firebaseui-auth-container"></section> <!-- ... -->
- Skonfiguruj odbiornik na przycisku Odpowiedz i wywołaj funkcję uruchamiania FirebaseUI. Informuje to FirebaseUI, że chcesz wyświetlić okno logowania.
Dodaj ten kod na końcu funkcjimain()
windex.js
:async function main() { // ... // Listen to RSVP button clicks startRsvpButton.addEventListener("click", () => { ui.start("#firebaseui-auth-container", uiConfig); }); } main();
Testowanie logowania się w aplikacji
- W oknie podglądu StackBlitz kliknij przycisk Odpowiedz, aby zalogować się w aplikacji.
- W ramach tego ćwiczenia w Codelabs możesz użyć dowolnego adresu e-mail, nawet fałszywego, ponieważ nie konfigurujesz do weryfikacji adresu e-mail.
- Jeśli pojawi się komunikat o błędzie
auth/operation-not-allowed
lubThe given sign-in provider is disabled for this Firebase project
, sprawdź, czy w konsoli Firebase jest włączona opcja E-mail/hasło.
- W konsoli Firebase otwórz panel Uwierzytelnianie. Na karcie Użytkownicy powinny być widoczne informacje o koncie podane podczas logowania się w aplikacji.
Dodawanie stanu uwierzytelniania do interfejsu użytkownika
Następnie sprawdź, czy interfejs uwzględnia fakt, że udało Ci się zalogować.
Wykorzystasz wywołanie zwrotne detektora stanu Uwierzytelniania Firebase, które jest powiadamiane o każdej zmianie stanu logowania użytkownika. Jeśli dany użytkownik jest zalogowany, Twoja aplikacja zmieni opcję „Odpowiedz” powoduje wylogowanie. Przycisk
- W StackBlitz otwórz plik
index.js
. - Na górze znajdź instrukcję importowania
firebase/auth
, a następnie dodajsignOut
ionAuthStateChanged
w następujący sposób:// ... // Add the Firebase products and methods that you want to use import { getAuth, EmailAuthProvider, signOut, onAuthStateChanged } from 'firebase/auth'; import {} from 'firebase/firestore';
- Dodaj ten kod na dole funkcji
main()
:async function main() { // ... // Listen to the current Auth state onAuthStateChanged(auth, user => { if (user) { startRsvpButton.textContent = 'LOGOUT'; } else { startRsvpButton.textContent = 'RSVP'; } }); } main();
- Sprawdź, czy w detektorze przycisków jest bieżący użytkownik, i wyloguj go. Aby to zrobić, zastąp bieżącą wersję
startRsvpButton.addEventListener
następującym:// ... // Called when the user clicks the RSVP button startRsvpButton.addEventListener('click', () => { if (auth.currentUser) { // User is signed in; allows user to sign out signOut(auth); } else { // No user is signed in; allows user to sign in ui.start('#firebaseui-auth-container', uiConfig); } });
Teraz przycisk w aplikacji powinien pokazywać WYLOGUJ SIĘ. Po kliknięciu powinien z powrotem zmienić się na Odpowiedz.
Podgląd aplikacji
7. Zapisywanie wiadomości w Cloud Firestore
Świadomość, że przychodzą użytkownicy, jest bardzo przydatna, ale warto też dać gościom coś innego do zrobienia w aplikacji. A gdyby mogli zostawić wiadomości w księdze gości? Mogą wyjaśnić, dlaczego chcą wziąć udział w wydarzeniu lub kogo mają nadzieję spotkać.
Do przechowywania wiadomości czatu, które użytkownicy piszą w aplikacji, będziesz używać Cloud Firestore.
Model danych
Cloud Firestore to baza danych NoSQL, w której dane są dzielone na kolekcje, dokumenty, pola i kolekcje podrzędne. Każda wiadomość z czatu będzie przechowywana jako dokument w kolekcji najwyższego poziomu o nazwie guestbook
.
Dodawanie wiadomości do Firestore
W tej sekcji dodasz funkcję umożliwiającą użytkownikom zapisywanie nowych wiadomości w bazie danych. Najpierw dodajesz kod HTML elementów interfejsu (pole wiadomości i przycisk wysyłania). Następnie dodajesz kod łączący te elementy z bazą danych.
Aby dodać elementy interfejsu pola wiadomości i przycisk wysyłania:
- W StackBlitz otwórz plik
index.html
. - Znajdź obiekt
guestbook-container
, a następnie dodaj poniższy kod HTML, aby utworzyć formularz z polem do wprowadzania wiadomości i przyciskiem wysyłania.<!-- ... --> <section id="guestbook-container"> <h2>Discussion</h2> <form id="leave-message"> <label>Leave a message: </label> <input type="text" id="message"> <button type="submit"> <i class="material-icons">send</i> <span>SEND</span> </button> </form> </section> <!-- ... -->
Podgląd aplikacji
Kliknięcie przycisku WYŚLIJ przez użytkownika spowoduje wyświetlenie poniższego fragmentu kodu. Powoduje dodanie zawartości pola do wprowadzania wiadomości do kolekcji guestbook
bazy danych. W szczególności metoda addDoc
dodaje treść wiadomości do nowego dokumentu (z automatycznie generowanym identyfikatorem) do kolekcji guestbook
.
- W StackBlitz otwórz plik
index.js
. - Na górze znajdź instrukcję importowania
firebase/firestore
, a następnie dodajgetFirestore
,addDoc
icollection
w następujący sposób:// ... // Add the Firebase products and methods that you want to use import { getAuth, EmailAuthProvider, signOut, onAuthStateChanged } from 'firebase/auth'; import { getFirestore, addDoc, collection } from 'firebase/firestore';
- Teraz zapiszemy odwołanie do obiektu
db
Firestore zaraz poinitializeApp
:initializeApp(firebaseConfig); auth = getAuth(); db = getFirestore();
- Na dole funkcji
main()
dodaj poniższy kod.
Pamiętaj, żeauth.currentUser.uid
odnosi się do automatycznie wygenerowanego unikalnego identyfikatora, który Uwierzytelnianie Firebase przypisuje wszystkim zalogowanym użytkownikom.async function main() { // ... // Listen to the form submission form.addEventListener('submit', async e => { // Prevent the default form redirect e.preventDefault(); // Write a new message to the database collection "guestbook" addDoc(collection(db, 'guestbook'), { text: input.value, timestamp: Date.now(), name: auth.currentUser.displayName, userId: auth.currentUser.uid }); // clear message input field input.value = ''; // Return false to avoid redirect return false; }); } main();
Pokazuj księgę gości tylko zalogowanym użytkownikom
Nie chcesz, aby tylko każdy widział wystawę Twoich gości. czatu. Jedną z opcji, które możesz zrobić, aby zabezpieczyć czat, jest zezwolenie na wyświetlanie księgi gości tylko zalogowanym użytkownikom. W przypadku własnych aplikacji warto też zabezpieczyć swoją bazę danych za pomocą reguł zabezpieczeń Firebase. Więcej informacji o regułach zabezpieczeń znajdziesz w dalszej części ćwiczeń z programowania.
- W StackBlitz otwórz plik
index.js
. - Edytuj detektor
onAuthStateChanged
, aby ukryć lub wyświetlić księgę gości.// ... // Listen to the current Auth state onAuthStateChanged(auth, user => { if (user) { startRsvpButton.textContent = 'LOGOUT'; // Show guestbook to logged-in users guestbookContainer.style.display = 'block'; } else { startRsvpButton.textContent = 'RSVP'; // Hide guestbook for non-logged-in users guestbookContainer.style.display = 'none'; } });
Testowanie wysyłania wiadomości
- Zaloguj się w aplikacji.
- Wpisz wiadomość, np. „Cześć!”, a potem kliknij WYŚLIJ.
To działanie spowoduje zapisanie wiadomości w bazie danych Cloud Firestore. Nie zobaczysz jednak jeszcze komunikatu w aplikacji internetowej, ponieważ nadal musisz zaimplementować pobieranie danych. Zrobisz to w następnej kolejności.
Nowo dodaną wiadomość możesz jednak zobaczyć w konsoli Firebase.
W konsoli Firebase, w panelu Baza danych Firestore, powinna być widoczna kolekcja guestbook
z nowo dodaną wiadomością. Jeśli nadal będziesz wysyłać wiadomości, kolekcja księgi gości będzie zawierać wiele dokumentów, na przykład:
Konsola Firebase
8. Czytanie wiadomości
Synchronizowanie wiadomości
To świetnie, że goście mogą zapisywać wiadomości w bazie danych, ale nie mogą ich jeszcze zobaczyć w aplikacji.
Aby wyświetlać wiadomości, musisz dodać detektory, które uruchamiają się po zmianie danych, a następnie utworzyć element interfejsu pokazujący nowe wiadomości.
Dodasz kod, który nasłuchuje nowo dodanych wiadomości z aplikacji. Najpierw dodaj sekcję w kodzie HTML, aby wyświetlać wiadomości:
- W StackBlitz otwórz plik
index.html
. - W usłudze
guestbook-container
dodaj nową sekcję o identyfikatorzeguestbook
.<!-- ... --> <section id="guestbook-container"> <h2>Discussion</h2> <form><!-- ... --></form> <section id="guestbook"></section> </section> <!-- ... -->
Następnie zarejestruj detektor, który nasłuchuje zmian wprowadzonych w danych:
- W StackBlitz otwórz plik
index.js
. - Na górze znajdź instrukcję importowania
firebase/firestore
, a następnie dodajquery
,orderBy
ionSnapshot
w następujący sposób:// ... import { getFirestore, addDoc, collection, query, orderBy, onSnapshot } from 'firebase/firestore';
- Na dole funkcji
main()
dodaj poniższy kod, aby przewijać wszystkie dokumenty (wiadomości księgi gości) w bazie danych. Aby dowiedzieć się więcej o tym, co się dzieje w tym kodzie, przeczytaj informacje pod nim.async function main() { // ... // Create query for messages const q = query(collection(db, 'guestbook'), orderBy('timestamp', 'desc')); onSnapshot(q, snaps => { // Reset page guestbook.innerHTML = ''; // Loop through documents in database snaps.forEach(doc => { // Create an HTML entry for each document and add it to the chat const entry = document.createElement('p'); entry.textContent = doc.data().name + ': ' + doc.data().text; guestbook.appendChild(entry); }); }); } main();
Aby nasłuchiwać wiadomości w bazie danych, utworzyłeś zapytanie do określonego zbioru za pomocą funkcji collection
. Powyższy kod nasłuchuje zmian w kolekcji guestbook
, w której są przechowywane wiadomości czatu. Wiadomości są też uporządkowane według daty. orderBy('timestamp', 'desc')
powoduje wyświetlanie najnowszych wiadomości u góry.
Funkcja onSnapshot
przyjmuje 2 parametry: zapytanie i funkcję wywołania zwrotnego. Funkcja wywołania zwrotnego jest wyzwalana po wprowadzeniu jakichkolwiek zmian w dokumentach, które pasują do zapytania. Może się tak zdarzyć, gdy wiadomość zostanie usunięta, zmodyfikowana lub dodana. Więcej informacji znajdziesz w dokumentacji Cloud Firestore.
Testowanie synchronizacji wiadomości
Cloud Firestore automatycznie i natychmiast synchronizuje dane z klientami subskrybującymi bazę danych.
- Komunikaty utworzone wcześniej w bazie danych powinny być wyświetlane w aplikacji. Możesz pisać nowe wiadomości. powinna pojawić się od razu.
- Jeśli otworzysz obszar roboczy w wielu oknach lub kartach, wiadomości będą synchronizowane w czasie rzeczywistym między kartami.
- (Opcjonalnie) Możesz ręcznie usunąć, zmodyfikować lub dodać nowe wiadomości bezpośrednio w sekcji Baza danych w konsoli Firebase. wszelkie zmiany powinny być widoczne w interfejsie.
Gratulacje! Odczytujesz dokumenty z Cloud Firestore w swojej aplikacji.
Podgląd aplikacji
9. Konfigurowanie podstawowych reguł zabezpieczeń
Początkowo skonfigurowano Cloud Firestore tak, aby używał trybu testowego, co oznacza, że baza danych jest otwarta dla odczytów i zapisów. Z trybu testowego należy jednak korzystać tylko na bardzo wczesnych etapach programowania. Zalecamy skonfigurowanie reguł zabezpieczeń bazy danych podczas tworzenia aplikacji. Bezpieczeństwo powinno być nieodłączną częścią struktury i działania aplikacji.
Reguły zabezpieczeń pozwalają kontrolować dostęp do dokumentów i kolekcji w bazie danych. Elastyczna składnia reguł umożliwia tworzenie reguł, które dopasowują wszystko – od wszystkich zapisów przez całą bazę danych po operacje na określonym dokumencie.
Reguły zabezpieczeń dla Cloud Firestore możesz napisać w konsoli Firebase:
- W sekcji Tworzenie konsoli Firebase kliknij Firestore Database (Baza danych Firestore), a następnie wybierz kartę Rules (Reguły) (lub kliknij tutaj, aby przejść bezpośrednio do karty Reguły).
- Powinny się wyświetlić poniższe domyślne reguły zabezpieczeń z limitem czasu dostępu publicznego sprzed kilku tygodni.
Identyfikowanie kolekcji
Najpierw określ kolekcje, w których aplikacja zapisuje dane.
- Usuń istniejącą klauzulę
match /{document=**}
, aby Twoje reguły wyglądały tak:rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { } }
- W narzędziu
match /databases/{database}/documents
zidentyfikuj kolekcję, którą chcesz zabezpieczyć:rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { match /guestbook/{entry} { // You'll add rules here in the next step. } }
Dodawanie reguł zabezpieczeń
Ponieważ identyfikator UID uwierzytelniania został użyty jako pole w każdym dokumencie księgi gości, możesz uzyskać ten identyfikator i sprawdzić, czy każda osoba próbująca zapisywać dane do dokumentu ma zgodny identyfikator UID uwierzytelniania.
- Dodaj reguły odczytu i zapisu do swojego zestawu reguł w następujący sposób:
rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { match /guestbook/{entry} { allow read: if request.auth.uid != null; allow create: if request.auth.uid == request.resource.data.userId; } } }
- Kliknij Opublikuj, aby wdrożyć nowe reguły.Teraz w przypadku księgi gości tylko zalogowani użytkownicy mogą czytać wiadomości (dowolne wiadomości), ale możesz utworzyć wiadomość tylko przy użyciu swojego identyfikatora użytkownika. Nie zezwalamy też na edytowanie ani usuwanie wiadomości.
Dodawanie reguł weryfikacji
- Dodaj funkcję sprawdzania poprawności danych, aby upewnić się, że w dokumencie znajdują się wszystkie oczekiwane pola:
rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { match /guestbook/{entry} { allow read: if request.auth.uid != null; allow create: if request.auth.uid == request.resource.data.userId && "name" in request.resource.data && "text" in request.resource.data && "timestamp" in request.resource.data; } } }
- Kliknij Opublikuj, aby wdrożyć nowe reguły.
Resetowanie detektorów
Twoja aplikacja umożliwia teraz logowanie się tylko uwierzytelnionym użytkownikom, dlatego należy przenieść zapytanie firestore
księgi gości do detektora uwierzytelniania. W przeciwnym razie wystąpią błędy uprawnień, a aplikacja zostanie odłączona, gdy użytkownik się wyloguje.
- W StackBlitz otwórz plik
index.js
. - Pobierz detektor
onSnapshot
kolekcji księgi gości do nowej funkcji o nazwiesubscribeGuestbook
. Przypisz też wyniki funkcjionSnapshot
do zmiennejguestbookListener
.
DetektoronSnapshot
Firestore zwraca funkcję anulowania subskrypcji, której będzie można później użyć do anulowania detektora zrzutów.// ... // Listen to guestbook updates function subscribeGuestbook() { const q = query(collection(db, 'guestbook'), orderBy('timestamp', 'desc')); guestbookListener = onSnapshot(q, snaps => { // Reset page guestbook.innerHTML = ''; // Loop through documents in database snaps.forEach(doc => { // Create an HTML entry for each document and add it to the chat const entry = document.createElement('p'); entry.textContent = doc.data().name + ': ' + doc.data().text; guestbook.appendChild(entry); }); }); }
- Pod spodem dodaj nową funkcję o nazwie
unsubscribeGuestbook
. Sprawdź, czy zmiennaguestbookListener
nie ma wartości null, a następnie wywołaj funkcję, aby anulować detektor.// ... // Unsubscribe from guestbook updates function unsubscribeGuestbook() { if (guestbookListener != null) { guestbookListener(); guestbookListener = null; } }
Na koniec dodaj nowe funkcje do wywołania zwrotnego onAuthStateChanged
.
- Dodaj
subscribeGuestbook()
na doleif (user)
. - Dodaj
unsubscribeGuestbook()
na dole instrukcjielse
.// ... // Listen to the current Auth state onAuthStateChanged(auth, user => { if (user) { startRsvpButton.textContent = 'LOGOUT'; // Show guestbook to logged-in users guestbookContainer.style.display = 'block'; // Subscribe to the guestbook collection subscribeGuestbook(); } else { startRsvpButton.textContent = 'RSVP'; // Hide guestbook for non-logged-in users guestbookContainer.style.display = 'none'; // Unsubscribe from the guestbook collection unsubscribeGuestbook(); } });
10. Dodatkowy krok: ćwicz zdobytą wiedzę w praktyce
Nagrywanie stanu odpowiedzi uczestnika
Obecnie Twoja aplikacja umożliwia tylko rozpoczęcie rozmowy przez osoby zainteresowane wydarzeniem. O przyjeździe można się dowiedzieć tylko, gdy ktoś opublikuje tę wiadomość na czacie. Zorganizujmy się i powiadommy, ile osób weźmie udział.
Dodasz przełącznik, aby zarejestrować osoby, które chcą wziąć udział w wydarzeniu, a potem zliczać, ile osób weźmie udział.
- W StackBlitz otwórz plik
index.html
. - W
guestbook-container
dodaj zestaw przycisków TAK i NIE, na przykład:<!-- ... --> <section id="guestbook-container"> <h2>Are you attending?</h2> <button id="rsvp-yes">YES</button> <button id="rsvp-no">NO</button> <h2>Discussion</h2> <!-- ... --> </section> <!-- ... -->
Podgląd aplikacji
Następnie zarejestruj odbiornik kliknięć przycisków. Jeśli użytkownik kliknie TAK, użyj identyfikatora UID uwierzytelniania, aby zapisać odpowiedź w bazie danych.
- W StackBlitz otwórz plik
index.js
. - Na górze znajdź instrukcję importowania
firebase/firestore
, a następnie dodajdoc
,setDoc
iwhere
w następujący sposób:// ... // Add the Firebase products and methods that you want to use import { getFirestore, addDoc, collection, query, orderBy, onSnapshot, doc, setDoc, where } from 'firebase/firestore';
- Na dole funkcji
main()
dodaj ten kod, aby nasłuchiwać stanu odpowiedzi:async function main() { // ... // Listen to RSVP responses rsvpYes.onclick = async () => { }; rsvpNo.onclick = async () => { }; } main();
- Następnie utwórz nową kolekcję o nazwie
attendees
, a potem zarejestruj odniesienie do dokumentu po kliknięciu dowolnego przycisku odpowiedzi. Ustaw odwołanie natrue
lubfalse
, w zależności od tego, który przycisk został kliknięty.
Najpierw, w domeniersvpYes
: Później to samo dla// ... // Listen to RSVP responses rsvpYes.onclick = async () => { // Get a reference to the user's document in the attendees collection const userRef = doc(db, 'attendees', auth.currentUser.uid); // If they RSVP'd yes, save a document with attendi()ng: true try { await setDoc(userRef, { attending: true }); } catch (e) { console.error(e); } };
rsvpNo
, ale z wartościąfalse
:rsvpNo.onclick = async () => { // Get a reference to the user's document in the attendees collection const userRef = doc(db, 'attendees', auth.currentUser.uid); // If they RSVP'd yes, save a document with attending: true try { await setDoc(userRef, { attending: false }); } catch (e) { console.error(e); } };
Aktualizowanie reguł zabezpieczeń
Ponieważ masz już skonfigurowane pewne reguły, nowe dane dodawane za pomocą przycisków zostaną odrzucone.
Zezwalaj na dodawanie elementów do kolekcji attendees
Musisz zaktualizować reguły, aby umożliwić dodawanie plików do kolekcji attendees
.
- W przypadku kolekcji
attendees
używasz identyfikatora UID uwierzytelniania jako nazwy dokumentu, możesz więc pobrać ten identyfikator i sprawdzić, czyuid
osoby przesyłającej jest taki sam jak dokument, który pisze. Zezwalasz wszystkim na czytanie listy uczestników (ponieważ nie ma tam danych prywatnych), ale tylko twórca powinien mieć możliwość aktualizowania listy.rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { // ... // match /attendees/{userId} { allow read: if true; allow write: if request.auth.uid == userId; } } }
- Kliknij Opublikuj, aby wdrożyć nowe reguły.
Dodawanie reguł weryfikacji
- Dodaj reguły sprawdzania poprawności danych, aby upewnić się, że w dokumencie znajdują się wszystkie oczekiwane pola:
rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { // ... // match /attendees/{userId} { allow read: if true; allow write: if request.auth.uid == userId && "attending" in request.resource.data; } } }
- Nie zapomnij kliknąć Opublikuj, aby wdrożyć reguły.
(Opcjonalnie) Możesz teraz wyświetlić wyniki kliknięcia przycisków. Otwórz panel Cloud Firestore w konsoli Firebase.
Odczytywanie stanu odpowiedzi
Po zarejestrowaniu odpowiedzi zobaczmy, kto weźmie udział w spotkaniu, i zobaczmy, co będzie się działo w interfejsie.
- W StackBlitz otwórz plik
index.html
. - W polu
description-container
dodaj nowy element o identyfikatorzenumber-attending
.<!-- ... --> <section id="description-container"> <!-- ... --> <p id="number-attending"></p> </section> <!-- ... -->
Następnie zarejestruj detektor kolekcji attendees
i policz liczbę odpowiedzi TAK:
- W StackBlitz otwórz plik
index.js
. - Na dole funkcji
main()
dodaj poniższy kod, aby odsłuchać stan odpowiedzi i zliczyć kliknięcia TAK.async function main() { // ... // Listen for attendee list const attendingQuery = query( collection(db, 'attendees'), where('attending', '==', true) ); const unsubscribe = onSnapshot(attendingQuery, snap => { const newAttendeeCount = snap.docs.length; numberAttending.innerHTML = newAttendeeCount + ' people going'; }); } main();
Na koniec zaznaczmy przycisk odpowiadający aktualnemu stanowi.
- Utwórz funkcję, która sprawdza, czy bieżący identyfikator UID uwierzytelniania zawiera wpis w kolekcji
attendees
, a następnie ustaw klasę przycisku naclicked
.// ... // Listen for attendee list function subscribeCurrentRSVP(user) { const ref = doc(db, 'attendees', user.uid); rsvpListener = onSnapshot(ref, doc => { if (doc && doc.data()) { const attendingResponse = doc.data().attending; // Update css classes for buttons if (attendingResponse) { rsvpYes.className = 'clicked'; rsvpNo.className = ''; } else { rsvpYes.className = ''; rsvpNo.className = 'clicked'; } } }); }
- Utwórzmy też funkcję anulowania subskrypcji. Ta nazwa będzie używana, gdy użytkownik się wyloguje.
// ... function unsubscribeCurrentRSVP() { if (rsvpListener != null) { rsvpListener(); rsvpListener = null; } rsvpYes.className = ''; rsvpNo.className = ''; }
- Wywołaj funkcje z detektora uwierzytelniania.
// ... // Listen to the current Auth state // Listen to the current Auth state onAuthStateChanged(auth, user => { if (user) { startRsvpButton.textContent = 'LOGOUT'; // Show guestbook to logged-in users guestbookContainer.style.display = 'block'; // Subscribe to the guestbook collection subscribeGuestbook(); // Subscribe to the user's RSVP subscribeCurrentRSVP(user); } else { startRsvpButton.textContent = 'RSVP'; // Hide guestbook for non-logged-in users guestbookContainer.style.display = 'none' ; // Unsubscribe from the guestbook collection unsubscribeGuestbook(); // Unsubscribe from the guestbook collection unsubscribeCurrentRSVP(); } });
- Spróbuj zalogować się jako wielu użytkowników i zobacz, jak liczba użytkowników wzrasta po każdym kliknięciu dodatkowego przycisku TAK.
Podgląd aplikacji
11. Gratulacje!
Udało Ci się wykorzystać Firebase do stworzenia interaktywnej aplikacji internetowej działającej w czasie rzeczywistym.
Omówione zagadnienia
- Uwierzytelnianie Firebase
- Interfejs Firebase
- Cloud Firestore
- Reguły zabezpieczeń Firebase
Dalsze kroki
- Chcesz dowiedzieć się więcej o przepływie pracy programistów w Firebase? Zapoznaj się z ćwiczeniem z programowania w narzędziu emulator Firebase, aby dowiedzieć się, jak przetestować i całkowicie uruchomić aplikację lokalnie.
- Chcesz dowiedzieć się więcej o innych usługach Firebase? A może chcesz przechowywać pliki graficzne przesłane przez użytkowników? Albo wysłać powiadomienia do użytkowników? Zapoznaj się z internetowymi ćwiczeniami z programowania Firebase. Znajdziesz w nich więcej informacji o wielu innych usługach internetowych Firebase.
- Chcesz dowiedzieć się więcej o Cloud Firestore? Może chcesz dowiedzieć się więcej o podkolekcjach i transakcjach? Przejdź do internetowych ćwiczeń z programowania w Cloud Firestore, gdzie znajdziesz więcej informacji o Cloud Firestore. Możesz też obejrzeć tę serię w YouTube, aby poznać Cloud Firestore.
Więcej informacji
- Witryna Firebase: firebase.google.com
- Kanał Firebase w YouTube
Jak ją oceniasz?
Chętnie poznamy Twoją opinię. Wypełnij (bardzo) krótki formularz tutaj.