跳转到内容

Firebase & Astro

Firebase 是一个应用程序开发平台,提供 NoSQL 数据库、身份验证、实时订阅、函数和存储功能。

另请参阅我们关于部署到 Firebase 托管的单独指南。

  • 一个配置了 Web 应用的 Firebase 项目
  • 一个启用了用于按需渲染的 output: 'server' 的 Astro 项目。
  • Firebase 凭据:你需要两套凭据才能将 Astro 连接到 Firebase
    • Web 应用凭据:这些凭据将由应用的客户端使用。你可以在 Firebase 控制台的 项目设置 > 常规 下找到它们。向下滚动到 你的应用 部分,然后单击 Web 应用 图标。
    • 项目凭据:这些凭据将由应用的服务器端使用。你可以在 Firebase 控制台的 项目设置 > 服务帐号 > Firebase Admin SDK > 生成新的私钥 下生成它们。

要将你的 Firebase 凭据添加到 Astro,请在项目根目录下创建一个 .env 文件,并包含以下变量

.env
FIREBASE_PRIVATE_KEY_ID=YOUR_PRIVATE_KEY_ID
FIREBASE_PRIVATE_KEY=YOUR_PRIVATE_KEY
FIREBASE_PROJECT_ID=YOUR_PROJECT_ID
FIREBASE_CLIENT_EMAIL=YOUR_CLIENT_EMAIL
FIREBASE_CLIENT_ID=YOUR_CLIENT_ID
FIREBASE_AUTH_URI=YOUR_AUTH_URI
FIREBASE_TOKEN_URI=YOUR_TOKEN_URI
FIREBASE_AUTH_CERT_URL=YOUR_AUTH_CERT_URL
FIREBASE_CLIENT_CERT_URL=YOUR_CLIENT_CERT_URL

现在,这些环境变量就可以在你的项目里使用了。

如果你希望为 Firebase 环境变量提供智能提示(IntelliSense),请在你的 src/ 目录下编辑或创建 env.d.ts 文件,并配置你的类型

src/env.d.ts
interface ImportMetaEnv {
readonly FIREBASE_PRIVATE_KEY_ID: string;
readonly FIREBASE_PRIVATE_KEY: string;
readonly FIREBASE_PROJECT_ID: string;
readonly FIREBASE_CLIENT_EMAIL: string;
readonly FIREBASE_CLIENT_ID: string;
readonly FIREBASE_AUTH_URI: string;
readonly FIREBASE_TOKEN_URI: string;
readonly FIREBASE_AUTH_CERT_URL: string
readonly FIREBASE_CLIENT_CERT_URL: string;
}
interface ImportMeta {
readonly env: ImportMetaEnv;
}

你的项目现在应该包含这些新文件

  • 目录src/
    • env.d.ts
  • .env
  • astro.config.mjs
  • package.json

要将 Astro 与 Firebase 连接,请使用下面适用于你的首选包管理器的单个命令安装以下包

  • firebase - 用于客户端的 Firebase SDK
  • firebase-admin - 用于服务器端的 Firebase Admin SDK
终端窗口
npm install firebase firebase-admin

接下来,在 src/ 目录下创建一个名为 firebase 的文件夹,并向该文件夹添加两个新文件:client.tsserver.ts

client.ts 中,添加以下代码,使用你的 Web 应用凭据和 firebase 包来在客户端初始化 Firebase

src/firebase/client.ts
import { initializeApp } from "firebase/app";
const firebaseConfig = {
apiKey: "my-public-api-key",
authDomain: "my-auth-domain",
projectId: "my-project-id",
storageBucket: "my-storage-bucket",
messagingSenderId: "my-sender-id",
appId: "my-app-id",
};
export const app = initializeApp(firebaseConfig);

server.ts 中,添加以下代码,使用你的项目凭据和 firebase-admin 包来在服务器端初始化 Firebase

