Express 中间件

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

Express的中间件本质上就是一个 function 处理函数

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

区别路由函数和中间件函数就是看参数是否包含next

局部生效的中间件

app.post('/',(req,res,next)=>{
  console.log('局部的中间件！');
  next();
}); // 只在请求路径为 / 时才生效的中间件

全局生效的中间件

// 只要有请求到达服务器，必然会调用这个中间件
app.use((req,res,next)=>{
  console.log('全局可用的中间件！');
  next();
})

调用多个中间件

// 定义中间件函数 mv1
   const mv1 = (req, res, next) => {
     console.log('这是第一个中间件函数')
     next()
   }
// 定义中间件函数 mv2
   const mv2 = (req, res, next) => {
     console.log('这是第二个中间件函数')
     next()
   }
   
   // mv1、mv2 这个中间件只在 "当前路由中生效"，这种用法属于 "局部生效的中间件"
   app.get('/', mv1, mv2, (req, res) => {
     res.send('Home Page')
   })
 
   // 也可以使用数组的形式绑定两个中间件
   app.get('/user', [mv1, mv2], (req, res) => {
     res.send('Home Page')
   })

中间件的注意事项

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

中间件的分类

1. 应用级别的中间件

通过 app.use() 或 app.METHOD() 函数，绑定到 app 实例上的中间件，叫做应用级别的中间件

2. 路由级别的中间件

绑定到 express.Router() 实例上的中间件，叫做路由级别的中间件

用法上和应用级别中间件没有任何区别，只不过，应用级别中间件是绑定到 app 实例上，路由级别中间件绑定到 router 实例上

var app = express()
var router = express.Router()

// 路由级别的中间件
router.use(function(req,res,next){
  console.log('Time:',Data.now())
  next()
})


app.use('/',router) // 挂载在全局上

3. 错误级别的中间件

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

注意：错误级别的中间件，必须注册在所有路由之后(因为捕获不到之后出现的异常)

// 1. 路由
app.get('/', (req, res) => {
  // 1.1 抛出一个自定义的错误
  throw new Error('服务器内部发生了错误')

  res.send('Home Page.')
})

// 2. 错误级别的中间件
// 注意：错误级别的中间件，必须注册在所有路由之后
app.use((err, req, res, next) => {
  // 2.1 在服务器打印错误消息
  console.log('发生了错误：' + err.message)

  // 2.2 向客户端响应错误相关的内容 
  res.send(err.message)
})

4. Express内置的中间件

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

express.urlencoded 解析 URL-encoded 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）

// 配置解析 application/json 格式数据的内置中间件
app.use(express.json())
// 配置解析 application/x-www-form-urlencoded 格式数据的内置中间件
app.use(express.urlencoded({extended:false}))

urlencoded 默认为 true
true: 使用第三方包 qs 解析 请求体数据
false: 使用内置模块 querystring 解析 请求体数据
qs 比 querystring 复杂(更强大), 但是内置模块 querystring 已经足够使用了, 所以里面的参数可以省略不写 express.urlencoded()


// 一般挂载到局部上,避免资源浪费

// 在服务器，可以使用 req.body 这个属性，来接收客户端发送过来的请求体数据
// 默认情况下，如果不配置解析表单数据的中间件，则req.body默认等于undefined

`express.json` 中间件的使用

`express.json()` 中间件，解析表单中的 `JSON` 格式的数据

const express = require('express')
   const app = express()
   
   // 注意：除了错误级别的中间件，其他的中间件，必须在路由之前进行配置
   // 通过 express.json() 这个中间件，解析表单中的 JSON 格式的数据
   app.use(express.json())
   
   app.post('/user', (req, res) => {
     // 在服务器，可以使用 req.body 这个属性，来接收客户端发送过来的请求体数据
     // 默认情况下，如果不配置解析表单数据中间件，则 req.body 默认等于 undefined
     console.log(req.body)
     res.send('ok')
   })
   
   app.listen(3000, () => {
     console.log('running……')
   })

`express.urlencoded` 中间件的使用

