day4-node.js
1-Express 中的路由
1-1路由的基本概念与组成
-
概念:路由指的是客户端的请求与服务器处理函数之间的映射关系。
-
组成:路由分3部分组成,分别是请求的类型、请求的URL地址、处理函数,格式如下:
//路由示例: app.get('/user',(req,res)=>{ //调用expres 提供的 res.send() 方法,向客户端响应一个 JSON 对象 res.send({name:'zs',age:20,gender:'男'}) }) app.post('/user',(req,res)=>{ //调用express 提供的 res.send() 方法,向客户端响应一个文字字符串 res.send('请求成功') })
1-2路由匹配过程
-
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数。
-
在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的URL同时匹配成功,则Express 会将这次请求,转交给对应的function函数进行处理。
1-3模块化路由
为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到app上,而是推荐将路由抽离为单独的模块。将路由抽离为单独模块的步骤如下:
-
创建路由模块对应的.js 文件
-
调用express.Router(函数创建路由对象)
-
向路由对象上挂载具体的路由
-
使用module.exports 向外共享路由对象
-
使用app.use(函数注册路由模块)
// 这是路由模块 //1.导入express const express = require('express') //2.创建路由对象 const router = express.Router() //3.挂载具体的路由 router.get('/user/list',(req,res) => { res.send('Get user list.') }) router.post('/user/add',(req,res) => { res.send('Add new user.') }) //4.向外导出路由对象 module.exports = router
const express = require('express') const app = express() //1.导入路由模块 const router = require('./03-router') //2.注册路由模块 //2.1 使用 app.use()注册路由模块,并添加统一访问前缀 /api app.use('/api',router) // 注意 : app.use() 函数的作用,就是来注册全局中间件 app.listen(80,() => { console.log('http://127.0.0.1') })
2-中间件
2-1中间件的概念
- 中间件(Middleware ) ,特指业务流程的中间处理环节。
2-2Express中间件的调用流程
-
当一个请求到达Express的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。
2-3Express中间件的格式
Express 的中间件,本质上就是一个function处理函数,Express中间件的格式如下:
-
注意:中间件函数的形参列表中,必须包含next 参数。而路由处理函数中只包含req和res。
//定义一个最简单的中间件函数 const mw = function (req,res,next) { console.log('这是最简单的中间件函数') //把流转关系,转交给下一个中间件或路由 next() } // 将 mw 注册为全局生效的中间件 app.use(mw) //这是定义全局中间件的简化形式 app.use((req,res,next)=>{ console.log('这是最简单的中间件函数') next() })
2-4next 函数的作用
- next函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
2-5全局生效的中间件
- 客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件。
2-6中间件的作用
-
多个中间件之间,共享同一份req和res
-
基于这样的特性,我们可以在上游的中间件中,统一为req或res对象添加自定义的属性或方法,供下游的中间件或路由进行使用。
2-7定义多个全局中间件
可以使用app.use()连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用,示例代码如下:
const express = require('express')
const app = express()
// 定义第一个全局中间件
app.use((req,res,next) => {
console.log('调用了第一个全局中间件')
next()
})
// 定义第二个全局中间件
app.use((req,res,next) => {
console.log('调用了第二个全局中间件')
next()
})
// 定义一个路由
app.get('/user',(req,res) => {
res.send('User page.')
})
app.listen(8080,() => {
console.log('http://127.0.0.1')
})
局部中间件
const express = require('express')
const app = express()
//1.定义中间件函数
const mv1 = (req,res,next)=>{
console.log('调用了第一个局部生效的中间件');
next()
}
const mv2 = (req,res,next)=>{
console.log('调用了第二个局部生效的中间件');
next()
}
// 挂载路由
app.get('/',mv1,mv2,(req,res) => {
res.send('hello world.')
})
app.get('/1',[mv1,mv2],(req,res) => {
res.send('hello world.')
})
app.get('/user',(req,res) => {
res.send('get Request.')
})
app.listen(8080,()=>{
console.log('http://127.0.0.1:8080')
})
中间件的注意事项:
-
一定要在路由之前注册中间件
-
客户端发送过来的请求,可以连续调用多个中间件进行处理
-
执行完中间件的业务代码之后,不要忘记调用next()函数
-
为了防止代码逻辑混乱,调用next()函数后不要再写额外的代码
-
连续调用多个中间件时,多个中间件之间,共享req和res 对象
2-8中间件的分类
应用级别的中间件(全局中间件)
- 通过app.use()或 app.get()或app.post(),绑定到 app实例上的中间件,叫做应用级别的中间件
路由级别的中间件
- 绑定到express.Router()实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app实例上,路由级别中间件绑定到router实例上
错误级别的中间件
-
错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。
-
格式∶错误级别中间件的 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) next() })
Express内置的中间件
-
express.static快速托管静态资源的内置中间件,例如:HTML文件、图片、CSS样式等(无兼容性)
-
express.json解析JSON格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
-
express.urlencoded解析URL-encoded格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
const express = require('express') const app = express() // 注意 :除了错误级别的中间件 其他的中间件,必须在路由之前进行配置 // 通过 express.json() 这个中间件,解析表单中的json格式数据 app.use(express.json()) // 通过 express.urlencoded() 这个中间件,来解析 表单中的url-encoded格式的数据 app.use(express.urlencoded({extended:false})) app.post('/user',(req,res) => { // 在服务器,可以使用 req.body 这个属性 ,来接收客户端发送的请求体数据 // 默认情况下,如果不配置解析表单数据的中间件,则 req.body 默认等于 undefined console.log(req.body) res.send('ok') }) app.post('/book',(req,res) => { //在服务器端,可以通过 req.body 来获取 json 格式表单数据和 url-encoded 格式的数据 console.log(req.body) res.send('ok') }) app.listen(8080,() => { console.log('http://127.0.0.1:8080') })
第三方的中间件
-
非Express官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。
-
注意:Express内置的 express.urlencoded 中间件,就是基于body-parser这个第三方中间件进一步封装出来的。
const express = require('express') const app = express() // 导入解析表单数据的中间件 body-parser const parser = require('body-parser') // 使用app.use() 注册中间件 app.use(parser.urlencoded({extended:false})) //app.use(express.urlencoded({extended:false})) app.post('/user',(req,res) => { // 如果没有配置任何解析表单数据的中间件,则 req.body 默认等于 undefined console.log(req.body) res.send('ok ') }) app.listen(8080,() => { console.log('http://127.0.0.1:8080') })
2-9自定义中间件
-
定义中间件
-
监听req的data事件
-
监听req的end事件
-
使用querystring模块解析请求体数据
-
将解析出来的数据对象挂载为req.body
const express = require('express') const app = express() // 导入 Node.js 内置的 querystring 模块 const qs = require('node:querystring') // 这是解析表单数据的中间件 app.use((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() }) }) app.post('/user',(req,res) => { res.send(req.body) }) app.listen(8080,(req,res) => { console.log('http://127.0.0.1:8080') })
-
将自定义中间件封装为模块
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(8080,(req,res) => { console.log('http://127.0.0.1:8080') }) -------------分割线------------------- // 导入 Node.js 内置的 querystring 模块 const qs = require('node: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
3-解决跨域问题
3-1cors 中间件
cors 是 Express的一个第三方中间件。通过安装和配置cors 中间件,可以很方便地解决跨域问题。使用步骤分为如下3步:
-
运行npm install cors安装中间件
-
使用const cors = require(‘cors’)导入中间件
-
在路由之前调用app.use(cors())配置中间件
3-2什么是CORS
-
CORS (Cross-Origin Resource Sharing,跨域资源共享)由一系列HTTP响应头组成,这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源。
-
浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了CORS相关的HTTP响应头,就可以解除浏览器端的跨域访问限制。
3-3CORS的注意事项
-
CORS主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了CORS的接口。
-
CORS在浏览器中有兼容性。只有支持XMLHttpRequest Level2的浏览器,才能正常访问开启了CORS的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)
3-4CORS 跨域资源共享
CORS响应头部– Access-Control-Allow-Origin
-
响应头部中可以携带一个Access-Control-Allow-Origin字段,其语法如下:
-
Access-Control-Allow-origin: |*
-
其中,origin 参数的值指定了允许访问该资源的外域URL。例如,下面的字段值将只允许来自http://itcast.cn的请求:
-
res.setHeader ( ’ Access-Control-Allow-Origin’, 'http:llitcast.cn ’ )
-
如果指定了Access-Control-Allow-Origin字段的值为通配符*,表示允许来自任何域的请求,示例代码如下:
-
res.setHeader( " Access-Control-Allow-Origin’, ‘*’)
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 ’ )
CORS响应头部– Access-Control-Allow-Methods
-
默认情况下,CORS仅支持客户端发起GET、POST、HEAD请求。
-
如果客户端希望通过PUT、DELETE等方式请求服务器的资源,则需要在服务器端,通过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 ', ‘*’)
3-5CORS请求的分类
客户端在请求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预检请求成功之后,才会发起真正的请求。
3-6 JSONP接口
回顾JSONP的概念与特点
-
概念:浏览器端通过
创建JSONP 接口的注意事项
- 如果项目中已经配置了CORS 跨域资源共享,为了防止冲突,必须在配置CORS中间件之前声明JSONP的接口。否则JSONP接口会被处理成开启了CORS的接口
实现JSONP接口的步骤
-
获取客户端发送过来的回调函数的名字
-
得到要通过JSONP形式发送给客户端的数据
-
把上一步拼接得到的字符串,响应给客户端的
3-7跨域测试代码
html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<script src="https://cdn.staticfile.org/jquery/3.6.1/jquery.js"></script>
</head>
<body>
<button id="btnGET">GET</button>
<button id="btnPOST">POST</button>
<button id="btnDelete">DELETE</button>
<button id="btnJSONP">JSONP</button>
</body>
<script>
$(function () {
//1.测试GET接口
$('#btnGET').click(function () {
$.ajax({
type:'GET',
url:'http://127.0.0.1:8080/api/get',
data:{name:'zs',age:20},
success:function(res){
console.log(res)
}
})
})
//2.测试POST接口
$('#btnPOST').click(function () {
$.ajax({
type:'POST',
url:'http://127.0.0.1:8080/api/POST',
data:{bookname:'水浒传',author:'施耐庵'},
success:function(res){
console.log(res)
}
})
})
//3.为删除按钮绑定点击事件处理函数
$('#btnDelete').click(function () {
$.ajax({
type:'DELETE',
url:'http://127.0.0.1:8080/api/delete',
success:function(res){
console.log(res)
}
})
})
//4.为 JSONP 按钮绑定点击事件处理函数
$('#btnJSONP').click(function () {
$.ajax({
method:'GET',
url:'http://127.0.0.1:8080/api/jsonp',
dataType:'jsonp',
success:function(res){
console.log(res)
}
})
})
})
</script>
</html>
express接口
// 导入 express
const express = require('express')
// 创建服务器实例
const app = express()
// 配置解析表单数据的中间件
app.use(express.urlencoded({extended:false}))
// 必须在配置 cors 中间件之前 ,配置 jsonp 接口
app.get('/api/jsonp',(req,res) => {
//TODO: 定义 jsonp 接口具体的实现过程
// 1.得到函数的名称
const funcName = req.query.callback
// 2.定义要发送到客户端的数据对象
const data = {name:'zs',age:22}
// 3.拼接出一个函数的调用
const scriptStr = `${funcName}(${JSON.stringify(data)})`
// 4.把拼接的字符串,响应给客户端
res.send(scriptStr)
})
// 一定要在路由之前,配置 cors 这个中间件,从而解决接口跨域问题
const cors = require('cors')
app.use(cors())
// 导入路由模块
const router = require('./16-apiRouter')
const { json } = require('body-parser')
// 把路由模块,注册到app上
app.use('/api',router)
// 启动服务器
app.listen(8080,() => {
console.log('http://127.0.0.1:8080')
})
路由模块
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 表示处理失败
msg:'GET 请求成功', // 状态的描述
data:query // 需要响应给客户端的数据
})
})
// 定义 post 接口
router.post('/post',(req,res) => {
// 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
const body = req.body
// 调用 res.send() 方法,向客户端响应结果
res.send({
status:0,
msg:'POST 请求成功',
data:body
})
})
// 定义 DELETE 接口
router.delete('/delete',(req,res) => {
res.send({
status:0,
msg:'DELETE 请求成功'
})
})
module.exports = router