Express中间件、使用Express写接口【Node.js】

1. Express 中间件

1.1 中间件的概念

  1. 什么是中间件
    中间件(Middleware ),特指业务流程的中间处理环节。

  2. 现实生活中的例子
    在处理污水的时候,一般都要经过三个处理环节,从而保证处理过后的废水,达到排放标准。
    在这里插入图片描述
    处理污水的这三个中间处理环节,就可以叫做中间件。

  3. Express 中间件的调用流程
    当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。
    在这里插入图片描述

  4. Express 中间件的格式
    Express 的中间件,本质上就是一个 function 处理函数,Express 中间件的格式如下:
    在这里插入图片描述
    注意:中间件函数的形参列表中,必须包含 next 参数。而路由处理函数中只包含 req 和 res。

  5. next 函数的作用
    next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
    在这里插入图片描述

1.2 Express 中间件的初体验

  1. 定义中间件函数
    可以通过如下的方式,定义一个最简单的中间件函数:
//定义一个最简单的中间函数
const mw = function(req, res, next){
    console.log('这是最简单的中间件函数');
    //把流转关系,转交给下一个中间件或路由
    next()
}
  1. 全局生效的中间件
    客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件。
    通过调用 app.use(中间件函数),即可定义一个全局生效的中间件,示例代码如下:
//定义一个最简单的中间函数
const mw = function(req, res, next){
    console.log('这是最简单的中间件函数');
    //把流转关系,转交给下一个中间件或路由
    next()
}

//将 mw 注册为全局生效的中间件
app.use(mw)
  1. 定义全局中间件的简化形式
//这是定义全局中间件的简化形式
app.use(function(req, res, next) {
    console.log('这是最简单的中间件函数');
    next()
})
  1. 中间件的作用

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

在这里插入图片描述

const express = require('express')
const app = express()

//这是定义全局中间件的简化形式
app.use(function(req, res, next) {
    //获取到请求到达服务器的时间
    const time = Date.now()
    //为 req 对象挂载自定义属性,从而把时间共享给后面的所有路由
    req.startTime = time
    next()
})

app.get('/', (req, res) => {
    res.send('Home page' + req.startTime)
})

app.get('/user', (req, res) => {
    res.send('User page' + req.startTime)
})
app.listen(80, () => {
    console.log('http://127.0.0.1');
})
  1. 定义多个全局中间件
    可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用,示例代码如下:
const express = require('express')
const app = express()

//定义第一个全局中间件
app.use((req, res, next) => {
    console.log('调用了第1个全局中间件');
    next()
})

//定义第二个全局中间件
app.use((req, res, next) => {
    console.log('调用了第2个全局中间件');
    next()
})

//定义一个路由
app.get('/user', (req, res) => {
    res.send('User page')
})


app.listen(80, () => {
    console.log('http://127.0.0.1');
})

在这里插入图片描述
在这里插入图片描述

  1. 局部生效的中间件

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

//1.定义中间件函数
const mw1 = (req, res, next) => {
    console.log('调用了局部生效的中间件');
    next()
}

//2. 创建路由  mw1 这个中间件只在”当前路由中生效“,这种用法属于”局部生效的中间件“
app.get('/', mw1, (req, res) => {
    res.send('Home page')
    
})
//mw1 这个中间件不会影响下面这个路由
app.get('/user', (req, res) => {
    res.send('User page')
    
})
  1. 定义多个局部中间件
    可以在路由中,通过如下两种等价的方式,使用多个局部中间件:
const mw1 = (req, res, next) => {
    console.log('调用了第一个局部生效的中间件');
    next()
}

const mw2 = (req, res, next) => {
    console.log('调用了第二个局部生效的中间件');
    next()
}

//2. 创建路由
app.get('/', mw1, mw2, (req, res) => {
    res.send('Home page')
    
})
//或者
app.get('/', [mw1, mw2], (req, res) => {
	res.send('Home page')
})

app.get('/user', (req, res) => {
    res.send('User page')
    
})

在这里插入图片描述
8. 了解中间件的5 个使用注意事项

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

1.3 中间件的分类

为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是:

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

  1. 应用级别的中间件
    通过 app.use() app.get()app.post()绑定到 app 实例上的中间件,叫做应用级别的中间件,代码示例如下:
    在这里插入图片描述

  2. 路由级别的中间件
    绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 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) => {//错误级别的中间件
    console.log('发生了错误!' + err.message);//在服务器打印错误消息
    res.send('Error: ' + err.message)//向客户端响应错误相关的内容
})

在这里插入图片描述

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

  1. 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+ 版本中可用)

例: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(80, () => {
    console.log('http://127.0.0.1');
})

在这里插入图片描述
在这里插入图片描述

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

//通过 exoress.urlencoded() 这个中间件,来解析 表单中的 url-encoded 格式的数据
app.use(express.urlencoded({extended: false}))
app.post('/book', (req, res) => {
    //在服务器端,可以通过 req.body 来获取 JSON 格式的表单数据和 url-encoded 格式的数据
    console.log(req.body);
    res.send('ok')
})

