Node.js —— Express 中间件、接口编写、接口跨域【0基础向Express模块学习】

码农世界 2024-05-23 后端 63 次浏览 0个评论

中间件的概念

什么是中间件

现实生活中的例子

Express 中间件的调用流程

编辑

Express 中间件的格式

next 函数的作用

Express 中间件的初体验

定义中间件函数

全局生效的中间件

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

中间件的作用

编辑定义多个全局中间件

局部生效的中间件

编辑定义多个局部中间件

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

中间件的分类

应用级别的中间件

路由级别的中间件

编辑错误级别的中间件

Express内置的中间件

示例

第三方的中间件

自定义中间件

需求描述与实现步骤

定义中间件

监听 req 的 data 事件

监听 req 的 end 事件

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

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

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

成品示例

使用 Express 写接口

创建基本的服务器

创建 API 路由模块编辑

编写 GET 接口

编辑

编写 POST 接口

CORS 跨域资源共享

接口的跨域问题

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

什么是 CORS

CORS 的注意事项

CORS 响应头部 - Access-Control-Allow-Origin

CORS 响应头部 - Access-Control-Allow-Headers

CORS 响应头部 - Access-Control-Allow-Methods

CORS请求的分类

简单请求

预检请求

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

回顾 JSONP 的概念与特点

创建 JSONP 接口的注意事项

实现 JSONP 接口的步骤

实现 JSONP 接口的具体代码

编辑

在网页中使用 jQuery 发起 JSONP 请求

中间件的概念

什么是中间件

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

现实生活中的例子

在处理污水的时候，一般都要经过三个处理环节，从而保证处理过后的废水，达到排放标准。

处理污水的这三个中间处理环节，就可以叫做中间件。

Express 中间件的调用流程

Express 中间件的格式

Express 的中间件，本质上就是一个 function 处理函数，Express 中间件的格式如下：

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

next 函数的作用

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

Express 中间件的初体验

定义中间件函数

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

const dihuan = function (req, res, next) {
    console.log('这是第一个中间件')
    next()
}

全局生效的中间件

客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件。

通过调用 app.use(中间件函数)，即可定义一个全局生效的中间件，示例代码如下：

const app = express()
const dihuan = function (req, res, next) {
    console.log('这是第一个中间件')
    next()
}
app.use(dihuan)

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

中间件的作用

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

const express = require('express')
const app = express()
const dihuan = function (req, res, next) {
    console.log('这是第一个中间件')
    req.time = new Date()
    console.log(req.time)
    next()
}
app.use(dihuan)
app.get('/pokemon', (req, res) => {
    res.send(`You have gotten the pokemon information (time:${req.time})`)
})
app.listen(2386, () => {
    console.log('Your server is running at 127.0.0.1:2386')
})

定义多个全局中间件

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

局部生效的中间件

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

const express = require('express')
const app = express()
const fn1 = function (req, res, next) {
    console.log('第一个局部中间件被调用')
    next()
}
const fn2 = function (req, res, next) {
    console.log('第二个局部中间件被调用')
    next()
}
app.get('/user', [fn1, fn2], (req, res) => {
    res.send({ user: '迪幻' })
})
app.post('/user', (req, res) => {
    res.send('请求成功')
})
app.listen(2386, () => {
    console.log('express server running at 127.0.0.1:2386');
})

定义多个局部中间件

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

了解中间件的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)。
```
const { error } = require('console')
const express = require('express')
const app = express()
app.get('/', function (req, res, next) {
    throw new Error('迪幻创造的错误')
    res.send('Success')
    next()
})
app.use(function (err, req, res, next) {
    console.log(err.message);
    res.send(err.message)
})
app.listen(2386, () => {
    console.log('Your server is running at 127.0.0.1:2386');
})
```
  注意：错误级别的中间件，必须注册在所有路由之后！
  
  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+ 版本中可用）
  
  示例
```
const { error } = require('console')
const express = require('express')
const app = express()
app.post('/user', function (req, res, next) {
    console.log(req.body);
    res.send('Success')
    next()
})
app.listen(2386, () => {
    console.log('Your server is running at 127.0.0.1:2386');
})
```
  此时并没有引入app.use(express.json())的中间件
  
  此时的req.body的内容为undefined
  
  但是当我们引入这个中间件时
```
const { error } = require('console')
const express = require('express')
const app = express()
app.use(express.json())
app.post('/user', function (req, res, next) {
    console.log(req.body);
    res.send('Success')
    next()
})
app.listen(2386, () => {
    console.log('Your server is running at 127.0.0.1:2386');
})
```
  就可以得到req.body这个对象了
  
  同理urlencoded也是一样的道理
  
  第三方的中间件
  
  非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。
  
  例如：在 express@4.16.0 之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。使用步骤如下：
  - 运行 npm install body-parser 安装中间件
  - 使用 require 导入中间件
  - 调用 app.use() 注册并使用中间件
    注意：Express 内置的 express.urlencoded 中间件，就是基于 body-parser 这个第三方中间件进一步封装出来的。
    
    自定义中间件
    
    需求描述与实现步骤
    
    自己手动模拟一个类似于 express.urlencoded 这样的中间件，来解析 POST 提交到服务器的表单数据。
    
    实现步骤：
    1. 定义中间件
    2. 监听 req 的 data 事件
    3. 监听 req 的 end 事件
    4. 使用 querystring 模块解析请求体数据
    5. 将解析出来的数据对象挂载为
    6. req.body 将自定义中间件封装为模块
    定义中间件
    
    使用 app.use() 来定义全局生效的中间件，代码如下：
    
    监听 req 的 data 事件
    
    在中间件中，需要监听 req 对象的 data 事件，来获取客户端发送到服务器的数据。如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以 data 事件可能会触发多次，每一次触发 data 事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。
