npm 包 feathers-horizon 使用教程

阅读时长 7 分钟读完

前言

作为前端开发人员,我们经常需要处理后端 API 数据。而 feathers-horizon 这个 npm 包则是将 Horizon 和 Feathers 的既有功能结合起来的工具,以便我们在前端轻松地连接到 Horizon 数据库。

在本篇文章中,我们将详细介绍 feathers-horizon 的使用流程以及相关细节,并提供几个实用的示例代码帮助您更好地理解。

安装

要使用 feathers-horizon,您需要首先使用 npm 安装它:

连接到 Horizon 数据库

为了开始使用 feathers-horizon,我们需要先连接到 Horizon 数据库。我们需要使用 feathers-hooks-common 模块中的 authenticate 钩子来进行身份验证,然后再使用 horizon 引擎来连接到数据库。

以下是一个很好的示例代码,将展示整个连接过程:

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

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

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

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

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

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

这段代码首先将 Feathers 配置为使用 REST 风格的请求,然后使用 @feathersjs/authentication-client@horizon/client 模块配置身份验证和 Horizon 连接信息。

最后,我们可以看到这个代码示例使用 horizonClient 对象来为我们打开数据库,并使用 feathers-hooks-common 模块中的钩子来将 engine 配置为 horizonEngine

创建和调用服务

现在,我们已经成功地连接到了数据库,接下来,我们可以开始创建和调用服务了。

feathers-horizon 中,服务通过 app.service('service-name') 方法进行创建。首先,让我们看一个最基本的服务创建示例:

这段代码展示了如何使用 horizonClient.service('service-name') 创建一个新的服务,对 messages 服务进行初始化,并对外暴露数据库的方法。

接下来,我们以 Horizon 数据库文档作为对象,创建一个带有 created_atcontentauthor 属性的服务。下面是相关的代码示例:

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

在上述示例中,我们通过 app.use('/messages', { ... }) 方法创建了一个 messages 服务,并在该服务中创建了五个基本的方法——findgetcreatepatchremove——来处理在数据库中的 CRUD 操作。

最后,我们需要在 app.js 或者其他应用程序入口处,将服务初始化并挂载到 app 对象中:

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

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

总结

在本篇文章中,我们介绍了如何使用 npm 包 feathers-horizon 创建和调用服务。我们详细讲解了 Horizon 数据库连接的过程以及如何使用 feathers-hooks-common 模块中的钩子来添加额外的配置。

最后,我们提供了一个创建服务并挂载到 Feathers 应用程序的示例代码,使您可以更好地了解及应用本篇文章的内容。

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

纠错
反馈