路由与接口

目录

express

简介

官方给出的概念:Express是基于Node.js 平台，快速、开放、极简的Web开发框架。
通俗的理解: Express的作用和Node.js 内置的 http模块类似，是专门用来创建Web服务器的。

基本使用

1. 安装

	在项目所处目录中运行以下命令将express安装到项目中

```js
npm i express
//推荐使用版本4.17.1
```

2. 创建基本的web服务器

   // 1. 导入express
   const express = require('express')
   // 2. 创建web服务器
   const app = express()
   
   // 3. 调用app.list(端口号,启动成功后的回调函数),启动服务器
   app.listen(80 , ()=>{
   	console.log('服务器启动成功')
   })
   

3. 监听Get请求

   通过.get()方法监听客户端Get请求.语法格式如下:

   //参数1:客户端请求的URL地址
   //参数2:请求对应的处理函数
   //	req:请求对象(包含了与请求相关的属性与方法)
   // 	res:响应对象(包含了与响应相关的属性与方法)
   app.get('请求URL',function(req,res){/*处理函数*/})
   

4. 监听post请求

   通过.post()方法监听客户端post请求.语法格式如下:

   //参数1:客户端请求的URL地址
   //参数2:请求对应的处理函数
   //	req:请求对象(包含了与请求相关的属性与方法)
   // 	res:响应对象(包含了与响应相关的属性与方法)
   app.post('请求URL',function(req,res){/*处理函数*/})
   

5. 将内容响应给客户端

   通过res.send()方法,将处理好的黑绒发送到客户端

   注意:在express中 不允许两次连续调用res.send ,会报错： 【ERR_HTTP_HEADERS_SENT】: Cannot set headers after they are sent to the client

   app.get('/user',function(req,res){
   	res.send({name:'25',age: 20 ,gender:'男'})
   })
   app.post('/user',function(req,res){
   	res.send({发送成功})
   })
   

6. 获取URl中的查询参数

   通过req.query对象,可以访问客户端通过查询字符串的形式,发送到服务器的参数

   app.get('/',function(req,res){
   //	req.query默认为一个空对象
   //	客户端使用?name=zs&age20 这种查询字符串形式发送到服务器的参数,
   //	可以通过req.query 对象访问到,例如:
   //	req.query.name req.query.name
   	console.log(req.query)
   })
   

7. 获取URL中的动态数据

   通过req.params对象,可以访问到URL中,通过:匹配动态参数

   //URL 地址中,可以通过 :参数名 的形式匹配动态参数值
   app.get('/user/:id',(req,res)=>{
   //	res.params默认是个空对象
   //	里面存放着 通过 :动态匹配的参数值
   	console.log(req.params)
   })
   

托管静态资源

1. express.static()

   express 提供了一个非常好用的函数，叫做express.static)，通过它，我们可以非常方便地创建一个静态资源服务器，例如，通过如下代码就可以将public目录下的图片、CSS文件、JavaScript文件对外开放访问了:

   app.use(express.static('public'))
   

   注意:Express在指定的静态目录中查找文件，并对外提供资源的访问路径。因此，存放静态文件的目录名不会出现在URL中。

   若果有多个静态资源目录需要托管,就多次调用express.static()函数,访问静态资源文件时，express.static()函数会根据目录的添加顺序查找所需的文件。

2. 挂载路径前缀

   如果希望挂载路径前缀,可以使用以下格式:

   app.use( '/public', express.static( 'public'))
   

   如此就可以使用,带有/public前缀地址来访问public中的文件

nodemon

作用:在改动服务器代码后自动重启服务器,方便开发

安装:

npm i -g nodemon

Express中的路由

在Express中，路由指的是客户端的请求与服务器处理函数之间的映射关系。
Express 中的路由分3部分组成，分别是请求的类型、请求的URL地址、处理函数，格式如下:

app.METHOD(PATH,HANDLER)
//参数一 PATH:请求的url地址
//参数二 HANDLER:处理函数
//参数三 METHOD:请求方式,get与post

实例:

路由的匹配

每当一个请求到达服务器之后，==需要先经过路由的匹配==，只有匹配成功之后，才会调用对应的处理函数。
在匹配时，会按照路由的顺序进行匹配，如果==请求类型==和==请求的URL==同时匹配成功，则Express 会将这次请求，转交给对应的function 函数进行处理。

