npm 包 @sendanor/cloud-backend 使用教程

面试官：小伙子，你的代码为什么这么丝滑？

介绍

@sendanor/cloud-backend 是一个便捷的工具，能够帮助你快速构建基于云端的后端服务，其中包括必要的身份验证、授权、数据库等服务。它基于 Node.js 编写，能够很好地与各种 Web 前端框架进行整合，方便进行前后端一体化开发。

安装

你可以通过 npm 来安装 @sendanor/cloud-backend，命令如下：

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

使用

使用 @sendanor/cloud-backend 构建后端服务非常方便，下面我们就来看一下如何使用。

初始化

在使用 @sendanor/cloud-backend 之前，我们需要先进行初始化。你可以创建一个名为 server.js 的文件，并在其中进行初始化工作，代码如下：

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

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

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

这里我们首先通过 require 加载了 @sendanor/cloud-backend 模块，并使用 createServer() 方法创建了一个服务器实例。然后我们调用 listen() 方法启动了服务器。

身份验证

@sendanor/cloud-backend 提供了多种身份验证方式，其中包括本地数据库验证、OAuth2.0 验证等。这里我们以本地数据库验证为例进行介绍。

首先，在你的项目中安装 passport 和 passport-local，如下所示：

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

然后在初始化代码中添加身份验证相关的代码：

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

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

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

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

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

上面代码中，我们首先引入了 passport 和 passport-local，然后在 createServer() 方法中添加了 auth 参数，其中 local 属性为 passport-local 创建的本地验证策略。此外，我们还需要调用 configureMiddlewares() 方法配置 passport 以及 session 中间件。最后，我们通过 serializeUser() 和 deserializeUser() 方法来实现用户信息和 ID 之间的转换。

到此为止，我们已经完成了身份验证配置。接下来我们来看一下如何使用验证策略。

登录

@sendanor/cloud-backend 提供了一个特殊的路由 /auth/login，用于进行登录操作，如下所示：

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

上面代码中，我们使用 addRestfulRoutes() 方法来创建了 /auth/login 路由，其中采用了 POST 方式提交的 local-login 动作。在这个动作中，我们使用了 passport.authenticate() 方法来进行验证，验证失败时将请求重定向到了 /login-failed 路由。

注销

注销操作需要在前端进行，后端并不需要配置特殊的路由。

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

获取当前用户信息

要获取当前用户的信息，我们需要将用户的信息存储在 session 中，这里我们需要再次修改初始化代码：

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

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

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

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

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

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

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

上面代码中我们添加了 cookie-parser 和 express-session 中间件，并修改了 serializeUser() 和 deserializeUser() 方法，用于在 session 中存储用户信息。同时，我们在 /api/me 路由中添加了获取当前用户信息的功能，并使用 isAuthenticated() 方法来判断当前用户是否已登录。

授权

@sendanor/cloud-backend 提供了一种简单的方式来实现授权功能，即采用用户角色和权限的方式。我们需要先定义用户角色和权限，然后根据具体场景来定义相应的授权规则。这里我们以一个简单的例子进行说明。

首先，我们在初始化时要对角色和权限进行定义：

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

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

上面代码中，我们通过 roles 属性定义了 admin 和 user 两个角色，同时为它们分别配置了对应的权限。然后，我们又通过 users 属性定义了两个用户，并为每个用户配置了相应的角色。

接下来，我们需要定义授权规则，以控制不同用户对资源的访问权限。这可以通过 configureMiddlewares() 方法来实现：

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

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

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

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

上面代码中，我们使用了 configureMiddlewares() 方法来添加了一个自定义的中间件，在这个中间件中，我们首先判断当前用户是否已登录，如果未登录，则直接返回 401 状态码。然后，我们通过 getRolesForRoute() 方法来获取访问当前资源（即当前请求 URL）所需的角色。最后，我们检查当前用户是否拥有所需的角色，如果有，则允许访问，否则返回 403 状态码。

到此为止，我们已经完成了授权配置。在具体的应用场景中，你可以根据需要对身份验证和授权功能进行组合使用。

示例代码

下面是一些示例代码，帮助你更好地理解 @sendanor/cloud-backend 的使用方法。

使用 axios 进行身份验证和授权

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

上面代码中，我们通过 axios 来实现了登录和获取任务列表的功能。首先，我们使用 axios.post() 方法来提交登录信息，如果登录成功，则可以从响应头中获取到授权信息（即 authToken）。接下来，我们使用 axios.get() 方法来获取任务列表，其中需要通过 headers 参数传递授权信息。

使用 Vue.js 来集成身份验证和授权

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

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

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

上面代码实现了一个基于 Vue.js 的前端应用，其中包括身份验证和授权功能。当用户已登录时，页面将显示欢迎信息以及任务列表；否则，将显示登录表单。在需要访问受保护资源时，利用 axios 默认 header 就可以附加 authToken，从而完成授权。

总结

本文介绍了如何使用 @sendanor/cloud-backend 构建基于云端的后端服务，并详细说明了身份验证和授权功能的配置方法。希望本文对你有所帮助，让你能够更好地应对复杂的前后端一体化开发任务。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/82766

阅读全文

