在 Node.js Web 应用的开发中,与数据库的操作是必不可少的。Sequelize 是一款 Node.js 的 ORM 框架,它提供了良好的 API 以便于更好地操作数据库。而 Hapi.js 则是一款 Node.js 的 Web 框架,它可使构建 Web 应用变得更容易。这篇文章将介绍在 Node.js 应用中,如何将 Sequelize ORM 与 Hapi.js 集成,以此来方便地进行数据库操作。
安装和初始化项目
首先,你需要在本地安装 Node.js 和 npm,确保 Node.js 版本在 7.6 或以上。然后,用以下命令安装 Hapi.js 和 Sequelize。
$ npm install --save hapi $ npm install --save sequelize
接着,创建一个新的 Node.js 项目并初始化。
$ mkdir hapi-sequelize-demo $ cd hapi-sequelize-demo $ npm init
通过 npm init 命令初始化你的项目之后,你需要创建一个文件夹用于存放你的服务端代码。在这个文件夹内,你可以通过以下命令安装 Sequelize 的依赖。
$ npm install --save sequelize pg pg-hstore
上面的 pg 和 pg-hstore 是 Sequelize 的驱动项,用于将 Sequelize 与 PostgreSQL 数据库进行集成。
集成 Sequelize ORM
通过以下命令,在你的项目中添加一个名为 models 的文件夹,它将用于存放 Sequelize 模型(models)和数据表(tables)的映射。在这个文件夹内,你需要创建一个名为 index.js 的文件,并在这个文件内进行相关配置。你还可以通过使用 Sequelize 提供的 CLI 工具,来快速地生成模型和数据表间的关系。
- 配置 Sequelize
在models/index.js文件中,你需要引用 Sequelize 并进行配置。以下是一个示例:
-- -------------------- ---- ------- ----- --------- - --------------------- ----- ---- - ---------------- ----- --------- - --- ------------------------------ -------------------- -------------------- - -------- ----------------------- ----- ------------------- --- -------------- - - ---------- ---------- ------- --- --
这个代码将会根据你的环境变量来配置数据库信息,并创建一个名为 sequelize 的对象实例,这个对象将用于后续的数据表操作。同时,这个模块还提供了一个名为 Sequelize 的类,以便用于模型定义。
- 定义模型
模型(Model)代表着数据库中的一个数据项,每个数据项对应着数据库中的一张表。通过定义模型,你可以规定数据项的属性和方法,同时还能够方便地进行表和模型之间的映射。
以下是一个示例模型定义:
-- -------------------- ---- ------- ----- - ---------- --------- - - -------------------- ----- ---- - ------------------------ - --- - ----- --------------- ----------- ----- -- --------- - ----- ----------------- -- ------ - ----- ----------------- -- --------- - ----- ----------------- -- --- -------------- - -----
这个代码将会创建一个名为 User 的模型,它将与名为 users 的数据表进行映射。模型内还定义了 id、username、email、password 等属性,以便用于数据项的操作,例如 CRUD 操作。
- 自动关联
在应用程序中,不同表之间往往需要建立关联,为了提高代码复用率和减少维护成本,您可以一次性加载数据库中的所有模型并建立关联。这样能够方便地在以后的维护中进行管理。
以下是一个通过导入和自动关联模型的示例:
-- -------------------- ---- ------- ----- - ---------- ---------- ------ - - --------------------- ----- -- - -------------- ----- ---- - ---------------- ------------------------- -------------- -- ----------------- --- - -- ---- --- ----------- --------------- -- - ----- ----- - ------------------------------------- ------- ------------------ - ------ --- --------------------------------------- -- - -- ----------------------------- - ------------------------------------ - --- -------------- - -------
这个代码将会自动加载 models 目录下的所有文件,并将这些文件中定义的模型与数据库进行映射,同时还创建了一个名为 models 的对象,以便方便地在应用程序中引用。如果你想定义关联,请确保在每个模型内实现 associate 方法。
集成 Hapi.js
在接下来的步骤中,我们将会介绍如何使用 Hapi.js 来集成 Sequelize ORM,以便于在一个 Web 应用中方便地进行数据库操作。
- 配置数据库连接
在开始之前,我们需要在项目中配置好数据库连接。要完成这个步骤,你需要创建一个名为 .env 的文件,以便在其中存放连接数据库的配置信息。
DB_NAME=hapi_sequelize_demo DB_USER=user DB_PASS=pass DB_DIALECT=postgres DB_HOST=localhost
- 建立 Web 服务
使用 Hapi.js,我们可以方便地构建服务入口,并且添加路由管理。
以下是一个创建 Web 服务的解决方案:
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------ - -------------------- ----- ------ - -------------------- ----- ------ - --- -------------- ------------------- ----- ----- --- --------------------- ------------------ -- - -- ----- - ------------------- ----- ---- - ------------------- -- --------- -- --------------------- ---
这个代码将会创建一个名为 server 的实例,并且将它绑定到 3000 端口。我们还可以通过 routes 变量来添加路由管理功能。通过 models 变量,我们可以在服务中方便地引用加载好的模型。
- 添加路由管理
以下是一个使用 Hapi.js 添加路由管理的解决方案:
-- -------------------- ---- ------- ----- --- - --------------- ----- ---- - ---------------- ----- ------ - -------------------- -------------- - - - ------- ------ ----- ---- -------- --------- ------ -- - ----- ------- - ------- ------- ---- ------------ --------------- -- -- - ------- ------ ----- --------- -------- --------- ------ -- - ------ ----------------------- ------------ -- ------- ---- --- ------------ -- -------------------------------------- ------- ------- -- -- - ------- ------- ----- --------- ------- - --------- - -------- ------------ --------- ------------------------ ------ -------------------------------- --------- ------------------------------- --- -- -- -------- --------- ------ -- - ------ ----------------------------------- ------------ -- ------------ ------------ -- -------------------------------------- ------- ------- -- -- --
这些代码将会定义 3 条路由规则,分别用于返回欢迎信息、获取所有用户信息以及添加新用户信息。
在 routes 中,使用了 Joi 对参数进行了校验以避免不合法数据的提交。Hapi.js 还提供了 Boom 库来处理错误信息。
总结
在这篇文章中,我们介绍了如何通过 Hapi.js 集成 Sequelize ORM,以便于更方便地进行数据库操作。在整个过程中,我们完成了 ORM 配置、定义模型和实体关系、自动关联以及使用 Hapi.js 构建 Web 服务和添加路由管理等过程。这些步骤可以帮助你快速在 Node.js 应用中集成 Sequelize ORM 和 Hapi.js,为你的数据库操作带来方便。
示例代码请见我的 Gihub 仓库:How to integrate Sequelize ORM with Hapi.js in Node.js。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/649082de48841e9894ea6b84