Express框架学习笔记


Express框架学习笔记

概念:Express是基于Node.js平台,快速、开放、极简的Web开发框架。

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

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

Express是基于内置的http模块进一步封装出来的,能极大的提高开发效率。

Express能做什么

对于前端程序员来说,最常见的两种服务器,分别是:

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

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

创建基本Web服务器

  1. 在项目中下载expressnpm i express@4.17.1
  2. 导入express模块、创建Web服务器、调用Web服务器
// 导入express模块
const express = require('express')
// 创建Web服务器
const app = express()
// 调用Web服务器
app.listen(80, () => {
  console.log('hello world');
})
  1. 执行js文件node 文件名

监听GET请求

通过app.get()方法,可以监听客户端的GET请求,具体的语法格式如下:

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

监听POST请求

通过app.post()方法,可以监听客户端的POST请求,具体的语法格式如下:

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

把内容响应给客户端

通过res.send()方法,可以把处理好的内容,发送给客户端:

app.get('/user', (req, res) => {
    // 向客户端发送JSON对象
    res.send({ name: 'zs', age: 20, gender: 'nan' })
})

app.post('/user', (req,res) => {
    // 向客户端发送文本内容
    res.send('请求成功')
})

获取URL中携带的查询参数

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

app.get('/', (req, res) => {
  // 通过req.query可以获取到客户端发送过来的查询参数
  // 默认情况下req.query是一个空对象
  console.log(req.query);
  res.send(req.query)
})

获取URL中的动态参数

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

// URL中可以通过 :参数名 的形式,匹配动态参数值
app.get('/user/:id', (req, res) => {
  // req.params是动态匹配到的URL参数
  // 默认情况下req.params是一个空对象
  console.log(req.params);
  res.send(req.params)
})

托管静态资源

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

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

多个静态资源的托管

同时通过多个静态资源目录,需要多次调用express.static()函数。

当调用的文件名同时在多个静态资源目录中存在,调用的是第一个存在该文件名目录下的文件。

当给某个静态资源目录挂载前缀后,在路径中加上该前缀才能访问该目录下的文件

const express = require('express')
const app = express()
app.use('/abc',express.static('./files'))
app.use(express.static('./clock'))
app.listen(80, () => {
    console.log('welcome')
})

路由

广义上来讲,路由就是映射关系。

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

Express中的路由份3部分组成,分别是请求的类型、请求的URL地址、处理函数,格式如下:app.METJOD(PATH, HANDLER)

路由的匹配过程

每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功后,才会调用对应的处理函数。

在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的URL同时匹配成功,则Express会将这次请求转交给对应的function函数进行处理。

在这里插入图片描述

路由匹配的注意点:

  1. 按照定义的先后顺序进行匹配。
  2. 请求类型和请求的URL必须同时匹配

成功,才会调用对应的处理函数。

路由的使用

在Express中使用路由最简单的方式,就是把路由挂载到app上,示例代码如下:

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

// 
app.get('/user', (req, res) => {
  res.send('hello world')
})
app.post('/user', (req, res) => {
  res.send('hello world')
})

// 启动Web服务器
app.listen(80, () => {
  console.log('running');
})
模块化路由

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

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

  1. 创建路由对象的js文件
  2. 调用express.Router()函数创建路由对象
  3. 向路由对象上挂着具体的路由
  4. 使用module.exports向外共享路由对象
  5. 使用app.use()函数注册路由模块
// 导入express
const express = require('express')
// 创建路由对象
const router = express.Router()

// 挂载具体的路由
router.get('/user/list', (req, res) => {
  res.send('GET')
})
router.post('/user/list', (req, res) => {
  res.send('POST')
})

// 向外导出路由对象
module.exports = router

给app挂载路由模块:

const express = require('express')
const app = express()
// 导入路由模块
const router = require('./03.router')
// 注册路由模块
app.use(router)
app.listen(80, () => {
  console.log('http://127.0.0.1')
})

app.use()函数的作用:用来注册全局中间件。

为路由添加前缀

类似于托管静态资源时,为静态资源统一挂载访问前缀一样,路由模块添加前缀的方式也非常简单:

// 导入路由模块
const user = require('./router/user.js')
// 使用app.use()注册路由模块,并添加统一的访问前缀 /api
app.use('/api', user)

中间件

举例:在处理污水的时候,一般都要经过三个环境,从而保证废水达到排放标准。

在这里插入图片描述

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

Express中间件的调用流程

当一个请求到达Express的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。

在这里插入图片描述

Express中间件的格式

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

在这里插入图片描述

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

next函数的作用

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

在这里插入图片描述

定义中间件函数

// 常量mw所指向的,就是一个中间件函数
const mw = function(req, res, next) {
    console.log('running')
    // 注意:当前中间件业务处理完毕后,必须调用next()函数
    // 表示把流转关系转交给下一个中间件或路由
    next()
}

全局生效的中间件

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

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

// 常量mw所指向的,就是一个中间件函数
const mw = function(req, res, next) {
    console.log('running')
    next()
}
// 全局生效的中间件
app.use(mw)

定义多个全局中间件:可以使用app.use()连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序一次进行调用。

中间件的作用

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

在这里插入图片描述

局部生效的中间件

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

const mw1 = function(req, res){}
app.get('/', mw1, function(req, res){}) // 使用局部中间件
app.get('/user', function(req, res){}) // 不使用局部中间

定义多个局部中间件:

