Express 路由和中间件 的详细介绍及使用

Express 路由和中间件 的详细介绍及使用

引用

CSDN

1.

https://blog.csdn.net/m0_57184906/article/details/138215277

Express是Node.js环境中广受欢迎的Web应用框架，其核心特性之一就是灵活且强大的路由系统和中间件机制。本文将详细介绍Express中的路由和中间件的概念、使用方法以及最佳实践，帮助开发者更好地理解和应用这些核心特性。

Express 路由 的概念

什么是路由

• 广义上来讲，路由就是映射关系

现实生活中的路由

在这里，路由是按键与服务之间的映射关系

Express 中的路由

• 在 Express 中，路由指的是客户端的请求与服务器处理函数之间的映射关系
• Express 中的路由分 3 部分组成，分别是请求的类型、请求的 URL 地址、处理函数
• 格式如下：
  

Express 中的路由的例子

路由的匹配过程

• 每当一个请求到达服务器之后，需要先经过路由的匹配，只有匹配成功之后，才会调用对应的处理函数
• 在匹配时，会按照路由的顺序进行匹配，如果请求类型和请求的 URL 同时匹配成功，则 Express 会将这次请求，转交给对应的 function 函数进行处理
  路由匹配的注意点：
  ① 按照定义的先后顺序进行匹配
  ② 请求类型和请求的URL同时匹配成功，才会调用对应的处理函数

Express 路由 的使用

最简单的用法

• 在 Express 中使用路由最简单的方式，就是把路由挂载到 app 上
• 示例代码如下：
  

模块化路由

2.2.1. 为什么

• 为了方便对路由进行模块化的管理，Express不建议将路由直接挂载到 app 上，而是推荐将路由抽离为单独的模块
  2.2.2. 路由抽离为单独模块的步骤
• 创建路由模块对应的 .js 文件
• 调用 express.Router() 函数创建路由对象
• 向路由对象上挂载具体的路由
• 使用 module.exports 向外共享路由对象
• 使用 app.use() 函数注册路由模块

创建路由模块

注册路由模块

为路由模块添加前缀

类似于托管静态资源时，为静态资源统一挂载访问前缀一样

• 路由模块添加前缀方式如下：

Express 中间件 的概念

什么是中间件

• 中间件（Middleware ），特指业务流程的中间处理环节

中间件——现实生活中的例子

• 在处理污水的时候，一般都要经过三个处理环节，从而保证处理过后的废水，达到排放标准。
• 处理污水的这三个中间处理环节，就可以叫做中间件。

Express 中间件的调用流程

• 当一个请求到达 Express 的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理

Express 中间件的格式

• Express 的中间件，本质上就是一个function 处理函数
• Express 中间件的格式如下：
  注意：中间件函数的形参列表中，必须包含 next 参数。而路由处理函数中只包含 req 和 res

next 函数的作用

• next 函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由

Express 中间件 的初体验

定义中间件函数

• 可以通过如下的方式，定义一个最简单的中间件函数

全局生效的中间件

• 客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件
• 通过调用 app.use(中间件函数)，即可定义一个全局生效的中间件
• 示例代码如下：

定义全局中间件的简化形式

中间件的作用

• 多个中间件之间，共享同一份req和res。基于这样的特性，我们可以在上游的中间件中，统一为 req 或 res 对象添 加自定义的属性或方法，供下游的中间件或路由进行使用

定义多个全局中间件

• 可以使用 app.use() 连续定义多个全局中间件
• 客户端请求到达服务器之后，会按照中间件定义的先后顺序依次进行 调用
• 示例代码如下：

局部生效的中间件

• 不使用app.use() 定义的中间件，叫做局部生效的中间件
• 示例代码如下：

定义多个局部中间件

• 可以在路由中，通过如下两种等价的方式，使用多个局部中间件

了解中间件的5个使用注意事项

• 一定要在路由之前注册中间件
• 客户端发送过来的请求，可以连续调用多个中间件进行处理
• 执行完中间件的业务代码之后，不要忘记调用 next() 函数
• 为了防止代码逻辑混乱，调用 next() 函数后不要再写额外的代码
• 连续调用多个中间件时，多个中间件之间，共享 req 和 res 对象

中间件的分类

Express 官方把常见的中间件用法，分成了 5 大类

• 应用级别的中间件
• 路由级别的中间件
• 错误级别的中间件
• Express 内置的中间件
• 第三方的中间件

应用级别的中间件

• 通过 app.use() 或 app.get() 或 app.post() ，绑定到 app 实例上的中间件，叫做应用级别的中间件
• 代码示例如下：

路由级别的中间件

• 绑定到 express.Router() 实例上的中间件，叫做路由级别的中间件
• 它的用法和应用级别中间件没有任何区别
  应用级别中间件是绑定到 app 实例上，路由级别中间件绑定到 router 实例上
• 代码示例如下：

错误级别的中间件

• 错误级别中间件的作用：专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题
• 格式：错误级别中间件的 function 处理函数中，必须有 4 个形参，形参顺序从前到后，分别是 (err, req, res, next)
• 注意：错误级别的中间件， 必须注册在所有路由之后！

Express内置的中间件

自 Express 4.16.0 版本开始，Express 内置了 3 个常用的中间件，极大的提高了 Express 项目的开发效率和体验

• express.static 快速托管静态资源的内置中间件，例如： HTML 文件、图片、CSS 样式等（无兼容性）
• express.json 解析 JSON 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
• express.urlencoded 解析 URL-encoded 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）

第三方的中间件

• 介绍：非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置 第三方中间件，从而提高项目的开发效率
• 例子：在 express@4.16.0 之前的版本中，经常使用 body-parser 第三方中间件，来解析请求体数据。
  body-parser 第三方中间件使用步骤如下：
  运行 npm install body-parser 安装中间件
  使用 require 导入中间件
  调用 app.use() 注册并使用中间件
• 注意：Express 内置的 express.urlencoded 中间件，就是基于 body-parser 这个第三方中间件进一步封装出来的

自定义中间件

需求描述与实现步骤

• 自己手动模拟一个类似于 express.urlencoded 这样的中间件，来解析 POST 提交到服务器的表单数据。
• 实现步骤

定义中间件

• 使用 app.use() 来定义全局生效的中间件，代码如下：

监听 req 的 data 事件

• 在中间件中，需要监听 req 对象的 data 事件，来获取客户端发送到服务器的数据。
• 如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以 data 事件可能会触发多次，每一次触发 data 事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。

监听 req 的end事件

• 当请求体数据接收完毕之后，会自动触发 req 的 end 事件，因此，我们可以在 req 的 end 事件中，拿到并处理完整的请求体数据。示例代码如下：

使用 querystring 模块解析请求体数据

• Node.js 内置了一个 querystring 模块，专门用来处理查询字符串。通过这个模块提供的 parse() 函数，可以轻松把 查询字符串，解析成对象的格式。示例代码如下：

将解析出来的数据对象挂载为 req.body

• 上游的中间件和下游的中间件及路由之间，共享同一份 req 和 res。因此，我们可以将解析出来的数据，挂载为 req 的自定义属性，命名为 req.body，供下游使用。示例代码如下：

将自定义中间件封装为模块

• 为了优化代码的结构，我们可以把自定义的中间件函数，封装为独立的模块，示例代码如下：