路由匹配的注意点:

1. 按照定义的先后顺序进行匹配
2. 请求类型和请求的URL同时匹配成功，才会调用对应的处理函数

路由的使用

但是这样基础的使用在实际应用中很少,因为无限制的挂载会使该文件的体积过大,不方便管理,所以要将路由模块化

模块化路由

将路由抽离为单独模块的步骤如下:

1. 创建路由模块对应的.js 文件
2. 调用express.Router()函数创建路由对象
3. 向路由对象上挂载具体的路由
4. 使用module.exports向外共享路由对象,以上四步是在模块中完成的
5. 使用app.use()函数注册路由模块,这一步是在路由总管中完成的

实例:

1.创建路由模块

//1. 导入express
var express =require('express') 
//2. 创建路由对象
var router = express.Riouter()
//3. 挂载路由
router.get('/user/list',function(req,res){
	res.send('Get user list.')
})
// 4．向外导出路由对象
module.exports = router

2.注册路由模块

//1. 导入路由模块
const userRouter = require('./router/user.js')
//2. 使用app.use() 注册路由模块
app.use(userRouter)

3.为路由模块添加前缀

//在注册路由模块的时候,在其前为其添加前缀
app.use('/api',router)

Express中间件

Express的中间件，本质上就是一个function处理函数,目的是对这次请求进行预处理
当一个请求到达Express的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理。

流程图:

中间件的格式

opp.get('/',function(req,res,next){
	next();
})
//  req:请求对象(包含了与请求相关的属性与方法)
// 	res:响应对象(包含了与响应相关的属性与方法)
//	next:本质是一个函数,在中间件的形参列表中,必须包含nesxt参数
//  next函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由。

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

全局生效的中间件

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

局部生效的中间件

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

可以明显看到.在app.get(‘/’,mw1,function(req,res){…})中调用了mw1

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

express中间件的注意事项

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

中间件的分类

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

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

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

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

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

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

自定义一个中间件

模拟一个类似于express.urlencoded这样的中间件，来解析POST提交到服务器的表单数据。
实现步骤:

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

监听req的data事件;

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

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

4.监听req的end事件
当请求体数据接收完毕之后，会自动触发req的end事件。
因此，我们可以在req的end事件中，拿到并处理完整的请求体数据。示例代码如下:

5.使用querystring模块解析请求体数据
Node,js内置了一个querystring模块，专门用来处理查询字符串。通过这个模块提供的parse()函数，可以轻松把查询字符串，解析成对象的格式。示例代码如下:

6.将解析出来的数据对象挂载为req.body
上游的中间件和下游的中间件及路由之间，共享同一份req和res。因此，我们可以将解析出来的数据，挂载为req的自定义属性，命名为req.body，供下游使用。示例代码如下:

7.将自定义中间件封装为模块
为了优化代码的结构，我们可以把自定义的中间件函数，封装为独立的模块，示例代码如下:

使用Express创建接口

1. 创建基础的服务器，实例:

   

2. 创建API路由模块,实例:

3. 编写GET接口,实例:

4. 编写POST接口,实例:

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

解决接口的跨域问题

解决接口跨域问题的方案主要有两种:

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

cors解决跨域问题

cors 是Express的一个第三方中间件。通过安装和配置cors 中间件，可以很方便地解决跨域问题。使用步骤分为如下3步:

1. 运行npm install cors安装中间件
2. 使用const cors = require(‘cors”)导入中间件
3. 在路由之前调用app.use(cors())配置中间件

使用CORS的注意事项:

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

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

CORS响应头部

Access-Control-Allow-Origin

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

Access-Control-Allow-Origin: <origin> | *
// *代表通配符,即允许来自任何域的请求

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

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 对额外的请求头进行声明，否则这次请求会失败!
实例:

Access-Control-Allow-Methods

默认情况下，CORS仅支持客户端发起GET、POST、HEAD请求。
如果客户端希望通过 PUT、DELETE等方式请求服务器的资源，则需要在服务器端，通过Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP方法。实例:

CORS请求的分类

客户端在请求CORS接口时，根据请求方式和请求头的不同，可以将CORS的请求分为两大类，分别是:

• 简单请求
• 预检请求

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

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)

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

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

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

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

JSONP解决跨域问题

JSONP的概念与特点

概念:

​ 浏览器端通过