`express.urlencoded` 解析 `URL-encoded` 格式的请求体数据

const express = require('express')
   const app = express()
   
   // 通过 express.urlencoded() 这个中间件，来解析表单中的 url-encoded 格式的数据
   app.use(express.urlencoded({ extended: false }))
   
   app.post('/book', (req, res) => {
     console.log(req.body)
     res.send(req.body)
   })
   
   app.listen(3000, () => {
     console.log('running……')
   })

5. 第三方的中间件

非 Express 官方内置的中间件，而是由第三方开发出来的 Express 中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。

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

const express = require('express')
   const app = express()
   
   // 1. 导入解析表单数据的中间件 body-parser
   const bodyParser = require('body-parser')
   
   // 通过 express.urlencoded() 这个中间件，来解析表单中的 url-encoded 格式的数据
   // app.use(express.urlencoded({ extended: false }))
   
   // 2. 使用 app.use() 注册中间件
   app.use(bodyParser.urlencoded({ extended: false }))
   
   app.post('/book', (req, res) => {
     console.log(req.body)
     res.send(req.body)
   })
   
   app.listen(3000, () => {
     console.log('running……')
   })

自定义中间件

手动模拟一个类似于 express.urlencoded 这样的中间件，来解析 POST 提交到服务器的`application/x-www-form-urlencoded`格式的表单数据。

步骤：

定义中间件
监听 req 的 data 事件
监听 req 的 end 事件
使用 querystring 模块解析请求体数据
将解析出来的数据对象挂载为 req.body
将自定义中间件封装为模块

定义中间件

1
2
3

app.use((req,res,next)=>{
  // 中间键的业务逻辑
})

data事件

在中间件中，需要监听 req 对象的 data 事件，来获取客户端发送到服务器的数据。

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

// 定义变量，用来存储客户端发送过来的请求体数据
let str = '';
// 客户端发送过来新的请求体数据就会触发
req.on('data',(chunk)=>{
  // 拼接请求体数据，隐式转换为字符串
  str += chunk;
})

end事件

// 请求体发送完毕后触发
req.on('end',()=>{
  // 打印完整的请求体数据
  console.log(str);
})

querystring 模块

// 导入处理 querystring 的 Node.js 内置模块
const qs = require('querystring');

// 调用qs.parse() 方法，把查询字符串解析为对象
const body = qs.parse(str);

挂载到req.body

req.on('end',()=>{
  const body = qs.parse(str);
  req.body = body;
  next();
})

封装为模块

// custom-body-parser.js 模块中的代码
const qs = require('querystring');

function bodyParser(req,res,next){
    
    let str = '';
	req.on('data',(chunk)=>{
		str += chunk;
	})

	req.on('end',()=>{
		const body = qs.parse(str);
		req.body = body;
		next();
	})
}
module.exports = bodyParser // 向外导出解析请求体数据的中间件函数
---------------------------------------
const myBodyParser = require('custom-body-parser.js')
app.use(myBodyParser)
app.get('/user',(req,res)=>{
	console.log(req.body)
	res.send(req.body)
})

app.listen(9090,()=>{
	console.log('http://localhost:9090')
})

Express 写接口

创建基本的服务器

// 导入 express 模块
const express = require('express')

// 创建 express 的服务器实例
const app = express()

// 调用 app.listen 方法，指定端口号并启动 web 服务器
app.listen(3000, () => {
  console.log('running……')
})

创建 API 路由模块

// router.js

const express = require('express')
const router = express.Router()

// 在这里挂载对应的路由


module.exports = router // 向外共享

// index.js

// 导入 express 模块
const express = require('express')

// 创建 express 的服务器实例
const app = express()

// 导入路由模块
const router = require('./router.js')
// 把路由模块，注册到 app 上
app.use('/api', router)

// 调用 app.listen 方法，指定端口号并启动 web 服务器
app.listen(3000, () => {
  console.log('running……')
})

编写 get 请求

const express = require('express')
const router = express.Router()

