如何使用 Fastify 框架的插件

作为一个开源,低开销,快速的 Node.js Web 框架,Fastify 已经流行和广泛使用。它具有出色的性能、可扩展性和清晰且优雅的代码结构。

Fastify 有一个强大的插件系统,可以使开发更简便,常用的相关功能可以使用插件快速添加到框架中。本文将介绍如何使用 Fastify 插件。

安装插件

Fastify 支持 npm 模块风格的插件系统。可以通过 npm 安装插件,使用时可以通过 fastify-plugin 模块封装插件,然后将其作为 .register() 方法的参数使用。

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

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

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

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

上面代码中,我们展示了如何在 Fastify 中使用 fastify-cors 插件,通过 fastify-plugin 转换,传递一些参数来实现跨域问题。 这个例子只是演示了如何使用 Fastify 插件,并不具有实际的应用价值。下面我们将通过实际的案例展示使用插件的情况。

使用案例

假设我们有一个需要处理用户数据信息的 Web 应用。我们使用 Fastify 来开发并处理相关请求。但是我们需要一个中间件来验证数据是否符合规范,检查用户是否有操作权限。

这时,我们可以通过编写一个特殊的插件 fastify-authfastify-validator 来实现我们的需求。 下面我们逐步进行实践。

安装 validator 和 jwt 库

首先,我们需要安装一些必要的库:fastify-authfastify-pluginfastify-jwtfast-json-stringifyfastify-jwt 将用于身份验证和 jwt 令牌的生成和校验,而 fast-json-stringify 用于序列化数据的显示。

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

配置 Fastify 和插件注册

接下来,我们将在 Fastify 上设置一些基本配置,并编写一个简单的插件来验证请求。

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

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

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

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

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

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

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

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

上面的代码中,我们首先在 Fastify 中注册了 fastify-authfastify-jwt 插件。然后,我们在 /auth/login 路径下创建了一个 post 请求用于检查用户名和密码,并为用户生成 jwt 令牌。

服务器端插件

上面我们已经进行了一部分配置,并实现了对于请求的简单认证,但是我们需要对于请求进行更加细致的处理。我们需要编写更多的功能来完成这个细节。

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

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

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

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

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

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

在上面的代码中,我们使用 fastify-plugin 函数来注册自定义插件,该插件将包含用于处理身份验证和数据校验的中间件函数。

此插件要求使用 fastify-authfastify-jwt 插件进行身份验证,还要求将 fast-json-body 典型的用于处理和验证请求正文。

下面是使用 JWT 和身份验证的函数,它采用 JWT 令牌并将其解码为当前用户的用户名信息。然后,我们可以基于该信息查询相关的数据库,并将结果返回给客户端。

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

编写自定义中间件的模板

如何编写 Fastify 的自定义中间件,请看下面的模板。

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

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

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

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

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

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

在上面的代码中,我们展示了一个典型的自定义插件使用方法,包含在 Fastify 中添加 Hooks 做出前置准备处理和验证数字中间件功能。

结论

通过本文,我们了解到如何在 Fastify 中使用插件,同时通过案例展示了异步请求,JWT 验证和自定义中间件的功能。使用 Fastify 插件系统加速我们开发的速度和功能。让我们更加关注业务需求,提高代码可读性。

声明:此篇文章大量参考了Fastify官方文档,并对一些描述进行了调整,加入了自己积累的经验进行讲述。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/67105f3d5f551281026a52ec