Fastify 和 TypeORM:实现 ORM 操作的完整指南

在现代 Web 开发中,ORM(对象关系映射)是一种非常重要的技术,它可以让开发者更加方便地进行数据库操作,避免了直接操作数据库的繁琐和复杂。在 Node.js 生态系统中,有很多优秀的 ORM 库可以选择,比如 Sequelize、TypeORM 等。本文主要介绍如何使用 Fastify 和 TypeORM 实现 ORM 操作,包括数据库连接、实体定义、查询和关联等方面的内容。

准备工作

在开始之前,我们需要准备好以下工具和环境:

  • Node.js 运行环境(推荐版本 12+)
  • npm 包管理工具
  • MySQL 数据库

在本文中,我们将使用 Fastify 作为 Web 框架,TypeORM 作为 ORM 库,MySQL 作为数据库。如果你对这些工具还不熟悉,可以先阅读官方文档了解一下。

安装和配置

首先,我们需要创建一个新的 Node.js 项目,并安装 Fastify 和 TypeORM 两个库:

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

其中,fastify-cors 和 fastify-jwt 是 Fastify 的插件,用于处理跨域和 JWT 认证等问题。mysql2 是 MySQL 的 Node.js 驱动程序,TypeORM 依赖它来进行数据库操作。

接下来,我们需要配置 TypeORM 的连接信息。在项目根目录下创建一个 ormconfig.json 文件,内容如下:

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

其中,type 是数据库类型,host 和 port 是数据库服务器的地址和端口,username 和 password 是数据库用户名和密码,database 是要连接的数据库名称,synchronize 表示是否自动同步数据库结构(仅用于开发环境),logging 表示是否启用日志输出,entities 是实体类的存放路径。

定义实体类

在 TypeORM 中,实体类是 ORM 操作的核心,它对应了数据库中的表结构。我们需要先定义好实体类,才能进行数据操作。在 src/entities 目录下创建一个 user.ts 文件,内容如下:

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

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

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

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

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

其中,@Entity() 表示这个类是一个 TypeORM 实体,@PrimaryGeneratedColumn() 表示这个属性是主键并自动递增,@Column() 表示这个属性对应了数据库表的一个列。

我们还可以使用其它的装饰器来指定实体类的详细信息,比如索引、关系等。这些内容超出了本文的范围,有兴趣的读者可以查阅官方文档。

连接数据库

有了实体类之后,我们就可以连接数据库了。在 src/index.ts 中,添加以下代码:

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

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

这段代码会读取 ormconfig.json 文件中的数据库连接信息,并尝试连接数据库。如果连接成功,就会输出 Connected to database。如果连接失败,就会输出 Failed to connect to database,并打印错误信息。

实现基本 CRUD 操作

有了连接之后,我们就可以开始实现基本的 CRUD(增删改查)操作了。在 src/index.ts 中,添加以下代码:

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

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

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

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

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

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

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

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

这段代码定义了五个路由,分别对应了查询所有用户、查询单个用户、创建用户、更新用户和删除用户这五个操作。其中,GET 方法使用了 TypeORM 的 find 和 findOne 方法,分别表示查询所有和查询单个;POST 方法使用了 TypeORM 的 save 方法,表示创建一个新的实体;PUT 方法也使用了 save 方法,表示更新一个已有的实体;DELETE 方法使用了 remove 方法,表示删除一个实体。

实现关联查询

除了基本的 CRUD 操作之外,TypeORM 还支持复杂的关联查询,可以轻松地查询到相关联的实体。在 src/entities 目录下创建一个 post.ts 文件,定义一个新的实体类:

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

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

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

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

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

这个实体类和 User 实体类之间有一个 ManyToOne 的关联关系,表示一个 Post 实体对应了一个 User 实体,而一个 User 实体可以对应多个 Post 实体。在 User 实体类中,添加一个 posts 属性,表示它的所有 Post 实体。修改 User 实体类如下:

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

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

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

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

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

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

有了关联关系之后,我们就可以进行关联查询了。在 src/index.ts 中,添加以下代码:

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

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

这段代码定义了两个路由,分别对应了查询用户的所有文章和查询文章的作者这两个操作。在 findOne 方法的第三个参数中,使用了 relations 属性指定了要查询的关联实体,这样就可以一次性查询到相关联的所有实体。

实现 JWT 认证

最后,我们还可以添加 JWT(JSON Web Token)认证,保护一些敏感的接口。在 src/index.ts 中,添加以下代码:

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

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

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

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

这段代码使用了 fastify-jwt 插件来实现 JWT 认证。在注册插件时,指定了一个 secret 属性,表示 JWT token 的密钥。在登录接口中,使用 findOne 方法查询用户,如果存在则生成一个 JWT token 并返回。在获取当前用户信息的接口中,首先使用 verify 方法验证 JWT token 是否正确,然后根据 userId 查询用户信息,并返回。

总结

本文介绍了如何使用 Fastify 和 TypeORM 实现 ORM 操作,包括数据库连接、实体定义、查询和关联等方面的内容。通过本文的学习,读者可以了解到如何使用 TypeORM 进行基本的 CRUD 操作和复杂的关联查询,以及如何使用 JWT 认证保护敏感的接口。当然,这只是一个简单的示例,实际的项目中还会涉及到很多其它的问题和细节,需要读者自己不断地学习和探索。

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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前