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

阅读时长 22 分钟读完

介绍

@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