Express的路由、中间件、接口、CORS跨域解决

文章目录

        • 第一章:初识 Express
          • 1.1、什么是Express
          • 1.2、基本使用
          • 1.3、托管静态资源
          • 1.4、nodemon
          • 1.5、body-parser
          • 1.6、加密包 bcryptjs
          • 1.7、表单验证的包
        • 第二章:Express路由
          • 1.1、Express的路由
          • 1.2、express路由的模块化
        • 第三章:Express中间件
          • 3.1、中间件概念
          • 3.2、中间件初体验
          • 3.3、中间件的分类
          • 3.4、自定义中间件
        • 第四章:使用Express写接口
          • 4.1、编写get接口、post接口
          • 4.2、跨域-CORS方法(主流的解决方案,推荐使用)
          • 4.3、跨域-JSONP(有缺陷的解决方案:只支持GET请求)

能够使用express.static()快速托管静态资源
能够使用express路由精简项目结构
能够使用常见的 express中间件
能够使用express创建API接口
能够在express 中启用cors 跨域资源共享

第一章:初识 Express
1.1、什么是Express

1)概念

官方给出的概念:Express是基于Nodejs平台,快速、开放、极简的Web开发框架。

通俗的理解:Express的作用和Nodejs内置的http模块类似,是专门用来创建Web服务器的。

Express的本质:就是一个npm上的第三方包,提供了快速创建Web服务器的便捷方法。

4.17.1版本

官网地址:http://www.expressjs.com.cn/

优点:

http 内置模块用起来很复杂,开发效率低;Express是基于内置的http模块进一步封装出来的,能够极大的提高开发效率。

2)能完成的内容

Web 网站服务器:专门对外提供Web网页资源的服务器。

API 接口服务器:专门对外提供API接口的服务器。

使用Express,我们可以方便、快速的创建Web网站的服务器或API接口的服务器。

1.2、基本使用

1)创建服务器

npm install express@4.17.1
//创建基本服务器
const express = require('express')
const app = express()
app.listen(80,()=>{
    conole.log('服务启动127.0.0.1')
})

2)监听get请求、post请求

app.get()方法,可以监听客户端的GET请求,

app.post()方法,可以监听客户端的POST请求,

app.get('url',function(req,res)=>{})  //参数1:url地址;参数2:请求处理函数
app.post('url',function(req,res)=>{})//参数1:url地址;参数2:请求处理函数

3)响应客户端及传送参数

res.send方法,把处理好的内容,发送给客户端

req.query():查询字符串的形式,发送给服务器参数

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

app.get('/url/:id/:name',function(req,res)=>{
    res.send('')
    req.query()
    req.params()
})
1.3、托管静态资源

1)、express.static()

能非常方便的创建一个静态资源服务器

app.use(express.static('public')) //可以访问public下的所有文件
http://127.0.0.1/2.txt   //在public路径下输入具体的文件名可访问

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

2)、托管多个静态资源目录

多次调用express.static()

express.static()函数会根据目录的添加顺序查找所需的文件,按先后顺序

3)挂载路径前缀

app.use('qianzhui',express.static('public'))  //挂载前缀字符串qianzhui,访问时需要加上qianzhui 
1.4、nodemon

调试Nodejs项目时,修改代码,要手动close掉,再重新启动,非常繁琐。

可使用 nodemon(https/www.npmis.com/package/nodemon)这个工具,它能够监听项目文件的变动,当代码被修改后,nodemon会自动帮我们重启项目,极大方便了开发和调试。

npm install -g nodemon
node main.js
nodemon main.js  //替换上面的命令

完整的示例

const express = require('express')
const app  = express()
app.use('public',express.static('../public'))
app.get('/user',(req,res)=>{
  res.send({name:'ww',age:33})
})
app.post('/user',(req,res)=>{
  res.send('请求成功')
})
app.get('/user/:qq/:name',(req,res)=>{
  console.log(req.query)
  // console.log(req.params)
  res.send(req.params)
})
app.listen(80,()=>{
  console.log('express server start at http://127.0.0.1')
})
1.5、body-parser