src/firebase/server.ts
import type { ServiceAccount } from "firebase-admin";
import { initializeApp, cert, getApps } from "firebase-admin/app";
const activeApps = getApps();
const serviceAccount = {
type: "service_account",
project_id: import.meta.env.FIREBASE_PROJECT_ID,
private_key_id: import.meta.env.FIREBASE_PRIVATE_KEY_ID,
private_key: import.meta.env.FIREBASE_PRIVATE_KEY,
client_email: import.meta.env.FIREBASE_CLIENT_EMAIL,
client_id: import.meta.env.FIREBASE_CLIENT_ID,
auth_uri: import.meta.env.FIREBASE_AUTH_URI,
token_uri: import.meta.env.FIREBASE_TOKEN_URI,
auth_provider_x509_cert_url: import.meta.env.FIREBASE_AUTH_CERT_URL,
client_x509_cert_url: import.meta.env.FIREBASE_CLIENT_CERT_URL,
};
const initApp = () => {
if (import.meta.env.PROD) {
console.info('PROD env detected. Using default service account.')
// Use default config in firebase functions. Should be already injected in the server by Firebase.
return initializeApp()
}
console.info('Loading service account from env.')
return initializeApp({
credential: cert(serviceAccount as ServiceAccount)
})
}
export const app = activeApps.length === 0 ? initApp() : activeApps[0];

最后,你的项目现在应该包含这些新文件

  • 目录src
    • env.d.ts
    • 目录firebase
      • client.ts
      • server.ts
  • .env
  • astro.config.mjs
  • package.json
  • 一个用 Firebase 初始化了的 Astro 项目。
  • 一个在 Firebase 控制台的 Authentication > Sign-in method 中启用了电子邮件/密码身份验证的 Firebase 项目。

在 Astro 中使用 Firebase 身份验证需要以下三个Astro 服务器端点

  • GET /api/auth/signin - 用于登录用户
  • GET /api/auth/signout - 用于注销用户
  • POST /api/auth/register - 用于注册用户

在一个新目录 src/pages/api/auth/ 中创建三个与身份验证相关的端点:signin.tssignout.tsregister.ts

signin.ts 包含使用 Firebase 登录用户的代码

src/pages/api/auth/signin.ts
import type { APIRoute } from "astro";
import { app } from "../../../firebase/server";
import { getAuth } from "firebase-admin/auth";
export const GET: APIRoute = async ({ request, cookies, redirect }) => {
const auth = getAuth(app);
/* Get token from request headers */
const idToken = request.headers.get("Authorization")?.split("Bearer ")[1];
if (!idToken) {
return new Response(
"No token found",
{ status: 401 }
);
}
/* Verify id token */
try {
await auth.verifyIdToken(idToken);
} catch (error) {
return new Response(
"Invalid token",
{ status: 401 }
);
}
/* Create and set session cookie */
const fiveDays = 60 * 60 * 24 * 5 * 1000;
const sessionCookie = await auth.createSessionCookie(idToken, {
expiresIn: fiveDays,
});
cookies.set("__session", sessionCookie, {
path: "/",
});
return redirect("/dashboard");
};

signout.ts 包含通过删除会话 cookie 来注销用户的代码

src/pages/api/auth/signout.ts
import type { APIRoute } from "astro";
export const GET: APIRoute = async ({ redirect, cookies }) => {
cookies.delete("__session", {
path: "/",
});
return redirect("/signin");
};

register.ts 包含使用 Firebase 注册用户的代码

src/pages/api/auth/register.ts
import type { APIRoute } from "astro";
import { getAuth } from "firebase-admin/auth";
import { app } from "../../../firebase/server";
export const POST: APIRoute = async ({ request, redirect }) => {
const auth = getAuth(app);
/* Get form data */
const formData = await request.formData();
const email = formData.get("email")?.toString();
const password = formData.get("password")?.toString();
const name = formData.get("name")?.toString();
if (!email || !password || !name) {
return new Response(
"Missing form data",
{ status: 400 }
);
}
/* Create user */
try {
await auth.createUser({
email,
password,
displayName: name,
});
} catch (error: any) {
return new Response(
"Something went wrong",
{ status: 400 }
);
}
return redirect("/signin");
};

创建身份验证的服务器端点后,你的项目目录现在应包含这些新文件

  • 目录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 包含一个表单,该表单将向 /api/auth/register 端点发送一个 POST 请求。此端点将使用表单中的数据创建一个新用户,然后将用户重定向到 /signin 页面。

src/pages/register.astro
---
import Layout from "../layouts/Layout.astro";
---
<Layout title="Register">
<h1>Register</h1>
<p>Already have an account? <a href="/signin">Sign in</a></p>
<form action="/api/auth/register" method="post">
<label for="name">Name</label>
<input type="text" name="name" id="name" />
<label for="email" for="email">Email</label>
<input type="email" name="email" id="email" />
<label for="password">Password</label>
<input type="password" name="password" id="password" />
<button type="submit">Login</button>
</form>
</Layout>

