Firebase 是一个应用开发平台,它提供了 NoSQL 数据库、身份验证、实时订阅、云函数和存储等功能。
如有必要的话请移步我们专门的指南,了解如何部署到 Firebase 托管
- 一个已配置了网页应用的 Firebase 项目;
- 一个配置了
output: 'server'
启用按需渲染 (EN) 的 Astro 项目;
- Firebase 凭据:你需要准备两组凭据来将 Astro 连接到 Firebase:
- 网页应用凭据:这些凭据将用于你的应用的客户端部分。你可以在 Firebase 控制台的「项目设置 > 通用」下找到它们。向下滚动到「你的应用」部分,然后并点击「网页应用」图标;
- 项目凭据:这些凭据将用于你的应用的服务器端部分。你可以在 Firebase 控制台的「项目设置 > 服务账号 > Firebase Admin SDK > 生成新的私钥」下生成它们。
要将 Firebase 凭据添加到 Astro,需要项目的根目录下创建一个名为 .env
的文件,并添加以下变量:
现在你已经可以在项目中使用这些变量。
如果你希望为 Firebase 环境变量启用 IntelliSense 功能,那么可以在 src/
目录中编辑或创建 env.d.ts
文件,并配置你的自定义类型:
现在你的项目应该包括以下几个新文件:
文件夹src/
- .env
- astro.config.mjs
- package.json
要将 Astro 连接到 Firebas 需要使用以下单行命令,可以使用你喜欢的包管理工具来安装以下包:
• firebase
- 用于客户端的 Firebase SDK
• firebase-admin
- 用于服务器端的 Firebase Admin SDK
接下来,在 src/
目录下创建一个名为 firebase
的文件夹,并在其中添加两个新文件:client.ts
和 server.ts
。
在 client.ts
文件中,请添加以下代码来使用你的网页应用凭据和 firebase
包并初始化客户端中的 Firebase:
在 server.ts
文件中,请添加以下代码来使用你的项目凭据和 firebase-admin
包并初始化服务器端的 Firebase:
最后,你现在的项目中应该包含如下几个新文件:
文件夹src
- .env
- astro.config.mjs
- package.json
- 一个已经初始化 Firebase 的 Astro 项目;
- 一个启用了电子邮件(或密码身份)验证的 Firebase 项目,你可以在 Firebase 控制台中的「身份验证(Authentication) > 登录方式(Sign-in method)」中启用。
Astro 中的 Firebase 身份验证需要以下三个 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
文件包含通过删除会话 cookie 来登出用户的代码逻辑:
register.ts
文件包含使用 Firebase 注册用户的代码逻辑:
在创建了身份验证的服务器端点之后,你的项目目录现在应该包含这些新文件:
文件夹src
- env.d.ts
文件夹firebase
文件夹pages
文件夹api
文件夹auth
- signin.ts
- signout.ts
- register.ts
- .env
- astro.config.mjs
- package.json
创建使用 Firebase 端点的页面:
src/pages/register.astro
- 包含用于注册用户的表单
src/pages/signin.astro
- 包含用于登录用户的表单
src/pages/dashboard.astro
- 包含只能由经过身份验证的用户访问的仪表板
下面是 src/pages/register.astro
的一个示例,其中包含一个表单,该表单将向 /api/auth/register
端点发送 POST
请求。这个端点会使用表单中的数据创建一个新用户,然后将用户重定向到 /signin
页面。
src/pages/signin.astro
使用 Firebase 服务器应用程序来验证用户的会话 cookie。如果用户已经通过身份验证,页面将重定向用户到 /dashboard
页面。
以下示例页面包含一个表单,该表单将使用 Firebase 客户端应用程序生成的 ID 令牌发送 POST
请求到 /api/auth/signin
端点。
端点将验证 ID 令牌,并为用户创建一个新的会话 cookie。然后,端点将重定向用户到 /dashboard
页面。
src/pages/dashboard.astro
将使用 Firebase 服务器应用程序来验证用户的会话 cookie。如果用户未经身份验证,页面将重定向用户到 /signin
页面。
以下示例页面显示用户的名称和一个用于注销的按钮。点击该按钮将发送一个 GET
请求到 /api/auth/signout
端点。
端点将删除用户的会话 cookie 并重定向用户到 /signin
页面。
要想为你的应用程序添加 OAuth 提供商,你需要在 Firebase 控制台中启用它们。
在 Firebase 控制台中,转到 身份验证(Authentication) 部分,然后点击 登录方式(Sign-in method) 选项卡。接着,点击 添加新的提供商(Add a new provider) 按钮,并启用你想要使用的提供商。
以下是使用 Google 提供商的示例。
编辑 signin.astro
页面并添加:
- 在现有表单下方添加一个与 Google 登录的按钮;
- 在现有的
<script>
中,为按钮添加事件侦听器,以处理登录过程。
当点击 Google 登录按钮时,将会打开一个弹出窗口以进行 Google 登录。用户登录后,将使用 OAuth 提供商生成的 ID 令牌,并发送一个 POST
请求到 /api/auth/signin
端点。
端点将验证 ID 令牌,并为用户创建一个新的会话 cookie。然后,端点将重定向用户到 /dashboard
页面。
在本示例中,Firestore 的集合将被命名为 friends,其中包含具有以下字段的文档:
id
:由 Firestore 自动生成
name
:一个字符串字段
age
:一个数字字段
isBestFriend
:一个布尔字段
在新的 src/pages/api/friends/
目录下创建两个文件:index.ts
和 [id].ts
。这两个文件将创建两个服务器端点,以如下方式与 Firestore 数据库交互:
POST /api/friends
:用于在 friends 集合中创建新文档。
POST /api/friends/:id
:用于更新 friends 集合中的文档。
DELETE /api/friends/:id
:用于删除 friends 集合中的文档。
index.ts
文件将包含在 friends 集合中创建新文档的代码:
[id].ts
文件将包含用于更新和删除 friends 集合中文档的代码逻辑:
在为 Firestore 创建服务器端点之后,你的项目目录现在应该包含这些新文件:
文件夹src
- env.d.ts
文件夹firebase
文件夹pages
- .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
的示例文件,其中包含一个表单,该表单将向 /api/friends
端点发送 POST
请求。该端点将使用表单中的数据创建一个新朋友,然后将用户重定向到 /dashboard
页面。
src/pages/edit/[id].astro
将包含一个表单,用于编辑朋友的数据,并包含一个删除朋友的按钮。在提交时,该页面将向 /api/friends/:id
端点发送 POST
请求来更新朋友的数据。
如果用户点击删除按钮,该页面将向 /api/friends/:id
端点发送 DELETE
请求来删除朋友。
src/pages/friend/[id].astro
将显示一个朋友的详细信息。
最后,src/pages/dashboard.astro
将显示一个朋友列表。每个朋友都会有指向他们详细信息页面的链接和一个编辑按钮,点击编辑按钮将重定向用户到编辑页面。
创建完所有页面后,此时你的项目应该具有以下文件结构:
文件夹src
- env.d.ts
文件夹firebase
文件夹pages
- dashboard.astro
- add.astro
文件夹edit
文件夹friend
文件夹api
- .env
- astro.config.mjs
- package.json
More backend service guides
Recipes