介绍
在 Web 开发中,处理数据库是不可避免的任务之一。为了让前端开发更加高效和便捷,现有很多成熟的工具和框架可供选择。本文将介绍如何使用 Fastify 和 Sequelize ORM 来处理数据库操作。
Fastify 是一个快速、低开销、可扩展的 Node.js web 框架。它尤其适合处理高效率和高性能的应用程序。Sequelize 是一个基于 Promise 的 Node.js ORM(Object Relational Mapping),它提供了易于使用的 API,使得对关系数据库的操作更加容易,而不用编写 SQL。
本文的重点是使用 Fastify 和 Sequelize ORM 处理数据库,指导你如何使用这两个工具来建立 Web 应用程序的数据层。本文将介绍如何使用 Sequelize ORM 进行基本的数据访问和设计模式。我们将使用 Postgres 作为数据库和 Fastify 作为 web 框架,并讨论如何配置这些工具以便于开发。
安装及引用
首先,使用 npm 或 yarn 安装所需的依赖:
npm i fastify pg fastify-autoload sequelize dotenv
以上依赖的版本可能会有所更新。需要时,请使用最新的版本,以避免潜在的依赖错误。
安装完成后,可以在文件的顶部引入它们:
const fastify = require('fastify')({ logger: true }) const { Sequelize, DataTypes } = require('sequelize') const path = require('path') require('dotenv').config({ path: path.join(__dirname, '..', '.env') })
连接到 database
建立连接到数据库的最简单方法是使用 Sequelize 提供的 .authenticate()
方法。 该方法返回一个 Promise,如果 authentication 成功,则该 Promise 将解析为实例,反之则会抛出一个错误。
Sequelize 接口接受一个连接字符串和选项对象。下面是一个使用 sequelize.connect() 方法连接 database 的例子:
-- -------------------- ---- ------- ----- --------- - --- ---------- -------------------- -------------------- ------------------------ - ----- -------------------- -------- ----------- -------- ----- - - -------------------------------- -- - ----------------------- --- ---- ----------- ---------------- -------------- -- - --------------------- -- ------- -- --- ----------- ------------- ----- --- ----------- ---
使用 Sequelize Model 执行 CRUD 操作
Sequelize Model 是用来定义数据库 table的,可以定义 table 的名称,字段类型和约束等。使用 Model 的好处是把 webpack SQL 语句抽象成对象或者函数的形式,便于管理和修改。
定义一个 Model
下面是一个简单的例子,它定义了一种名为 Book
的 Model
:
-- -------------------- ---- ------- ----- ---- - ------------------------- - ------ - ----- ----------------- ---------- ----- -- ------- - ----- ----------------- ---------- ----- -- -------------- - ----- ------------------- ---------- ----- - --
创建 table
可以使用 sequelize.sync()
方法创建 table。如果 table 已经存在,则不会创建,而是检查 table 是否需要执行更新操作,具体更新内容由 Model 定义的字段决定。
sequelize.sync().then(() => { console.log('Create table if not existed'); }).catch((err) => { console.error('Unable to sync:', err.message); throw new Error(err); });
插入一条记录
-- -------------------- ---- ------- ------------- ------ ---- ----- -------- ------- --- ----- ------------ -------------- ------------ -------------- -- - -------------------------- --- ---- ----------- -------------- -- - --------------------- -- --------- ------------- ----- --- ----------- ---
查询一条记录
Book.findOne({ 'title': 'The Great Gatsby' }).then((book) => { console.log(JSON.stringify(book)); }).catch((err) => { console.error('Unable to find:', err.message); throw new Error(err); });
更新一条记录
Book.update({ author: 'Francis Scott Fitzgerald' }, { where: { title: 'The Great Gatsby' } }).then((book) => { console.log(`${book[0]} row(s) updated.`); }).catch((err) => { console.error('Unable to update:', err.message); throw new Error(err); });
删除一条记录
Book.destroy({ where: { title: 'The Great Gatsby' } }).then((count) => { console.log(`${count} row(s) deleted.`); }).catch((err) => { console.error('Unable to delete:', err.message); throw new Error(err); });
在 Fastify 中使用 Sequelize
我们已经对 Sequelize 和使用 Sequelize 的基本概念有了初步了解,下面我们将介绍如何在 Fastify 中使用 Sequelize。
注册路由和 Model
fastify.register(require('fastify-autoload'), { dir: path.join(__dirname, 'routes') }) fastify.register(require('fastify-autoload'), { dir: path.join(__dirname, 'models') })
从以上代码中可以看出,我们使用 fastify-autoload
插件来自动加载文件目录(在这里为 routes 和 models),便于代码管理和维护。
注册 Sequelize
-- -------------------- ---- ------- ----- --------- - --- ---------- -------------------- -------------------- ------------------------ - ----- -------------------- -------- ----------- -------- ----- - - -------------------------------- -- - ----------------------- --- ---- ----------- ---------------- -------------- -- - --------------------- -- ------- -- --- ----------- ------------- ----- --- ----------- --- ----------------------------- ----------
我们在 Fastify 实例上添加了 sequelize
对象,以便在其他组件中使用。
通过 Decorator 注册 Sequelize Model
fastify.decorate('models', {}) fastify.register(async (fastify, opts) => { fastify.models.Book = require('../models/Book')(fastify.sequelize) fastify.addHook('onClose', fastify.models.Book.close.bind(fastify.models.Book)) })
第一行代码创建了一个空的 models
对象,用于在后面将 Model 添加到内部。
我们在注册路由的钩子函数中加载 Book
model,如上代码所示,require('../models/Book')
返回一个好的 model 的构造函数,这个构造函数接受实例化后的 Sequelize 对象作为一个参数。我们让 Fastify 实例对象执行这个构造函数,并将 Model 实例化赋值给 fastify.models.Book
。
注意 addHook
是为了在 Fastify 退出时关闭 Sequelize 连接用的。
再次定义路由,处理 Model 的增删改查操作
-- -------------------- ---- ------- -------------- ------- ------- ---- -------- ------- -------- ----- -------- ----- ---- - ----- ---- - ----- --------------------------------- ------ -------------- - -- -------------- ------- ------ ---- ------------ ------- -------- ----- -------- ----- ---- - ----- ---- - ----- -------------------------- ------ - --- ------------- - -- ------ -------------- - -- -------------- ------- ------ ---- ------------ ------- -------- ----- -------- ----- ---- - ----- -------- - ----- --------------------------------- - ------ - --- ------------- - -- -- ------- --- -- - ------ ---------------------- -------- ----- --- ------- -- - ------ ---------- -------- ---------- -- - -- -------------- ------- --------- ---- ------------ ------- -------- ----- -------- ----- ---- - ----- ------ - ----- -------------------------- ------ - --- ------------- - -- -- ------- --- -- - ------ ---------------------- -------- ----- --- ------- -- - ------ ---------- -------- ---------- -- - --
上述代码中的 this.models.Book
是 fastify.models.Book 的别名,它使用 this
是因为我们希望在路由处理器中使用 ".bind(this)"来绑定 models
的上下文。
结论
本文主要介绍了使用 Fastify 和 Sequelize ORM 处理数据库的方法,其中包括了初始化连接,Model 定义以及执行 CRUD 操作的示例教程。在结合 Fastify 框架使用 Sequelize ORM 时,我们还通过 Decorator 和路由的设计模式,让数据访问更加便捷和灵活。
最后,希望读者以本文为基础,在实际开发工作中有更好的体验,提高 Web 开发水平。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/66fd2e8244713626017a5726