src/pages/signin.astro 使用 Firebase 服务器应用来验证用户的会话 cookie。如果用户已通过身份验证,页面将把用户重定向到 /dashboard 页面。

下面的示例页面包含一个表单,该表单将把 Firebase 客户端应用生成的 ID 令牌通过 POST 请求发送到 /api/auth/signin 端点。

该端点将验证 ID 令牌并为用户创建一个新的会话 cookie。然后,该端点将用户重定向到 /dashboard 页面。

src/pages/signin.astro
---
import { app } from "../firebase/server";
import { getAuth } from "firebase-admin/auth";
import Layout from "../layouts/Layout.astro";
/* Check if the user is authenticated */
const auth = getAuth(app);
if (Astro.cookies.has("__session")) {
const sessionCookie = Astro.cookies.get("__session")!.value;
const decodedCookie = await auth.verifySessionCookie(sessionCookie);
if (decodedCookie) {
return Astro.redirect("/dashboard");
}
}
---
<Layout title="Sign in">
<h1>Sign in</h1>
<p>New here? <a href="/register">Create an account</a></p>
<form action="/api/auth/signin" method="post">
<label for="email" for="email">Email</label>
<input type="email" name="email" id="email" />
<label for="password">Password</label>
<input type="password" name="password" id="password" />
<button type="submit">Login</button>
</form>
</Layout>
<script>
import {
getAuth,
inMemoryPersistence,
signInWithEmailAndPassword,
} from "firebase/auth";
import { app } from "../firebase/client";
const auth = getAuth(app);
// This will prevent the browser from storing session data
auth.setPersistence(inMemoryPersistence);
const form = document.querySelector("form") as HTMLFormElement;
form.addEventListener("submit", async (e) => {
e.preventDefault();
const formData = new FormData(form);
const email = formData.get("email")?.toString();
const password = formData.get("password")?.toString();
if (!email || !password) {
return;
}
const userCredential = await signInWithEmailAndPassword(
auth,
email,
password
);
const idToken = await userCredential.user.getIdToken();
const response = await fetch("/api/auth/signin", {
method: "GET",
headers: {
Authorization: `Bearer ${idToken}`,
},
});
if (response.redirected) {
window.location.assign(response.url);
}
});
</script>

src/pages/dashboard.astro 将使用 Firebase 服务器应用来验证用户的会话 cookie。如果用户未通过身份验证,页面将把用户重定向到 /signin 页面。

下面的示例页面显示了用户的姓名和一个注销按钮。点击该按钮将向 /api/auth/signout 端点发送一个 GET 请求。

该端点将删除用户的会话 cookie 并将用户重定向到 /signin 页面。

src/pages/dashboard.astro
---
import { app } from "../firebase/server";
import { getAuth } from "firebase-admin/auth";
import Layout from "../layouts/Layout.astro";
const auth = getAuth(app);
/* Check current session */
if (!Astro.cookies.has("__session")) {
return Astro.redirect("/signin");
}
const sessionCookie = Astro.cookies.get("__session")!.value;
const decodedCookie = await auth.verifySessionCookie(sessionCookie);
const user = await auth.getUser(decodedCookie.uid);
if (!user) {
return Astro.redirect("/signin");
}
---
<Layout title="dashboard">
<h1>Welcome {user.displayName}</h1>
<p>We are happy to see you here</p>
<form action="/api/auth/signout">
<button type="submit">Sign out</button>
</form>
</Layout>

要向你的应用添加 OAuth 提供商,你需要在 Firebase 控制台中启用它们。

在 Firebase 控制台中,转到 Authentication 部分,然后点击 Sign-in method 标签页。接着,点击 Add a new provider 按钮并启用你想使用的提供商。

下面的示例使用了 Google 提供商。

编辑 signin.astro 页面以添加

  • 一个在现有表单下方用 Google 登录的按钮
  • 一个在现有 <script> 中的按钮事件监听器,用于处理登录过程。