在这里插入图片描述
在这里插入图片描述

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

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

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

const express = require('express')
const app = express()

//1. 导入解析表单数据的中间件 body-parser 
const parser = require('body-parser')
//使用 app.use() 注册中间件
app.use(parser.urlencoded({extended: false}))

app.post('/user', (req, res) => {
    //如果没有配置任何解析表单数据的中间件,则 req.body 默认等于 undefined
    console.log(req.body);
    res.send('ok')
})

app.listen(80, () => {
    console.log('http://127.0.0.1');
})

在这里插入图片描述
在这里插入图片描述

1.4 自定义中间件

  1. 需求描述与实现步骤
    自己手动模拟一个类似于 express.urlencoded 这样的中间件,来解析 POST 提交到服务器的表单数据。
    实现步骤:
    (1)定义中间件
    (2)监听 req 的 data 事件
    (3)监听 req 的 end 事件
    (4)使用 querystring 模块解析请求体数据
    (5)将解析出来的数据对象挂载为 req.body
    (6)将自定义中间件封装为模块

  2. 定义中间件
    使用 app.use() 来定义全局生效的中间件,代码示例如下:

//这是解析表单数据的中间件
app.use((req, res, next) => {
    //定义中间件具体的业务逻辑

    
})
  1. 监听 req 的 data 事件
    在中间件中,需要监听 req 对象的 data 事件,来获取客户端发送到服务器的数据。
    如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 data 事件可能会触发多次,每一次触发 data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。
//1.定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
    let str = ''
    //2. 监听 req 的 data 事件
    req.on('data', (chunk) => {
        str += chunk
    })

  1. 监听 req 的 end 事件
    当请求体数据接收完毕之后,会自动触发 req 的 end 事件
    因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。示例代码如下:
    //3. 监听 req 的 end 事件
    req.on('end', () => {
        //在 str 中存放的是完整的请求体数据
        console.log(str);
        //TODO:把字符串格式的请求体数据,解析成对象格式
    })
  1. 使用 querystring 模块解析请求体数据
    Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse() 函数,可以轻松把查询字符串,解析成对象的格式。示例代码如下:
    在这里插入图片描述
  2. 将解析出来的数据对象挂载为 req.body
    上游的中间件和下游的中间件及路由之间,共享同一份 req 和 res。因此,我们可以将解析出来的数据,挂载为 req 的自定义属性,命名为 req.body,供下游使用。示例代码如下:
req.on('end', () => {
        //在 str 中存放的是完整的请求体数据
        console.log(str);
        //TODO:把字符串格式的请求体数据,解析成对象格式
        const body = qs.parse(str)
        //将解析出来的请求体对象,挂载为 req.body 属性
        req.body = body
        //最后,一定要第调用 next() 函数,执行后续的业务逻辑
        next()
    })
  1. 将自定义中间件封装为模块
    为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块,示例代码如下:
const { log } = require('console')
const express = require('express')
const app = express()


//1. 导入自己封装的中间件模块
const customBodyParser = require('./14.custom-body-parser')
//2. 将自定义的中间件函数 注册为全局可用的中间件 就可以对表单数据进行解析
app.use(customBodyParser)
app.post('/user', (req, res) => {
    res.send(req.body)
})


app.listen(80, () => {
    console.log('http://127.0.0.1');
})

创建一个自定义模块:

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


const bodyParser = (req, res, next) => {
    //定义中间件具体的业务逻辑
    //1.定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
    let str = ''
    //2. 监听 req 的 data 事件
    req.on('data', (chunk) => {
        str += chunk
    })
    //3. 监听 req 的 end 事件
    req.on('end', () => {
        //在 str 中存放的是完整的请求体数据
        console.log(str);
        //TODO:把字符串格式的请求体数据,解析成对象格式
        const body = qs.parse(str)
        req.body = body
        next()
    })
    
}

module.exports = bodyParser

2. 使用 Express 写接口

2.1 创建基本的服务器

//导入 express
const express = require('express')
//创建服务器实例
const app = express()


//启动服务器
app.listen(80, () => {
    console.log('express server running at http://127.0.0.1');
})

2.2 创建 API 路由模块

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

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

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


//启动服务器
app.listen(80, () => {
    console.log('express server running at http://127.0.0.1');
})
const express = require('express')
const router = express.Router()

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

module.exports = router

2.3 编写 GET 接口

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

//在这里挂载对应的路由
router.get('/get', (req, res) => {
    //通过 req.query 获取客户端通过查询字符串,发送到服务器的数据
    const query = req.query
    //调用 res.send() 方法,向客户端响应处理的结果
    res.send({
        status: 0, //0 表示处理成功 1  表示处理失败
        message: 'GET请求成功', //状态的描述
        data: query//需要响应给客户端的数据
    })
})

module.exports = router

2.4 编写 POST 接口