express中没有内置的获取post请求体的api,需要第三方包 body-parser,body-parser是解析req.body,不然body不会被解析

cnpm i body-parser -save
//app.js配置
var jsonParser = bodyParser.json();
var urlencodedParser = bodyParser.urlencoded({extended: false});
1.6、加密包 bcryptjs

使用bcryptjs,加密后,无法逆向解密,同一明文,多次加密,得到的加密结果不相同,保证安全性

npm i [email protected]
1.7、表单验证的包
npm install @escook/express-joi
npm install @hapi/joi@17.1.0   
npm i joi    //Cannot mix different versions of joi schemas
const joi = require('joi')  //用joi代替@hapi/[email protected]
第二章:Express路由
1.1、Express的路由

在Express中,路由指的是客户端的请求与服务器处理函数之间的映射关系。

Express中的路由分3部分组成,分别是请求的类型、请求的URL地址、处理函数,

app.method(path,handler)
app.get('url',function(){})   //把路由挂载到app实例上
app.post('url',function(){})

路由匹配规则:

①按照定义的先后顺序进行匹配

②请求类型和请求的URL同时匹配成功,才会调用对应的处理函数

1.2、express路由的模块化

为了方便对路由进行模块化的管理,Express不建议将路由直接挂载到app上,而是推荐将路由抽离为单独的模块。

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

const express = require('express');
const router = express.Router()
router.get('/user',(req,res)=>{
  res.send('Get user list')
})
router.post('user/add',(req,res)=>{
  res.send('req.params')
})
module.exports = router
第三章:Express中间件
3.1、中间件概念

特指业务流程的中间处理环节

调用流程:

中间件格式:

Express的中间件,本质上是function处理函数,

const zjj = function(req,res,next){
    next()  //当前业务处理完后,必须调用next函数,把关系转交给下一个中间件或路由
})

注:

①中间件函数的形参列表中,必须包含next参数,而路由处理函数只包含req和res

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

3.2、中间件初体验

1)全局生效的中间件

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

通过调用app.use(中间件函数)

const mw = function(req,res,next){
  console.log('交给下一个,lm,popst')
  next()
}
app.use(mw)
app.use(function(req,res,next){   //全局中间件的简化形式
    next()
})

2)中间件作用

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

3)定义多个全局中间件

使用app.use()连续定义多个全局中间件,按定义的顺序执行

4)局部生效的中间件

不使用app.use()定义的中间件,叫做局部生效的中间件,

const mw1 = function(req,res,next){
  console.log('局部中间件')
  next()
}
app.get('/user',mw1,function (req,res) {
  res.send('请求')
})

5)定义多个局部中间件

app.get('/user',mw1,mw2,function (req,res) {
  res.send('请求')
})

6)注意事项

①一定要在路由之前注册中间件

②客户端发送过来的请求,可以连续调用多个中间件进行处理

④执行完中间件的业务代码之后,不要忘记调用next()函数

④为了防止代码逻辑混乱,调用next()函数后不要再写额外的代码

⑤连续调用多个中间件时,多个中间件之间,共享req和res对象

3.3、中间件的分类

1)应用级别的中间件

通过app.use()或app.get()或app.post(),绑定到app实例上的中间件,叫做应用级别的中间件

2)路由级别的中间件

绑定到express.Router0实例上的中间件,叫做路由级别的中间件。router.use()

3)错误级别的中间件

错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。

参数格式有:(err,req,res,next)

app.get('/url',(req,res)=>{
  throw new Error('服务器发生错误了wl')
  res.send('新请求')
})
app.use(function(err,req,res,next){
  console.log('中间件')
  console.log('错误' + err.message)
  next()
})

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

4)Express内置的中间件

①express.static 快速托管静态资源的内置中间件,例如:HTML文件、图片、CSS样式等(无兼容性)

②express.json 解析JSON格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)③expres.urlencoded 解析URL-encoded 格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)

//默认情况下,如果不配置解折表单数据的中间件,则req.body默认等于undefined
app.use(express.json())  
app.use(express.urlencoded({extended:false}))

5)第三方的中间件

按需下载并配置中间件,提高开发效率

