Firebase и Astro
Firebase — это платформа для разработки приложений, которая предоставляет базу данных NoSQL, аутентификацию, подписки в реальном времени, функции и хранилище.
См. наше отдельное руководство по развертыванию на хостинге Firebase.
Инициализация Firebase в Astro
Заголовок раздела Инициализация Firebase в AstroНеобходимые условия
Заголовок раздела Необходимые условия- Проект Firebase с настроенным веб-приложением.
- Проект Astro с включенным серверным рендерингом (SSR).
- Учетные данные Firebase: Для подключения Astro к Firebase вам понадобятся два набора учетных данных:
- Учетные данные веб-приложения: Эти учетные данные будут использоваться клиентской частью вашего приложения. Вы можете найти их в консоли Firebase в разделе Project settings > General. Прокрутите вниз до раздела Your apps и нажмите на иконку Web app.
- Учетные данные проекта: Эти учетные данные будут использоваться серверной частью вашего приложения. Вы можете сгенерировать их в консоли Firebase в разделе Project settings > Service accounts > Firebase Admin SDK > Generate new private key.
Добавление учетных данных Firebase
Заголовок раздела Добавление учетных данных FirebaseЧтобы добавить учетные данные Firebase в Astro, создайте файл .env
в корне вашего проекта со следующими переменными:
Теперь эти переменные окружения доступны для использования в вашем проекте.
Если вы хотите иметь IntelliSense для переменных окружения Firebase, отредактируйте или создайте файл env.d.ts
в каталоге src/
и настройте свои типы:
Подробнее о переменных окружения и файлах .env
в Astro.
Теперь ваш проект должен включать эти новые файлы:
Директорияsrc/
- env.d.ts
- .env
- astro.config.mjs
- package.json
Установка зависимостей
Заголовок раздела Установка зависимостейЧтобы подключить Astro к Firebase, установите следующие пакеты с помощью команды ниже для предпочитаемого вами менеджера пакетов:
firebase
- Firebase SDK для клиентской частиfirebase-admin
- Firebase Admin SDK для серверной части
Далее создайте папку с именем firebase
в каталоге src/
и добавьте в нее два новых файла: client.ts
и server.ts
.
В client.ts
добавьте следующий код для инициализации Firebase в клиенте с использованием учетных данных веб-приложения и пакета firebase
:
Не забудьте заменить объект firebaseConfig
своими учетными данными веб-приложения.
В server.ts
добавьте следующий код для инициализации Firebase на сервере с использованием учетных данных вашего проекта и пакета firebase-admin
:
Не забудьте заменить объект serviceAccount
на собственные учетные данные проекта.
Наконец, ваш проект теперь должен включать эти новые файлы:
Директорияsrc
- env.d.ts
Директорияfirebase
- client.ts
- server.ts
- .env
- astro.config.mjs
- package.json
Добавление аутентификации с помощью Firebase
Заголовок раздела Добавление аутентификации с помощью FirebaseНеобходимые условия
Заголовок раздела Необходимые условия- Проект Astro инициализированный с Firebase.
- Проект Firebase с включенной аутентификацией по электронной почте/паролю в консоли Firebase в разделе Authentication > Sign-in.
Создание конечных точек сервера аутентификации
Заголовок раздела Создание конечных точек сервера аутентификацииДля аутентификации Firebase в Astro требуются следующие три конечные точки сервера Astro:
GET /api/auth/signin
- для авторизации пользователяGET /api/auth/signout
- для выхода пользователя из системыPOST /api/auth/register
- для регистрации пользователя
Создайте три конечные точки, связанные с аутентификацией, в новой директории src/pages/api/auth/
: signin.ts
, signout.ts
и register.ts
.
signin.ts
содержит код для авторизации пользователя с помощью Firebase:
Это базовая реализация конечной точки входа в систему. Вы можете добавить больше логики к этой конечной точке в соответствии с вашими потребностями.
signout.ts
содержит код для выхода пользователя из системы путем удаления куки сессии:
Это базовая реализация конечной точки signout. Вы можете добавить больше логики к этой конечной точке в соответствии с вашими потребностями.
register.ts
содержит код для регистрации пользователя с помощью Firebase:
Это базовая реализация конечной точки регистрации. Вы можете добавить больше логики к этой конечной точке в соответствии с вашими потребностями.
После создания конечных точек сервера для аутентификации каталог вашего проекта должен содержать эти новые файлы:
Директорияsrc
- env.d.ts
Директорияfirebase
- client.ts
- server.ts
Директорияpages
Директорияapi
Директорияauth
- signin.ts
- signout.ts
- register.ts
- .env
- astro.config.mjs
- package.json
Создание страниц
Заголовок раздела Создание страницСоздайте страницы, которые будут использовать конечные точки Firebase:
src/pages/register
- будет содержать форму для регистрации пользователяsrc/pages/signin
- будет содержать форму для авторизации пользователяsrc/pages/dashboard
- содержит приборную панель, доступ к которой могут получить только авторизованные пользователи.
Пример src/pages/register.astro
, приведенный ниже, содержит форму, которая отправляет POST
запрос к конечной точке /api/auth/register
. Эта конечная точка создаст нового пользователя, используя данные из формы, а затем перенаправит его на страницу /signin
.
src/pages/signin.astro
использует серверное приложение Firebase для проверки куки сессии пользователя. Если пользователь авторизован, страница перенаправляет его на страницу /dashboard
.
Пример страницы ниже содержит форму, которая отправит POST
запрос к конечной точке /api/auth/signin
с ID-токеном, сгенерированным клиентским приложением Firebase.
Конечная точка проверит ID-токен и создаст новую сессионную cookie для пользователя. Затем конечная точка перенаправит пользователя на страницу /dashboard
.
Страница src/pages/dashboard.astro
проверит сессионный куки пользователя с помощью серверного приложения Firebase. Если пользователь не авторизирован, страница перенаправит его на страницу /signin
.
На приведенной ниже странице отображается имя пользователя и кнопка для выхода. При нажатии на кнопку будет отправлен запрос GET
к конечной точке /api/auth/signout
.
Конечная точка удалит куки сессии пользователя и перенаправит его на страницу /signin
.
Добавление провайдеров OAuth
Заголовок раздела Добавление провайдеров OAuthЧтобы добавить провайдеров OAuth в ваше приложение, необходимо включить их в консоли Firebase.
В консоли Firebase перейдите в раздел Authentication и перейдите на вкладку Sign-in method. Затем нажмите на кнопку Add a new provider и включите провайдеров, которых вы хотите использовать.
В примере ниже используется провайдер Google.
Отредактируйте страницу signin.astro
, чтобы добавить:
- кнопку для входа в систему с помощью Google под существующей формой
- Слушатель событий на кнопке для обработки процесса входа в существующую форму
<script>
.
При нажатии на кнопку входа через Google откроется всплывающее окно для входа в систему Google. Как только пользователь войдет в систему, он отправит POST
-запрос на конечную точку /api/auth/signin
с ID-токеном, сгенерированным провайдером OAuth.
Конечная точка проверит ID-токен и создаст новую сессионную куки для пользователя. Затем конечная точка перенаправит пользователя на страницу /dashboard
.
Подключение к базе данных Firestore
Заголовок раздела Подключение к базе данных FirestoreНеобходимые условия
Заголовок раздела Необходимые условия-
Проект Astro, инициализированный с Firebase, как описано в разделе Инициализация Firebase в Astro.
-
Проект Firebase с базой данных Firestore. Вы можете следовать разделу Firebase documentation to create a new project and set up a Firestore database.
В этой инструкции коллекция Firestore будет называться друзья(friends) и содержать документы со следующими полями:
id
: автогенерируется Firestoreимя
: строковое полевозраст
: числовое полеisBestFriend
: булево поле
Создание конечных точек сервера
Заголовок раздела Создание конечных точек сервераСоздайте два новых файла в новой директории src/pages/api/friends/
: index.ts
и [id].ts
. Они создадут две конечные точки сервера для взаимодействия с базой данных Firestore следующими способами:
POST /api/friends
: для создания нового документа в коллекции друзья.POST /api/friends/:id
: для обновления документа в коллекции друзья.DELETE /api/friends/:id
: удалить документ в коллекции друзья.
index.ts
будет содержать код для создания нового документа в коллекции друзья:
Это базовая реализация конечной точки friends
. Вы можете добавить больше логики к этой конечной точке в соответствии с вашими потребностями.
[id].ts
будет содержать код для обновления и удаления документа в коллекции друзья:
Это базовая реализация конечной точки friends/:id
. Вы можете добавить больше логики к этой конечной точке в соответствии с вашими потребностями.
После создания конечных точек сервера для Firestore каталог вашего проекта должен включать эти новые файлы:
Директорияsrc
- env.d.ts
Директорияfirebase
- client.ts
- server.ts
Директорияpages
Директорияapi
Директорияfriends
- index.ts
- [id].ts
- .env
- astro.config.mjs
- package.json
Создание страниц
Заголовок раздела Создание страницСоздайте страницы, которые будут использовать конечные точки Firestore:
src/pages/add.astro
- будет содержать форму для добавления нового друга.src/pages/edit/[id].astro
- будет содержать форму для редактирования друга и кнопку для удаления друга.src/pages/friend/[id].astro
- содержит информацию о друге.src/pages/dashboard.astro
- отображает список друзей.
Добавление новой записи
Заголовок раздела Добавление новой записиПример src/pages/add.astro
ниже содержит форму, которая отправляет POST
запрос к конечной точке /api/friends
. Эта конечная точка создаст нового друга, используя данные из формы, а затем перенаправит пользователя на страницу /dashboard
.
Редактирование или удаление записи
Заголовок раздела Редактирование или удаление записиСтраница rc/pages/edit/[id].astro
будет содержать форму для редактирования данных друга и кнопку для его удаления. При отправке эта страница пошлет POST
-запрос к конечной точке /api/friends/:id
для обновления данных друга.
Если пользователь нажмет на кнопку удаления, эта страница отправит запрос DELETE
к конечной точке /api/friends/:id
для удаления друга.
Отображение индивидуальной записи
Заголовок раздела Отображение индивидуальной записиВ файле src/pages/friend/[id].astro
будут отображены данные о друге.
Отображение списка записей с кнопкой редактирования
Заголовок раздела Отображение списка записей с кнопкой редактированияНаконец, в `src/pages/dashboard.astro будет отображен список друзей. Каждый друг будет иметь ссылку на страницу с информацией о нем и кнопку редактирования, которая перенаправит пользователя на страницу редактирования.
После создания всех страниц у вас должна получиться следующая структура файлов:
Директорияsrc
- env.d.ts
Директорияfirebase
- client.ts
- server.ts
Директорияpages
- dashboard.astro
- add.astro
Директорияedit
- [id].astro
Директорияfriend
- [id].astro
Директорияapi
Директорияfriends
- index.ts
- [id].ts
- .env
- astro.config.mjs
- package.json
Ресурсы сообщества
Заголовок раздела Ресурсы сообщества- Пример приложения Astro и Firebase SSR
- Использование Firebase Realtime Database в Astro с Vue: пошаговое руководство