Node | Express中间件简单使用

Node | Express中间件简单使用

一月 30, 2022
该文章更新于 2022.01.30

一、什么是Express中间件

中间件特指业务流程的中间处理环节。

二、Express中间件的调用流程

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

三、中间件格式

本质上就是function处理函数

注意:中间件函数的形参列表中,必须包含next参数。而路由处理函数中只包含req和res,

1
2
3
4
5
6
// next参数必须在最后一个传入
const mw = (req, res, next) => {
...
// next()必须在最后调用
next()
}

四、next()函数的作用

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

五、全局生效的中间件

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

1
2
3
4
5
6
7
8
9
10
const mw = (req, res, next) => {
next()
}

const mw1 = (req, res, next) => {
next()
}

// 全局生效的中间件,中间件调用顺序以传入顺序为准
server.use(mw,mw1)

六、局部生效的中间件

局部中间件只在某一个指定的路由路径生效

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
const mw = (req, res, next) => {
next()
}
const mw1 = (req, res, next) => {
next()
}
// 局部生效的中间件
server.get('/',mw,(req,res)=>{
res.send('路径:/')
})



// 定义多个局部生效的中间件
// 1、直接逗号分隔
server.get('/',mw,mw1,(req,res)=>{
res.send('路径:/')
})
// 2、或者使用数组包含
server.get('/',[mw,mw1],(req,res)=>{
res.send('路径:/')
})

七、中间件的作用

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

1
2
3
4
5
const mw = (req, res, next) => {
// 添加属性
req.startTime=new Date()
next()
}

八、Express中间件的五个注意点

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

九、Express中间件的分类

  1. 应用级别的中间件
  2. 路由级别的中间件
  3. 错误级别的中间件
  4. Express内置的中间件
  5. 第三方的中间件

详细介绍:

  • 应用级别的中间件

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

    1
    2
    3
    4
    5
    6
    // 全局生效的中间件(应用级别的中间件)
    server.use(mw,mw1)
    // 局部生效的中间件(应用级别的中间件)
    server.get('/',mw,mw1,(req,res)=>{
    res.send(`请求进入服务器的时间:${req.startTime}`)
    })
  • 路由级别的中间件

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

    1
    2
    3
    4
    5
    const router = require('./router/router')
    // 路由级别的中间件
    router.use((req,res,next)=>{
    next()
    })
  • 错误级别的中间件

    错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。

    格式∶错误级别中间件的 function处理函数中,必须有4个形参,形参顺序从前到后,分别是(err, req, res, next)。

    注意:错误级别的中间件,必须注册在所有路由之后!

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    // 人为制造错误
    server.get('/err', (req, res) => {
    throw new Error('人为抛出错误!!!')
    res.send('err Page')
    })
    // 定义错误级别的中间件
    server.use((err, req, res, next) => {
    console.log('发生了错误:' + err.message);
    res.send('Error:'+err.message)
    next()
    })
  • Express内置的中间件

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

    1. express.static快速托管静态资源的内置中间件,例如:HTML文件、图片、CSS样式等(无兼容性)
    2. express.json解析JSON格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
    3. express.urlencoded解析URL-encoded格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    // 配置解析application/json格式数据的内置中间件
    server.use(express.json())
    // 配置解析application/x-www-form-urlencoded格式数据的内置中间件
    server.use(express.urlencoded({
    extended: false
    }))
    // 测试解析json的内置中间件
    server.post('/user',(req,res)=>{
    // 在服务器,可以使用req.body这个属性来接受客户端发送过来的请求数据
    // 默认情况下,如果不配置解析表单数据的中间件,则req.body默认等于undefined
    console.log(req.body);
    res.send('ok')
    })

    // 测试解析urlencoded的内置中间件
    server.post('/book',(req,res)=>{
    console.log(req.body)
    res.send('book ok')
    })
  • 第三方的中间件

    非Express官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。
    例如:在express@4.16.0之前的版本中,经常使用body-parser这个第三方中间件,来解析请求体数据。使用步骤如下:

    1. 运行npm install body-parser安装中间件
    2. 使用require导入中间件
    3. 调用server.use()注册并使用中间件

    注意:Express 内置的express.urlencoded 中间件,就是基于body-parser这个第三方中间件进一步封装出来的。

我的博客即将同步至腾讯云开发者社区,邀请大家一同入驻:云社区链接