//定义 post 接口
router.post('/post', (req, res) => {
    //通过 req.body 获取请求体中包含的 url-encoded 格式的数据
    const body = req.body
    //调用 res.send() 方法,向客户端响应结果
    res.send({
        status: 0,
        message: 'POST请求成功',
        data: body
    })
})
//配置解析表单数据的中间件
app.use(express.urlencoded({extended: false}))

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

2.5 CORS 跨域资源共享

  1. 接口的跨域问题
    刚才编写的 GETPOST接口,存在一个很严重的问题:不支持跨域请求
    解决接口跨域问题的方案主要有两种:
    (1)CORS(主流的解决方案,推荐使用)
    (2) JSONP(有缺陷的解决方案:只支持 GET 请求)

  2. 使用 cors 中间件解决跨域问题
    cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。
    使用步骤分为如下 3 步:
    (1)运行 npm install cors 安装中间件
    (2)使用 const cors = require('cors') 导入中间件
    (3)在路由之前调用 app.use(cors()) 配置中间件
    注意: 一定要在路由之前配置 cors 中间件

  3. 什么是 CORS
    CORS (Cross-Origin Resource Sharing,跨域资源共享)由一系列 HTTP 响应头组成,这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源
    浏览器的 同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头,就可以解除浏览器端的跨域访问限制
    在这里插入图片描述
    在这里插入图片描述

  4. CORS 的注意事项
    (1)CORS主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了CORS的接口
    (2)CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。

  5. CORS 响应头部 - Access-Control-Allow-Origin
    响应头部中可以携带一个 Access-Control-Allow-Origin 字段,其语法如下:

Access-Control-Allow-Origin: <origin> | *

其中,origin 参数的值指定了允许访问该资源的外域 URL
例如:下面的字段值将只允许来自 http://itcast.cn 的请求:

res.setHeader('Access-Control-Allow-Origin', 'http://itcast.cn')

如果指定了 Access-Control-Allow-Origin 字段的值为通配符 *,表示允许来自任何域的请求,示例代码如下:

res.setHeader('Access-Control-Allow-Origin', '*')
  1. 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 对额外的请求头进行声明,否则这次请求会失败!

//允许客户端额外向服务器发送 Content-Type 请求头和 X-Custom-Header 请求头
//注意:多个请求头之间使用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')
  1. CORS 响应头部 - Access-Control-Allow-Methods

默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求。

如果客户端希望通过 PUTDELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法
示例代码如下:

//只允许 POST、GET、DELETE、HEAD 请求方法
res.setHeader('Access-Control-Allow-Methods', 'POST,GET,DELETE,HEAD')
//允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Allow-Methods', '*'
  1. CORS请求的分类
    客户端在请求 CORS 接口时,根据请求方式和请求头的不同,可以将 CORS 的请求分为两大类,分别是:
    (1)简单请求
    (2)预检请求

  2. 简单请求
    同时满足以下两大条件的请求,就属于简单请求:
    (1)请求方式:GET、POST、HEAD 三者之一
    (2)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)

  3. 预检请求
    只要符合以下任何一个条件的请求,都需要进行预检请求:
    (1) 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
    (2)请求头中包含自定义头部字段
    (3)向服务器发送了 application/json 格式的数据

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

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

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

2.6 JSONP 接口

  1. 回顾 JSONP 的概念与特点
    概念:浏览器端通过 < script > 标签的 src 属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP。
    特点
    (1)JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。
    (2)JSONP 支持 GET 请求,不支持 POST、PUT、DELETE 等请求。

  2. 创建 JSONP 接口的注意事项
    如果项目中已经配置了 CORS 跨域资源共享,为了防止冲突必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下:

在这里插入图片描述

  1. 实现 JSONP 接口的步骤
    (1)获取客户端发送过来的回调函数的名字
    (2)得到要通过 JSONP 形式发送给客户端的数据
    (3)根据前两部得到的数据,拼接出一个函数调用的字符串
    (4)把上一步拼接得到的字符串,响应给客户端的 < script > 标签进行解析执行

  2. 实现 JSONP 接口的具体代码

//必须在配置 cors 中间件之前,配置 JSONP 的接口
app.get('/api/jsonp', (req, res) => {
    //TODO: 定义 JSONP 接口具体实现过程
    //1. 获取客户端发送过来的回调函数的名字
    const funcName = req.query.callback
    //2. 定义要发送到客户端的数据对象
    const data = {name: 'zs', age: 20}
    //3. 拼接出一个函数的调用
    const scriptStr = `${funcName}(${JSON.stringify(data)})`
    //4. 把拼接的字符串,响应给客户端
    res.send(scriptStr)
})

  1. 在网页中使用 jQuery 发起 JSONP 请求
    调用 $.ajax() 函数,提供 JSONP 的配置选项,从而发起 JSONP 请求,示例代码如下:
//3.为 JSONP 按钮绑定点击事件处理函数
            $('#btnJSONP').on('click', function(){
                $.ajax({
                    type: 'GET',
                    url: 'http://127.0.0.1/api/jsonp',
                    dataType: 'jsonp',
                    success: function(res) {
                        console.log(res);
                    }

                })
            })
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值