// 以下两种写法完全等价
app.get('/', mw1, mw2, (req, res) => { res.send('aaa') })
app.get('/', [mw1, mw2], (req, res) => { res.send('aaa') })

中间件的5个使用注意事项

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

中间件的分类

Express官方把常见的中间件用法分成了5大类,分别是:

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

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

**路由级别的中间件:**绑定到express.Router()实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别的中间件时绑定到app实例上,路由级别的中间件绑定到router(const router = express.Router)实例上。

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

  • 格式:错误级别的中间件的function处理函数中,必须有4个形参,形参顺序从前到后,分别是(err, req, res next)

  • const express = require('express')
    const app = express()
    const mw = function (err, req, res, next) {
      console.log(`${err.message}`);
      res.send(`${err.message}`)
    }
    app.get('/', function (req, res) {
      throw new Error('错误!')
      res.send('Yes')
    })
    app.use(mw)
    app.listen(80, () => {
      console.log('welcome');
    })
    
  • 错误级别的中间件要放在所有路由之后。

Express内置的常用中间件:

  • express.static快速托管静态资源的内置中间件,例如:HTML文件、图片、CSS样式等(无兼容性)
  • express.json解析JSON格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
    • 在服务器,可以使用req.body这个属性,来接收客户端发送过来的请求体数据,默认情况下如果不配置解析表单数据的中间件,则req.body默认等于undefined
  • express.urlencoded解析URL-encoded格式的请求体数据(有兼容性,仅在4.16.0+版本中可用)
// 配置解析application/json格式数据的内置中间件
app.use(express.json())
// 配置解析application/x-www-form-urlencoded格式数据的内置中间件
app.use(express.urlencoded({extended: false}))

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

例如:在express@4.16.0之前的版本中,经常使用body-parser这个第三方中间件,来解析请求体数据。使用步骤如下:

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

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

自定义中间件

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

实现步骤:

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

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

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

// 定义变量,用来存储客户端发送过来的请求体数据
let str = ''
// 监听req对象的data事件(客户端发送过来的新的请求体数据)
req.on('data', (chunk) => {
    // 拼接请求体数据,隐式转换为字符串
    str += chunk
})
监听req的end事件

当请求体数据接收完毕之后,会自动触发req的end事件。

因此,我们可以在req的end事件中,拿到并处理完整的请求体数据。

// 监听req对象的end事件(请求体发送完毕后自动触发)
req.on('end', () => {
    // 打印完整的请求体数据
    console.log(str)
    // TODO:把字符串格式的请求体数据,解析成对象格式
})
使用querystring模块解析请求体数据

Node.js内置了一个querystring模块,专门用来处理查询字符串。通过这个模块提供的parse()函数,可以轻松把查询字符串解析成对象的格式。

// 导入处理querystring的Node.js内置模块
const qs = require('querystring')
// 调用qs.parse()方法,把查询字符串解析为对象
const body = qs.parse(str)
将解析出来的数据对象挂载为req.body

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

req.on('end', () => [
    const body = qs.parse(Str) // 调用qs.parse()方法,把查询字符串解析为对象
	req.body = body // 将解析出来的请求体对象挂载为req.body属性
	next()
])
将自定义中间件封装为模块

为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块。

const qs = require('querystring')
function bodyParser(req, res, next) {}
module.exports = bodyParser

// 导入自定义的中间件函数
const myBodyParser = require('custom-body-parser')
// 注册自定义的中间件模块
app.use(myBodyParse)

跨域问题

自己编写的接口存在一个很严重的问题:不支持跨域请求。

原因:自己的网页在浏览器上是file协议,而接口时http协议

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

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

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

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

使用步骤:

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

什么是CORS

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

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

CORS的注意事项

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

CORS三大响应头部

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', '*')
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-Allow-Methods来指明实际请求所允许使用的HTTP方法。

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

CORS跨域资源共享

简答请求

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

  1. 请求方式:GET、POST、HEAD三者之一
  2. HTTP头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type(值仅限于text/plain、multipart/form-data、application/x-www-form-urlencoded三者之一)
预检请求

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

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

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

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

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

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

JSONP接口

概念:浏览器端通过

特点:

  1. JSONP不属于真正的Ajax请求,因为它没有使用XMLHttpRequest这个对象。
  2. JSONP仅支持GET请求,不支持POST、PUT、DELETE等请求。
创建JSONP接口的注意事项

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

// 优先创建JSONP接口(这个接口不会被处理成CORS接口)
app.get('/api/jsonp', (req,res) => {})
// 再配置CORS中间件(后续所有接口都会配处理成CORS接口)
app.use(cors())
// 这是一个开启了CORS的接口
app.get('/api/get', (req,res) => {})
实现JSONP接口的步骤
  1. 获取客户端发送过来的回调函数的名字
  2. 得到要通过JSONP形式发送给客户端的数据
  3. 根据前两步得到的数据,拼接出一个函数调用的字符串qign
  4. 把上一步得到的字符串,响应给客户端的
app.get('/api/jsonp',(req, res) => {
    // 获取客户端发送过来的回调函数的名字
    const funcName = req.query.callback
    // 得到要通过JSONP形式发送给客户端的数据
    const data = {name: 'zs', age: 22}
    // 根据根据前两步得到的数据,拼接出一个函数调用的字符串qign
    const scriptStr = `${funcName}(${JSON.stringify(data)})`
    // 把上一步得到的字符串,响应给客户端的<script>标签进行解析执行
    res.send(scriptStr)
})
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值