```
let str = ''
    req.on('data', (chunk) => {
        str += chunk
    })
```
    监听 req 的 end 事件
    
    当请求体数据接收完毕之后，会自动触发 req 的 end 事件。因此，我们可以在 req 的 end 事件中，拿到并处理完整的请求体数据。示例代码如下：
```
req.on('end', () => {
        console.log(str)
        next()
    })
```
    使用 querystring 模块解析请求体数据
    
    Node.js 内置了一个 querystring 模块，专门用来处理查询字符串。通过这个模块提供的 parse() 函数，可以轻松把查询字符串，解析成对象的格式。示例代码如下：
```
const qs = require('querystring')//增加处
const bodyParser = (req, res, next) => {
    let str = ''
    req.on('data', (chunk) => {
        str += chunk
    })
    req.on('end', () => {
        const body = qs.parse(str)//增加处
        console.log(str)
        next()
    })
}
```
    将解析出来的数据对象挂载为 req.body
    
    上游的中间件和下游的中间件及路由之间，共享同一份 req 和 res。因此，我们可以将解析出来的数据，挂载为 req 的自定义属性，命名为 req.body，供下游使用。示例代码如下：
```
req.on('end', () => {
        const body = qs.parse(str)
        req.body = body
        next()
    })
```
    将自定义中间件封装为模块
    
    为了优化代码的结构，我们可以把自定义的中间件函数，封装为独立的模块，示例代码如下：
```
const express = require('express')
const app = express()
const customBodyParser = require('./custom-body-parser.js')
app.use(customBodyParser)
app.post('/user', (req, res) => {
    res.send(req.body)
})
app.listen(2386, () => {
    console.log('Your server is running at 127.0.0.1:2386');
})
```
    成品示例
    
    文件示意图：
    
    index.js文件：
```
const express = require('express')
const app = express()
const customBodyParser = require('./custom-body-parser.js')
app.use(customBodyParser)
app.post('/user', (req, res) => {
    res.send(req.body)
})
app.listen(2386, () => {
    console.log('Your server is running at 127.0.0.1:2386');
})
```
    custom-body-parser.js（自定义中间件模块）：
```
const qs = require('querystring')
const 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
```
    运行效果图：
    
    使用 Express 写接口
    
    创建基本的服务器
    
    创建 API 路由模块
    
    编写 GET 接口
    
    编写 POST 接口
    
    注意：如果要获取 URL-encoded 格式的请求体数据，必须配置中间件 app.use(express.urlencoded({ extended: false }))
    
    CORS 跨域资源共享
    
    接口的跨域问题
    
    刚才编写的 GET 和 POST接口，存在一个很严重的问题：不支持跨域请求。
    
    解决接口跨域问题的方案主要有两种：
    - CORS（主流的解决方案，推荐使用）
    - JSONP（有缺陷的解决方案：只支持 GET 请求）
      使用 cors 中间件解决跨域问题
      
      cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件，可以很方便地解决跨域问题。使用步骤分为如下 3 步：
      - 运行 npm install cors 安装中间件
      - 使用 const cors = require('cors') 导入中间件
      - 在路由之前调用 app.use(cors()) 配置中间件
        什么是 CORS
        
        CORS （Cross-Origin Resource Sharing，跨域资源共享）由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源。浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头，就可以解除浏览器端的跨域访问限制。
        
        CORS 的注意事项
        
        CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口。 CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）。
        
        CORS 响应头部 - Access-Control-Allow-Origin
        
        响应头部中可以携带一个 Access-Control-Allow-Origin 字段，其语法如下:
        
        其中，origin 参数的值指定了允许访问该资源的外域 URL。
        
        例如，下面的字段值将只允许来自 http://itcast.cn 的请求：
        
        如果指定了 Access-Control-Allow-Origin 字段的值为通配符 *，表示允许来自任何域的请求，示例代码如下：
        
        router.get('/get', (req, res) => { const query = req.query res.setHeader('Access-Control-Allow-Origin', '*') res.send({ status: 0, msg: 'Get请求成功', data: query }) })
        
        这个命令是不需要引入cors插件的可以直接使用
        
        CORS 响应头部 - Access-Control-Allow-Headers
        
        默认情况下，CORS 仅支持客户端向服务器发送如下的 9 个请求头： 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 对额外的请求头进行声明，否则这次请求会失败！
        
        CORS 响应头部 - Access-Control-Allow-Methods
        
        默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求。如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法。示例代码如下：
        
        CORS请求的分类
        
        客户端在请求 CORS 接口时，根据请求方式和请求头的不同，可以将 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 的概念与特点
        
        概念：浏览器端通过
        
        本站不以营利为目的，广告勿扰
        
        声明:本站部分内容来源于网络，如果你是该内容的作者，并且不希望本站发布你的内容，请与我们联系，我们将尽快处理！
        基于Z-BlogPHP搭建
        
        陕ICP备2021003075号-1
        
        Top