src/pages/signin.astro
---
import { app } from "../firebase/server";
import { getAuth } from "firebase-admin/auth";
import Layout from "../layouts/Layout.astro";
/* Check if the user is authenticated */
const auth = getAuth(app);
if (Astro.cookies.has("__session")) {
const sessionCookie = Astro.cookies.get("__session")!.value;
const decodedCookie = await auth.verifySessionCookie(sessionCookie);
if (decodedCookie) {
return Astro.redirect("/dashboard");
}
}
---
<Layout title="Sign in">
<h1>Sign in</h1>
<p>New here? <a href="/register">Create an account</a></p>
<form action="/api/auth/signin" method="post">
<label for="email" for="email">Email</label>
<input type="email" name="email" id="email" />
<label for="password">Password</label>
<input type="password" name="password" id="password" />
<button type="submit">Login</button>
</form>
<button id="google">Sign in with Google</button>
</Layout>
<script>
import {
getAuth,
inMemoryPersistence,
signInWithEmailAndPassword,
GoogleAuthProvider,
signInWithPopup,
} from "firebase/auth";
import { app } from "../firebase/client";
const auth = getAuth(app);
auth.setPersistence(inMemoryPersistence);
const form = document.querySelector("form") as HTMLFormElement;
form.addEventListener("submit", async (e) => {
e.preventDefault();
const formData = new FormData(form);
const email = formData.get("email")?.toString();
const password = formData.get("password")?.toString();
if (!email || !password) {
return;
}
const userCredential = await signInWithEmailAndPassword(
auth,
email,
password
);
const idToken = await userCredential.user.getIdToken();
const response = await fetch("/api/auth/signin", {
headers: {
Authorization: `Bearer ${idToken}`,
},
});
if (response.redirected) {
window.location.assign(response.url);
}
});
const googleSignin = document.querySelector("#google") as HTMLButtonElement;
googleSignin.addEventListener("click", async () => {
const provider = new GoogleAuthProvider();
const userCredential = await signInWithPopup(auth, provider);
const idToken = await userCredential.user.getIdToken();
const res = await fetch("/api/auth/signin", {
headers: {
Authorization: `Bearer ${idToken}`,
},
});
if (res.redirected) {
window.location.assign(res.url);
}
});
</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 集合中创建新文档的代码

src/pages/api/friends/index.ts
import type { APIRoute } from "astro";
import { app } from "../../../firebase/server";
import { getFirestore } from "firebase-admin/firestore";
export const POST: APIRoute = async ({ request, redirect }) => {
const formData = await request.formData();
const name = formData.get("name")?.toString();
const age = formData.get("age")?.toString();
const isBestFriend = formData.get("isBestFriend") === "on";
if (!name || !age) {
return new Response("Missing required fields", {
status: 400,
});
}
try {
const db = getFirestore(app);
const friendsRef = db.collection("friends");
await friendsRef.add({
name,
age: parseInt(age),
isBestFriend,
});
} catch (error) {
return new Response("Something went wrong", {
status: 500,
});
}
return redirect("/dashboard");
};

[id].ts 将包含更新和删除 friends 集合中文档的代码

src/pages/api/friends/[id].ts
import type { APIRoute } from "astro";
import { app } from "../../../firebase/server";
import { getFirestore } from "firebase-admin/firestore";
const db = getFirestore(app);
const friendsRef = db.collection("friends");
export const POST: APIRoute = async ({ params, redirect, request }) => {
const formData = await request.formData();
const name = formData.get("name")?.toString();
const age = formData.get("age")?.toString();
const isBestFriend = formData.get("isBestFriend") === "on";
if (!name || !age) {
return new Response("Missing required fields", {
status: 400,
});
}
if (!params.id) {
return new Response("Cannot find friend", {
status: 404,
});
}
try {
await friendsRef.doc(params.id).update({
name,
age: parseInt(age),
isBestFriend,
});
} catch (error) {
return new Response("Something went wrong", {
status: 500,
});
}
return redirect("/dashboard");
};
export const DELETE: APIRoute = async ({ params, redirect }) => {
if (!params.id) {
return new Response("Cannot find friend", {
status: 404,
});
}
try {
await friendsRef.doc(params.id).delete();
} catch (error) {
return new Response("Something went wrong", {
status: 500,
});
}
return redirect("/dashboard");
};

为 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 示例包含一个表单,该表单将向 /api/friends 端点发送一个 POST 请求。此端点将使用表单中的数据创建一个新朋友,然后将用户重定向到 /dashboard 页面。