// 在这里挂载对应的路由
router.get('/book', (req, res) => {
  // 通过 req.query 获取客户端通过查询字符串发送到服务器的数据
  const query = req.query

  // 调用 res.send() 方法，想客户端响应处理的结果
  res.send({
    status: 0,  // 0 表示处理成功，1 表示处理失败
    msg: 'GET 请求成功',  // 状态描述
    data: query // 需要响应给客户端的数据
  })
})

module.exports = router

编写post请求

注意：如果要获取 URL-encoded 格式的请求体数据，必须配置中间件 app.use(express.urlencoded({ extended: false }))

const express = require('express')
const router = express.Router()

// 在这里挂载对应的路由

// 定义 POST 接口
router.post('/book', (req, res) => {
  // 通过 req.body 获取请求题中包含的 url-encoded 格式的数据
  const body = req.body

  // 调用 res.send() 方法，向客户端响应结果
  res.send({
    status: 0,
    msg: 'Post 请求成功',
    data: body
  })
})

module.exports = router

// index.js
// 导入 express 模块
const express = require('express')

// 创建 express 的服务器实例
const app = express()

// 配置解析表单数据的中间件
//注意：如果要获取 URL-encoded 格式的请求体数据，必须配置中间件 app.use(express.urlencoded({ extended: false }))
app.use(express.urlencoded({ extended: false }))

// 导入路由模块
const router = require('./020-apiRouter')
// 把路由模块，注册到 app 上
app.use('/api', router)

// 调用 app.listen 方法，指定端口号并启动 web 服务器
app.listen(3000, () => {
  console.log('running……')
})

CORS

接口的跨域问题

到目前为止，我们编写的 GET 和 POST 接口，存在一个很严重的问题：不支持跨域请求
解决接口跨域问题的方案主要有两种

CORS (主流的解决方案，推荐使用)
JSONP (有缺陷的解决方案：只支持 GET 请求)

使用 cors 中间件解决跨域问题

cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件，可以很方便地解决跨域问题
使用步骤
- 安装中间件： npm install cors
- 导入中间件： const cors = require('cors')
- 配置中间件：在路由之前调用 app.use(cors())

案例代码

// 导入 express 模块
   const express = require('express')
   
   // 创建 express 的服务器实例
   const app = express()
   
   // 导入中间件
   const cors = require('cors')
   // 配置中间件
   app.use(cors())
   
   // 配置解析表单数据的中间件
   app.use(express.urlencoded({ extended: false }))
   
   // 导入路由模块
   const router = require('./020-apiRouter')
   // 把路由模块，注册到 app 上
   app.use('/api', router)
   
   // 调用 app.listen 方法，指定端口号并启动 web 服务器
   app.listen(3000, () => {
     console.log('running……')
   })

什么是 CORS

CORS (跨域资源共享) 由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器 是否阻止前端 JS 代码跨域获取资源
浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头，就可以解除浏览器端的跨域访问限制

CORS 的注意事项

CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口
CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）

Access-Control-Allow-Origin

响应头部中可以携带一个 `Access-Control-Allow-Origin` 字段

Access-Control-Allow-Origin: <origin> | *
// origin 参数的值指定了允许访问该资源的外域 `URL`

例如:
res.setHeader('Access-Control-Allow-Origin','http://itcast.cn') // * 表示允许来自任何域的请求

CORS默认支持客户端向服务器发送的请求头

Accept
Accept-Language
Content-Language
DPR
Downlink
Save-Data
Viewport-Width
Width
Content-Type （值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一）

如果客户端向服务器发送了额外的请求头信息，则需要在服务器端，通过 `Access-Control-Allow-Headers` 对额外的请求头进行声明，否则这次请求会失败！

1	res.setHeader('Access-Control-Allow-Headers','Content-Type,xxxxxx') // 多个请求头之间使用英文的逗号进行分割

Access-Control-Allow-Methods

默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求
如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Alow-Methods 来指明实际请求所允许使用的 HTTP 方法
1
2
res.setHeader('Access-Control-Alow-Methods','POST,GET,DELETE,HEAD');
res.setHeader('Access-Control-Alow-Methods','*'); // 允许所有的HTTP请求方法

