npm 包 firebase-admin-auth 使用教程

阅读时长 8 分钟读完

Firebase 是 Google 推出的一种用于构建移动和 Web 应用程序的后端平台,它提供了丰富的实时数据库、身份验证、存储、分析和推送通知等服务。firebase-admin-auth 是一种基于 Firebase 的后端权限管理和身份验证库,它提供了一系列 API 接口用于创建用户、验证用户身份、管理用户角色和权限等功能,可以方便快捷地实现后端授权的功能。

在本文中,我们将以一个示例项目为例,详细讲解如何使用 firebase-admin-auth 来实现用户注册、登录、权限管理等功能。

一、安装和配置

在开始之前,我们需要安装和配置 firebase-admin-auth 库。首先,在终端中进入项目目录,使用 npm 安装 firebase-admin-auth 库:

接着,在项目的根目录下创建一个名为 firebase-admin-auth.json 的配置文件,用于存放 Firebase 项目的 credentials:

-- -------------------- ---- -------
-
  ------- ---
  ------------- ---
  ----------------- ---
  -------------- ---
  --------------- ---
  ------------ ---
  ----------- ---
  ------------ ---
  ------------------------------ ---
  ----------------------- --
-

以上信息可以在 Firebase 控制台的项目设置中获取。配置文件中的 private_key 属性需要注意,在配置文件中复制粘贴时需要将多行字符串转换为单行字符串,否则会导致解析错误。

二、用户注册和登录

接下来,我们将使用 firebase-admin-auth 来实现用户注册、登录、注销等功能。

首先,在入口文件中引入 firebase-admin-auth 模块并初始化:

-- -------------------- ---- -------
----- ----- - --------------------------
----- ---- - -------------------------------
----- ------ - -------------------------------------- -- ------

---------------------
  ----------- ------------------------------
  ------------ ----------------------------------------
---

------------------------------

在上面的代码中,我们首先引入了 firebase-admin-auth 模块,并在 initializeApp 方法中初始化 Firebase 项目。接着,我们调用 auth.initialize 方法来初始化 firebase-admin-auth 模块,可以传入一个 admin.auth() 的实例。

1. 用户注册

接下来,我们将定义一个 /signup 的路由来实现用户注册功能:

-- -------------------- ---- -------
---------------------- ----- ----- ---- ----- -- -
  --- -
    ----- - ------ -------- - - ---------
    ----- ---- - ----- ----------------- ------ -------- ---
    ---------- ---- ---
  - ----- ------- -
    ------------
  -
---

在上面的代码中,我们首先解构出请求体中的 emailpassword 字段,然后调用 auth.createUser 方法来创建用户。在用户创建成功后,我们将返回一个包含用户信息的 JSON 对象。如果创建失败,则会抛出一个错误并调用 next 方法交由错误处理中间件处理。

2. 用户登录

接下来,我们将定义一个 /login 的路由来实现用户登录功能:

-- -------------------- ---- -------
--------------------- ----- ----- ---- ----- -- -
  --- -
    ----- - ------ -------- - - ---------
    ----- ----- - ----- -------------------------------------- ----------
    ---------- ----- ---
  - ----- ------- -
    ------------
  -
---

在上面的代码中,我们同样解构出请求体中的 emailpassword 字段,然后调用 auth.signInWithEmailAndPassword 方法来进行用户身份验证。在身份验证成功后,我们将返回一个包含用户 token 的 JSON 对象。如果登录失败,则会抛出一个错误并交由错误处理中间件处理。

3. 用户注销

最后,我们将定义一个 /logout 的路由来实现用户注销功能:

-- -------------------- ---- -------
---------------------- ----- ----- ---- ----- -- -
  --- -
    ----- - ----- - - ---------
    ----- --------------------
    --------------------
  - ----- ------- -
    ------------
  -
---

在上面的代码中,我们解构出请求体中的 token 字段,然后调用 auth.signOut 方法来注销用户。在用户注销成功后,我们将返回一个状态码为 200 的响应。如果注销失败,则会抛出一个错误并交由错误处理中间件处理。

三、用户权限管理

除了用户注册和登录功能外,firebase-admin-auth 还提供了一系列的 API 接口用于实现用户权限管理功能。在接下来的示例中,我们将使用 firebase-admin-auth 来实现用户的角色分配、权限控制等功能。

1. 用户角色分配

我们首先定义一个 /roles 的路由,用于实现用户角色的分配:

-- -------------------- ---- -------
--------------------- ----- ----- ---- ----- -- -
  --- -
    ----- - ---- ---- - - ---------
    ----- ---- - ----- ----------------------------- - ---- ---
    ---------- ---- ---
  - ----- ------- -
    ------------
  -
---

在上面的代码中,我们解构出请求体中的 uidrole 字段,然后调用 auth.setCustomUserClaims 方法来设置用户的自定义权限和属性。在角色分配成功后,我们将返回一个包含用户信息的 JSON 对象。如果分配失败,则会抛出一个错误并交由错误处理中间件处理。

2. 用户权限控制

接下来,我们将定义一个 /admin 的路由,用于实现仅管理员才能访问的功能:

在上面的代码中,我们定义了一个 /admin 的路由,并使用 auth.isAdmin 中间件来控制只有管理员才能访问该路由。如果用户的角色没有设置为管理员,则该路由会返回一个状态码为 401 的错误响应。

下面是 auth.isAdmin 中间件的实现:

-- -------------------- ---- -------
------------ - ----- ----- ---- ----- -- -
  --- -
    ----- ---- - ----- ---------------------------------------- -- ------
    -- ------------------- -- ----------------------- --- -------- -
      ----- --- --------- --------------
    -
    -------- - -----
    -------
  - ----- ------- -
    --------------------
  -
-

在上面的代码中,我们首先通过 req.headers.authorization 字段获取请求头中的用户 token,并调用 auth.getUser 方法来获取用户信息。接着,我们判断用户是否具有管理员权限,如果没有,则抛出一个错误。最后,使用 req.user 保存用户信息,并调用 next 方法进入下一个中间件或路由。

四、总结

通过本文的示例,我们了解了如何使用 firebase-admin-auth 库来实现用户注册、登录、注销和权限管理等功能,并了解了如何利用其 API 接口来实现用户角色分配和权限控制等功能。firebase-admin-auth 库不仅功能丰富,而且还非常易于使用,是前端开发中不可缺少的一部分。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005743e81e8991b448e9f8d

纠错
反馈