npm 包 objection-events 使用教程

简介

Objection.js 是一个基于 Node.js 的 ORM 库,可以方便地与各种关系型数据库进行交互。而 objection-events 则是一个为 Objection.js 提供事件支持的 npm 包。通过使用 objection-events,我们可以在 ORM 过程中监听和处理各种事件,可以帮助我们更好地控制数据流程和状态,提高代码的健壮性和可维护性。

安装

在项目中使用 npm 进行安装:

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

基本用法

如何监听事件?

首先,我们需要在 Objection 的 Model 定义中引入 objection-events:

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

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

此时,MyModel 就可以使用 objection-events 提供的 EventManager 来监听各种事件了。EventManger 是一个单例,负责管理整个应用程序中的事件,无须新建实例。

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

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

使用 eventManager.on(event, modelClass, handler) 方法即可监听某个 Model 的某个事件。其中 event 是事件名,modelClass 是对应的 Model,handler 是对事件的处理函数。我们可以定义多个 handler 对同一个事件进行处理,它们将在事件触发后依次执行。

如何触发事件?

在 Objection 中,我们可以通过调用 Model 的一些方法来触发相应的事件。例如在新增数据时,我们可以调用 Model 的 $query() 方法:

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

此时,我们在 eventManager.on('insert', MyModel, handler) 中定义的 handler 函数将被自动触发。

事件的上下文

由于同一个事件的处理函数可能存在多个,因此我们需要对事件的上下文进行控制,避免误操作和冲突。

在每个事件中,eventManager 会为处理函数提供一个 Context 对象,包含了事件的上下文信息:

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

我们在这里为处理函数添加了一个参数 ctx,它是事件上下文,包含了触发事件的一些信息,例如用户信息、请求信息等。

在使用事件时,我们可以通过 eventManager.setContext(ctx) 来设置当前上下文:

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

此时,ctx.user 将会输出 'Bob'。

事件回调

事件处理函数支持回调机制,可以进行异步操作。

在处理函数中,我们可以调用 ctx.callback() 来通知事件回调:

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

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

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

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

在这里,我们重写了 MyModel 的 create 方法,在插入新数据后,使用 this.emit('created', model, done) 方法触发了一个名叫 'created' 的事件,并附上一个回调函数 done。在处理函数中,我们处理完逻辑后再调用 done(),通知事件回调。

事件拦截器

在事件处理过程中,我们可以使用事件拦截器来对事件进行控制和干预。

在 Objection 中,我们可以使用 beforeInsertafterInsert 等钩子函数来进行插入操作的拦截。与它们类似的还有:beforeUpdate、afterUpdate、beforeDelete、afterDelete。

我们可以在 Model 的静态属性中定义这些钩子:

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

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

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

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

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

在这里,我们定义了一个 beforeInsert 钩子,在这个钩子中我们判断是否为管理员,只有管理员可进行数据插入,否则会抛出错误。在 $afterInsert 钩子中,我们使用 this.emit('inserted', this) 触发一个 inserted 事件,事件回调会输出插入的数据信息。

示例代码

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

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

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

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

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

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

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

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

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

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

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

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

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

以上代码演示了如何在 Objection.js 中使用 objection-events,我们定义了一个 MyModel,并在 beforeInsert 钩子中对普通用户进行了禁止插入的控制,在 afterInsert 钩子中触发了一个 inserted 事件,在事件回调中输出了插入的数据信息。最后使用 async/await 方式插入了一条数据,并输出了相应的日志。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600668f4d9381d61a3540e49