src/pages/add.astro
---
import Layout from "../layouts/Layout.astro";
---
<Layout title="Add a new friend">
<h1>Add a new friend</h1>
<form method="post" action="/api/friends">
<label for="name">Name</label>
<input type="text" id="name" name="name" />
<label for="age">Age</label>
<input type="number" id="age" name="age" />
<label for="isBestFriend">Is best friend?</label>
<input type="checkbox" id="isBestFriend" name="isBestFriend" />
<button type="submit">Add friend</button>
</form>
</Layout>

src/pages/edit/[id].astro 将包含一个用于编辑朋友数据的表单和一个删除朋友的按钮。提交时,此页面将向 /api/friends/:id 端点发送 POST 请求以更新朋友数据。

如果用户点击删除按钮,此页面将向 /api/friends/:id 端点发送 DELETE 请求以删除朋友。

src/pages/edit/[id].astro
---
import Layout from "../../layouts/Layout.astro";
import { app } from "../../firebase/server";
import { getFirestore } from "firebase-admin/firestore";
interface Friend {
name: string;
age: number;
isBestFriend: boolean;
}
const { id } = Astro.params;
if (!id) {
return Astro.redirect("/404");
}
const db = getFirestore(app);
const friendsRef = db.collection("friends");
const friendSnapshot = await friendsRef.doc(id).get();
if (!friendSnapshot.exists) {
return Astro.redirect("/404");
}
const friend = friendSnapshot.data() as Friend;
---
<Layout title="Edit {friend.name}">
<h1>Edit {friend.name}</h1>
<p>Here you can edit or delete your friend's data.</p>
<form method="post" action={`/api/friends/${id}`}>
<label for="name">Name</label>
<input type="text" id="name" name="name" value={friend.name} />
<label for="age">Age</label>
<input type="number" id="age" name="age" value={friend.age} />
<label for="isBestFriend">Is best friend?</label>
<input
type="checkbox"
id="isBestFriend"
name="isBestFriend"
checked={friend.isBestFriend}
/>
<button type="submit">Edit friend</button>
</form>
<button type="button" id="delete-document">Delete</button>
</Layout>
<script>
const deleteButton = document.getElementById(
"delete-document"
) as HTMLButtonElement;
const url = document.querySelector("form")?.getAttribute("action") as string;
deleteButton.addEventListener("click", async () => {
const response = await fetch(url, {
method: "DELETE",
});
if (response.redirected) {
window.location.assign(response.url);
}
});
</script>

src/pages/friend/[id].astro 将显示一个朋友的详细信息。

src/pages/friend/[id].astro
---
import Layout from "../../layouts/Layout.astro";
import { app } from "../../firebase/server";
import { getFirestore } from "firebase-admin/firestore";
interface Friend {
name: string;
age: number;
isBestFriend: boolean;
}
const { id } = Astro.params;
if (!id) {
return Astro.redirect("/404");
}
const db = getFirestore(app);
const friendsRef = db.collection("friends");
const friendSnapshot = await friendsRef.doc(id).get();
if (!friendSnapshot.exists) {
return Astro.redirect("/404");
}
const friend = friendSnapshot.data() as Friend;
---
<Layout title={friend.name}>
<h1>{friend.name}</h1>
<p>Age: {friend.age}</p>
<p>Is best friend: {friend.isBestFriend ? "Yes" : "No"}</p>
</Layout>

最后,src/pages/dashboard.astro 将显示一个朋友列表。每个朋友都有一个指向其详细信息页面的链接和一个将用户重定向到编辑页面的编辑按钮。

src/pages/dashboard.astro
---
import { app } from "../firebase/server";
import { getFirestore } from "firebase-admin/firestore";
import Layout from "../layouts/Layout.astro";
interface Friend {
id: string;
name: string;
age: number;
isBestFriend: boolean;
}
const db = getFirestore(app);
const friendsRef = db.collection("friends");
const friendsSnapshot = await friendsRef.get();
const friends = friendsSnapshot.docs.map((doc) => ({
id: doc.id,
...doc.data(),
})) as Friend[];
---
<Layout title="My friends">
<h1>Friends</h1>
<ul>
{
friends.map((friend) => (
<li>
<a href={`/friend/${friend.id}`}>{friend.name}</a>
<span>({friend.age})</span>
<strong>{friend.isBestFriend ? "Bestie" : "Friend"}</strong>
<a href={`/edit/${friend.id}`}>Edit</a>
</li>
))
}
</ul>
</Layout>

创建完所有页面后,你应该具有以下文件结构

  • 目录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

更多后端服务指南

贡献 社区 赞助