npm install body-parser
const bodyPaser = require('body-parser')
app.use(bodyPaser)
3.4、自定义中间件

自己手动模拟一个类似于express.urlencoded这样的中间件,来解析POST提交到服务器的表单数据。

步骤:

①定义中间件

②监听req的data事件

③监听req的end事件

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

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

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

app.use(function(req,res,next){
    
})
第四章:使用Express写接口
4.1、编写get接口、post接口
const router = express.Router()
router.get('/get',(req,res)=>{
    const query = req.query
    res.send({
        status:0,
        msg:'GET请求成功',
        data:'wwww'    
    })
})
router.post('/sum',(req,res)=>{
  const body = req.body   //req.body获取请求体中包含的url-encoded格式的数据
  res.send({
    status:0,
    msg:'请求成功',
    data:body
  })
})
module.exports = router

//
const express = require('express')
const app = express()
const router = require('./getinterface')
app.use('/api',router)
app.listen(80,function(req,res){
  console.log('http://127.0.0.1')
})

主函数

const express = require('express')
const app = express()
app.use(express.urlencoded({extended: false}))//配置解析表单数据
//必须在配置cors中间件之前,配置jsonp接口
app.get('/api/jsonp',(req,res)=>{
  const funcName = req.query.callback
  const data = {name:'ww',age:22}
  const scriptStr = `${funcName}(${JSON.stringify(data)})`
  res.send(scriptStr)
})
const cors = require('cors')
app.use(cors())
const router = require('./postInter.js')
app.use('/api',router)

app.listen(80,function(req,res){
  console.log('http://127.0.0.1')
})

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

4.2、跨域-CORS方法(主流的解决方案,推荐使用)

在线版的http://staticfile.org/

CORS(Cross-Origin Resource Sharing,跨域资源共享)由一系列HTTP响应头组成,这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源。

浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了CORS相关的HTTP响应头(Access-Control-Allow-*),就可以解除浏览器端的跨域访问限制。

cors是Express的一个第三方中间件。通过安装和配置cors中间件,可以很方便地解决跨域问题。

1)使用步骤分为如下3步:

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

注意事项:

①CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了CORS的接口。

②CORS在浏览器中有兼容。只有支持XMLHttpRequest Level2的浏览器,才能正常访问开启了CORS的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。

2)cors相关的三个响应头
需要加上:Access-Control-Allow-Credentials: true
①CORS 响应头部-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 对额外的请求头进行声明,否则这次请求会失败!

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方法。

res.setHeader('Access-Control-Allow-Methods','GET,POST,HEAD,PUT,DELETE')
res.setHeader('Access-Control-Allow-Methods','*')  //允许所有的HTTP请求方法

3)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请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。

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

简单请求的特点:客户端与服务器之间只会发生一次请求。

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

4.3、跨域-JSONP(有缺陷的解决方案:只支持GET请求)

1)概念

浏览器端通过

2)特点:

①JSONP不属于真正的Ajax请求,因为它没有使用XMLHttpRequest这个对象。

②JSONP仅支持GET请求,不支持POST、PUT、DELETE等请求。

3)创建JSONP接口的注意事项

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

4)实现JSONP接口的步骤

①获取客户端发送过来的回调函数的名字

②得到要通过JSONP形式发送给客户端的数据

③根据前两步得到的数据,拼接出一个函数调用的字符串

④把上一步拼接得到的字符串,响应给客户端

//必须在配置cors中间件之前,配置jsonp接口
app.get('/api/jsonp',(req,res)=>{
  const funcName = req.query.callback
  const data = {name:'ww',age:22}
  const scriptStr = `${funcName}(${JSON.stringify(data)})`
  res.send(scriptStr)
})

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

调用$ajax()函数,提供JSONP的配置项,从而发起JSONP请求,

$('#btjsonp').on('click',function () {
  $.ajax({
    type:'GET',
    url:'http://127.0.0.1/api/jsonp',
    dataType:'jsonp',
    data:{
      name:'ww-pdewdewdwep',
      age:222233
    },
    success:function (res) {
      console.log(res)
    }
  })
})

你可能感兴趣的:(Express,中间件,前端,node.js)