猜你喜欢

  • npm 包 Vue-cli-plugin-boardgame 使用教程

    在前端开发中,使用 Vue.js 可以方便地构建现代化的应用程序。而 Vue CLI 提供了更加便捷的工具来开发和维护 Vue 应用。对于需要开发棋牌类游戏的开发者来说,Vue-cli-plugin-...

    3 年前
  • npm 包 first-officer 使用教程

    前言 随着前端技术的不断发展,前端开发对于工具的依赖越来越高。其中,npm 作为前端生态中的重要组成部分,扮演了非常重要的角色。而 first-officer 就是一个依赖于 npm 的包,可用于构建...

    3 年前
  • npm 包 vr-visualization 使用教程

    前言 虚拟现实已经成为了当今科技领域的热点话题,而虚拟现实的可视化技术也同样备受关注。在前端技术中,通过使用 npm 包 vr-visualization,我们可以利用 web 技术创建基于虚拟现实交...

    3 年前
  • npm 包 generator-tinyspa 使用教程

    在前端开发中,使用代码生成器能够高效地加速开发速度。generator-tinyspa 是一个npm包,可以用于自动生成基于 React 或者 Vue 的单页面应用(SPA)。

    3 年前
  • npm 包 q-core-ui-components 使用教程

    在前端开发中,UI 组件库是必不可少的。其中,q-core-ui-components 是一个由 Qihoo 360 前端团队开发的 UI 组件库,已经被广泛应用于各种网站和应用的开发中。

    3 年前
  • npm 包 react-datetime-slider-picker 使用教程

    react-datetime-slider-picker 是一款使用方便的 React 时间选择器,它可以让用户使用滑动条和下拉框方便地选择日期和时间。该包适用于各种 Web 开发和 React 项目...

    3 年前
  • npm 包 gatsby-source-strapi-localized 使用教程

    简介 gatsby-source-strapi-localized 是一个适用于 GatsbyJS 的 npm 包,它允许你将 Strapi 管理的本地化内容源导入到你的 Gatsby 网站中。

    3 年前
  • npm 包 react-native-view-global-redux 使用教程

    前言 React Native 是一种基于 JavaScript 和 React 的应用开发框架,允许开发者使用类似于网页开发的方式创建本地应用程序。而 React Native View Globa...

    3 年前
  • npm 包 celeb-diwali 使用教程

    介绍 celeb-diwali 是一个可以用于在你的网页或移动应用中添加“Diwali”(印度教的节日)效果的 npm 包。它提供了丰富的选项,可以自定义颜色、粒子数量、动画速度等,同时还支持在代码中...

    3 年前
  • npm 包 backaid 使用教程

    什么是 backaid backaid 是一个可以帮助开发者在前端应用中轻松设置和使用后端接口的 npm 包。它可以帮助开发者避免重复编写类似的网络请求代码,提高开发效率。

    3 年前
  • npm 包 vegas-js-events 使用教程

    介绍 vegas-js-events 是一个基于 jQuery 的事件库,提供了一种舞台方式来实现事件的播放。它允许在具有先决条件的情况下触发多个事件。本文将介绍如何使用该包及其 API,以及示例代码...

    3 年前
  • npm 包 long-task-requester 使用教程

    在前端开发过程中,有时我们需要处理长时间运行的任务,如图像处理、视频转换等。这些任务可能会占用大量的时间和计算资源,而且会影响用户体验。因此,我们需要一种方法来让这些任务在后台运行,并可控。

    3 年前
  • npm 包 @dorious/generator-react-hot-antd 使用教程

    在现代的前端开发中,React 可谓是非常流行的一个前端框架。以 React 为基础,搭建出 Ant Design 风格的前端组件库可以大大提高开发效率。但是,使用 React 和 Ant Desig...

    3 年前
  • npm 包 vue-cg 使用教程

    介绍 vue-cg 是一个基于 Vue.js 的前端组件库,它提供了一系列的组件和工具,使开发者可以更加便捷地开发一个漂亮、易用、高效的 Web 应用程序。vue-cg 的代码易读易懂,易于维护,并且...

    3 年前
  • npm 包 cloud-build-message 使用教程

    引言 在前端开发中,我们时常需要将代码打包并部署至云端,而云端的构建过程是否成功的消息推送至团队成员有助于保证协作的高效性和项目的稳定性。npm 包 cloud-build-message 是一款易于...

    3 年前
  • npm 包 s3-bucket-toolkit 使用教程

    简介 s3-bucket-toolkit 是一个基于 Node.js 的 npm 包,用于管理 Amazon S3 存储桶。它提供了许多实用工具,如上传和下载文件、创建和删除存储桶等。

    3 年前
  • npm 包 @guillaumejasmin/redux-resource-plugins 使用教程

    在前端开发中,Redux 是一个非常流行的状态管理库。它通过单一的状态树和不可变的状态来管理应用程序的状态,使得状态的变化更加可控,同时也更容易进行调试和测试。 在 Redux 中,我们通常会使用 R...

    3 年前
  • npm 包 lang-detect-cli 使用教程

    lang-detect-cli 是一个命令行工具,用于检测文本的语言。该工具基于 langdetect 库实现。本文将详细介绍如何安装和使用 lang-detect-cli。

    3 年前
  • npm 包 orange-build-cli 使用教程

    在前端开发中,构建工具是必不可少的一部分,它能够自动化完成许多繁琐的操作,提高我们的效率。而 orange-build-cli 就是一款基于 Webpack 的构建工具,它能够帮我们自动化完成打包、压...

    3 年前
  • npm 包 spi-client-js-autoip 使用教程

    介绍 SPI (Serial Peripheral Interface) 客户端是一种常见的硬件接口协议,在物联网设备中被广泛使用。Webpack 是一个模块打包器,可以将多个模块打包成一个文件。

    3 年前

相关推荐

    暂无文章