CORS请求的分类

简单请求

同时满足以下两大条件的请求，就属于简单请求

请求方式：GET、POST、HEAD 三者之一
HTTP 头部信息不超过以下几种字段：
- 无自定义头部字段
- Accept
- Accept-Language
- Content-Language
- DPR
- Downlink
- Save-Data
- Viewport-Width
- Width
- Content-Type（只有三个值 application/x-www-form-urlencoded、multipart/form-data、text/plain）

预检请求

只要符合以下任何一个条件的请求，都需要进行预检请求

请求方式为 GET、POST、HEAD 之外的请求 Method 类型
请求头中包含自定义头部字段
向服务器发送了 application/json 格式的数据

在浏览器与服务器正式通信之前，浏览器会先发送 OPTION 请求进行预检，以获知服务器是否允许该实际请求，所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后，才会发送真正的请求，并且携带真实数据

简单请求和预检请求的区别

简单请求的特点：客户端与服务器之间只会发生一次请求
预检请求的特点：客户端与服务器之间会发生两次请求，OPTION 预检请求成功之后，才会发起真正的请求

jsonp

回顾`JSONP` 的概念与特点

概念：浏览器端通过 <script> 标签的 src 属性，请求服务器上的数据，同时，服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP
特点

JSONP 不属于真正的 Ajax 请求，因为它没有使用 XMLHttpRequest 这个对象
JSONP 仅支持 GET 请求，不支持 POST、PUT、DELETE 等请求

创建 `JSONP` 接口的注意事项

如果项目中已经配置了 CORS 跨域资源共享，为了防止冲突，必须在配置 CORS 中间件之前声明 JSONP 的接口否则 JSONP 接口会被处理成开启了 CORS 的接口

// 导入 express 模块
   const express = require('express')
   
   // 创建 express 的服务器实例
   const app = express()
   
   // 配置解析表单数据的中间件
   app.use(express.urlencoded({ extended: false }))
   
   // 必须在配置 cors 中间件之前，配置 JSONP 的接口
   app.get('/api/jsonp', (req, res) => {
     // 定义 JSONP 接口具体的实现过程
   })
   
   // 导入中间件
   const cors = require('cors')
   app.use(cors())
   
   // 导入路由模块
   const router = require('./020-apiRouter')
   // 把路由模块，注册到 app 上
   app.use('/api', router)
   
   // 调用 app.listen 方法，指定端口号并启动 web 服务器
   app.listen(3000, () => {
     console.log('running……')
   })

实现 `JSONP` 接口的步骤

获取客户端发送过来的回调函数的名字
得到要通过 JSONP 形式发送给客户端的数据
根据前两步得到的数据，拼接出一个函数调用的字符串

把上一步拼接得到的字符串，响应给客户端的 <script> 标签进行解析执行

// 导入 express 模块
   const express = require('express')
   
   // 创建 express 的服务器实例
   const app = express()
   
   // 配置解析表单数据的中间件
   app.use(express.urlencoded({ extended: false }))
   
   // 必须在配置 cors 中间件之前，配置 JSONP 的接口
   app.get('/api/jsonp', (req, res) => {
     // 定义 JSONP 接口具体的实现过程
     // 1. 得到函数的名称
     const funcName = req.query.callback
     // 2. 定义要发送到客户端的数据对象
     const data = { name: 'zs', age: 11 }
     // 3. 拼接处一个函数的调用
     const scriptStr = `${funcName}(${JSON.stringify(data)})`
     // 4. 把拼接的字符串，响应给客户端
     res.send(scriptStr)
   })
   
   // 导入中间件
   const cors = require('cors')
   app.use(cors())
   
   // 导入路由模块
   const router = require('./020-apiRouter')
   // 把路由模块，注册到 app 上
   app.use('/api', router)
   
   // 调用 app.listen 方法，指定端口号并启动 web 服务器
   app.listen(3000, () => {
     console.log('running……')
   })