猜你喜欢

  • 如何在 Express.js 中使用 JWT 进行身份验证？

    随着互联网及移动互联网的快速发展，越来越多的应用程序需要进行用户身份验证及管理。为了满足这些需求，使用 JSON Web Token（JWT）进行用户身份验证已经成为技术领域的常见做法。

    3 小时前
  • 在 GraphQL 中处理复杂的对象关系

    在现代的 web 应用中，对象之间的关系变得越来越复杂。例如，一个出售商品的商店可能会有许多不同的商品，其中每个商品可能会有多个大小、颜色、类型等变体。在以前，为了处理这种情况，我们需要在后端编写各种...

    3 小时前
  • 如何使用 Jest 测试 Node.js 应用？

    Jest 是一款由 Facebook 开发的开源 JavaScript 测试框架。它被广泛用于前端和 Node.js 应用程序的单元测试、集成测试和端到端测试。在本篇文章中，我们将学习如何使用 Jes...

    3 小时前
  • Android 开发中 Material Design 中 TabLayout 的使用技巧

    前言 随着移动互联网的快速发展，在 Android 开发中，Material Design 成为了最流行的设计指南之一。TabLayout 是 Material Design 中一个重要的组件，具有良...

    3 小时前
  • PM2 与 NGINX：构建高性能的 Node.js 应用程序

    Node.js 是一个快速而又高效的 JavaScript 运行环境，正因为如此，它已经成为了构建 Web 应用、REST API 和实时应用的理想选择。但随着 Node.js 应用程序的愈加复杂，它...

    3 小时前
  • Headless CMS 中使用 Webhooks 实现自动构建

    随着静态网页生成器的流行，Headless CMS 越来越受到开发者们的重视。Headless CMS 不仅提供了现代化的管理界面，还允许开发者通过 API 或 Webhooks 来获取内容。

    3 小时前
  • ES10 实战教程

    前言 ES10，也就是 ECMAScript 2019，是 JavaScript 的最新版本。自 2015 年发布了 ES6 以来，JavaScript 变得越来越流行，并且在近几年里，前端技术发展迅...

    3 小时前
  • Serverless 如何实现自动备份？

    在 Serverless 架构中，由于无需维护服务器，开发者可以更专注于实现业务逻辑。但是，我们还是需要解决一些重要问题，如数据备份、数据恢复和灾难恢复等。在本文中，我们将探讨如何使用 Serverl...

    3 小时前
  • Jest 测试 React 组件中使用 context 的方法探究

    在 React 应用中，我们可能需要在组件间共享一些数据或者函数，这时可以通过 Context 来实现。但是在测试使用 Context 的组件时，我们可能会遇到一些问题。

    3 小时前
  • SSE 如何设置头信息？

    简介 SSE（Server-Sent Events）是一种轻量级的实时推送技术，在前端开发中经常用于推送服务器实时消息，比如聊天、订阅等。SSE 可以通过 HTTP 协议进行传输，因此需要设置合适的头...

    3 小时前
  • 在 Docker 容器中使用 SSH

    随着前端应用程序的复杂性增加，开发环境的设置变得越来越麻烦。 Docker 是一个流行的容器化解决方案，它可以帮助我们在标准化的环境中进行开发。在这篇文章中，我们将学习如何在 Docker 容器中使用...

    3 小时前
  • CSS Grid 游戏（Grid Garden）学习笔记

    CSS Grid 游戏（Grid Garden）学习笔记 CSS Grid 是一个强大的布局工具，它可以让我们轻松地实现复杂的网页布局。但是，学习 CSS Grid 的过程可能会有些枯燥。

    3 小时前
  • React 中使用 setInterval 时的注意事项

    引言 在 React 中，我们很常见地使用 setInterval 来创建周期性的任务。在实际开发中，我们需要注意一些细节和陷阱，以确保周期性任务能够正确地运行。本文将会介绍 React 中使用 se...

    3 小时前
  • 如何在使用 CSS Reset 的情况下保持 flexbox 布局？

    什么是 CSS Reset？ 在我们开始探讨在使用 CSS Reset 的情况下保持 flexbox 布局之前，我们需要先了解什么是 CSS Reset。CSS Reset 是一种用于归零不同浏览器之...

    3 小时前
  • 使用 Web Components 构建可重用的模态框组件

    Web Components 是 Web 技术的一种新型组成部分，可以让开发者创建封装的自定义元素。通过 Web Components，开发者可以更加轻松地构建可重用的 UI 组件。

    3 小时前
  • 如何优化 iOS 应用程序的性能

    作为一名前端开发人员，我们常常需要优化我们的应用程序的性能，以提供更好的用户体验。在 iOS 平台上，优化应用程序的性能尤为重要。本文将介绍一些优化 iOS 应用程序性能的技巧和策略，帮助开发人员提高...

    3 小时前
  • 响应式设计中的样式调整

    随着移动设备的普及，人们越来越多地使用手机和平板电脑浏览网站。因此，响应式设计已成为现代 Web 设计的必要趋势。在响应式设计中，我们需要针对不同的设备大小和屏幕分辨率，调整样式和布局以确保网站能够良...

    3 小时前
  • 在 Fastify 中处理文件上传

    Fastify 是一个快速、低开销和易于学习的 Web 框架，其性能排名领先。在开发过程中，我们经常需要处理文件上传。本文将介绍如何在 Fastify 中处理文件上传。

    3 小时前
  • ES11 中的 Object.fromEntries() - 一个实用工具

    ES11 中的 Object.fromEntries() - 一个实用工具 在 ES2019 中，一个新的 Object 静态方法 fromEntries() 加入了 JavaScript。

    3 小时前
  • 如何用良好的界面设计提升 App 无障碍性？

    随着技术的不断进步和社会的不断发展，越来越多的人开始重视无障碍性设计，这样有助于让更多的人都能够顺利、愉快地使用各种应用程序。尤其是在移动应用程序中，良好的界面设计不仅可以提高用户的使用体验，还可以提...

    3 小时前

相关推荐