初识express
什么是express?
官方给出的概念:express是基于Node.js平台,快速、开放、极简的web开发框架。
通俗的理解:express的作用和Node.js内置的http模块类似,是专门用来创建web服务器的。
express的本质:就是一个npm上的第三方包,提供了快速创建web服务器的便捷的方法。
安装
在项目所处的目录中,运行如下的终端命令,即可将express安装到项目中使用:
npm i express@4.17.1
使用express创建最基本的web服务器
// 导入express
const express=require('express')
// 创建web服务器
const app=express()
// 启动web服务器
app.listen(80,()=>{
console.log('express server running at http://127.0.0.1')
})
监听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:'男'})
})
app.post('/user',(req,res)=?{
//向客户端发送文本内容
res.send('请求成功')
})
获取URL中携带的查询参数
通过req.query对象,可以访问到客户端通过查询字符串的形式,发送到服务器的参数:
app.get('/',(req,res)=>{
//req.query默认是一个空对象
//客户端使用?namezs&age=20这种查询字符串形式,发送服务器的参数
//可以通过req.query对象访问到,例如
//req.query.name req.qurey.age
console.log(req.query)
)
获取URL中的动态参数
通过req.params对象,可以访问到URL中,通过:匹配到的动态参数:
//URL地址中,可以通过:参数名 的形式,匹配动态参数值
app.get('/user/:id',(req,res)=>{
//req.params默认是一个空对象
//里面存放着通过:动态匹配到的参数值
console.log(req.params)
})
托管静态资源
express.static()
express提供了一个非常好用的函数,叫做express.static(),通过它,我们可以非常方便的创建一个静态资源服务器,例如,通过如下代码可以将public目录下的图片、css文件、JavaScript文件对外开放访问了:
app.use(express.static('public'))
现在,就可以访问public目录中的所有文件了:
http://localhost:3000/images/bg.jpg
http://localhost:3000/css/style.css
http://localhost:3000/js/login.js
注意:express在指定的静态目录中查找文件,并对外提供资源的访问路径。因此,存放静态文件的目录名不会出现在URL中。
如果要托管多个静态资源目录,多次调用express.static()函数
app.use(express.static('public'))
app.use(express.static('files'))
访问静态资源文件时,express.static()函数会根据目录的添加顺序查找所需的文件。
如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下的方式:
app.use('/public',express.static('public'))
这样就可以通过带有/public前缀地址来访问public目录中的文件了:
http://localhost:3000/public/images/bg.jpg
nodemon
在编写调试nodejs项目的时候,如果修改了项目的代码,则需要频繁的手动close掉,然后再重新启动,非常繁琐。现在我们可以使用nodemon这个工具,它能够监听项目文件的变动,当代码被修改后,nodemon会自动帮我们重启项目,极大方便了开发和调试。
安装nodemon
npm install -g nodemon
使用nodemon
当基于nodejs编写了一个网站应用的时候,传统的方式是运行node app.js命令来启动项目。这样做的坏处是:代码被修改之后,需要手动重启项目。因此,我们可以将node命令替换为nodemon命令,使用nodemon app.js来启动项目。这样做的好处是:代码被修改之后,会被nodemon监听到,从而实现自动重启项目的效果。
express路由
什么是路由
广义上来讲,路由就是映射关系。
express中的路由
在express中,路由指的是客户端的请求与服务器处理函数之间的映射关系。
express中的路由分三部分组成,分别是请求的类型、请求的URL地址、处理函数,格式如下:
app.METHOD(PATH,HANDLER)
//匹配get请求,且请求URL为/
app.get('/',function(req,res){
res.send('hello world')
})
//匹配post请求,且请求URL为/
app.post('/',function(req,res){
res.send('got a post request')
})
路由的匹配过程
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数。在匹配时,会按照路由的顺序进行匹配,如果有请求类型和请求的URL同时匹配成功,则express会将这次请求,转交给对应的function函数进行处理。
最简单的用法
在express中使用路由最简单的方式,就是把路由挂载到app上,如:
const express=require('express')
//创建web服务器,命名为app
const app=express()
//挂载路由
app.get('/',(req,res)=>{
res.send('hello world')
})
app.post('/',(req,res)=>{
res.send('post request')
})
app.listen(80,()=>{
console.log('server running at http://127.0.0.1')
})
模块化路由
为了方便对路由进行模块化的管理,express不建议将路由直接挂载到app上,而是推荐路由抽离为单独的模块。将路由抽离为单独模块的步骤如下:
①创建路由模块对应的js文件
②调用express.Router()函数创建路由对象
③向路由对象上挂载具体的路由
④使用module.exports向外共享路由对象
⑤使用app.use()函数注册路由模块
创建路由模块
// 这是路由模块
const express=require('express')
// 创建路由对象
const router=express.Router()
// 挂载具体的路由
router.get('/user/list',(req,res)=>{
res.send('get user list')
})
router.post('/user/add',(req,res)=>{
res.send('add new user')
})
// 向外导出路由对象
module.exports=router
注册路由模块
const express=require('express')
const app=express()
// 导入路由模块
const router=require('./33router')
// 注册路由模块
app.use(router)
// 注意:app.use()函数的作用就是用来注册全局中间件
app.listen(80,()=>{
console.log('server running at http://127.0.0.1')
})
为路由模块添加前缀
类似于托管静态资源时,为静态资源统一挂载访问前缀一样,路由模块添加前缀的方式也非常简单:
// 导入路由模块
const router=require('./33router')
// 注册路由模块
app.use('/api',router)
express中间件
什么是中间件
中间件(Middlewave),特指业务流程的中间处理环节。
express中间件的调用流程
当一个请求到达express的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。
express中间件的格式
express的中间件,本质上就是一个function处理函数,express中间件的格式如下:
注意:中间件函数的形参列表中,必须包含next参数。而路由处理函数中只包含req和res 。
next函数的作用
next函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
定义中间件函数
const express=require('express')
const app=express()
// 定义一个最简单的中间件函数
const mw=function(req,res,next){
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或路由
next()
}
app.listen(80,()=>{
console.log('server running at http://127.0.0.1')
})
全局生效的中间件
客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件。通过调用app.use(中间件函数),即可定义一个全局生效的中间件。
// 定义一个最简单的中间件函数
const mw=function(req,res,next){
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或路由
next()
}
// 将mw注册为全局生效的中间件
app.use(mw)
定义全局中间件的简化形式
// 这是定义全局中间件的简化形式
app.use((req,res,next)=>{
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或路由
next()
})
中间件的作用
多个中间件之间,共享同一份req和res。基于这样的特性,可以在上游的中间件中,统一为req或res对象添加自定义的属性或方法,供下游的中间件或路由进行使用。
定义多个全局中间件
可以使用app.use()连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用。
//定义第一个全局中间件
app.use((req,res,next)=>{
console.log('调用了第一个全局中间件')
next()
})
//定义第二个全局中间件
app.use((req,res,next)=>{
console.log('调用了第二个全局中间件')
next()
})
局部生效的中间件
不使用app.use()定义的中间件,叫做局部生效的中间件。
const express=require('express')
const app=express()
const mw1=(req,res,next)=>{
console.log('调用了局部生效的中间件')
next()
}
app.get('/',mw1,(req,res)=>{
res.send('home page')
})
app.post('/user',(req,res)=>{
res.send('user page')
})
app.listen(80,()=>{
console.log('server running at http://127.0.0.1')
})
定义多个局部中间件
可以在路由中,通过如下两种等价的方式,使用多个局部中间件:
//以下两种写法是“完全等价”的,可根据自己的喜好,选择任意一种方式进行使用
app.get('/',mw1,mw2,(req,res)=>{
res.send('home page')
})
app.get('/',[mw1,mw2],(req,res)=>{
res.send('home page')
})
了解中间件的五个注意事项
①一定要在路由之前注册中间件
②客户端发送过来的请求,可以连续调用多个中间件进行处理
③执行完中间件的业务代码之后,不要忘记调用next()函数
④为了防止代码逻辑混乱,调用next()函数后不要再写额外的代码
⑤连续调用多个中间件时,多个中间件之间,共享req和res对象
中间件的分类
为了方便大家理解和记忆中间件的使用,express官方把常见的中间件用法,分成了五大类,分别是:
应用级别的中间件;路由级别的中间件;错误级别的中间件;express内置的中间件;第三方的中间件
应用级别的中间件
通过app.use()或app.get()或app.post(),绑定到app实例上的中间件,叫做应用级别的中间件。
//应用级别的中间件(全局中间件)
app.user((req,res.next)=>{
next()
})
//应用级别的中间件(疾步中间件)
app.get('/',mw1,(req,res)=>{
res.send('home page')
})
路由级别的中间件
绑定到express.Router()实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别的中间件是绑定到app实例上,路由级别的中间件绑定到router实例上。
const app=express()
const router=express.Router()
//路由级别的中间件
router.use(function(req,res,next){
console.log('Time:',Date.now())
})
app.use('/',router)
错误级别的中间件
错误级别的中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。错误级别中间件的function处理函数中,必须有四个形参,形参顺序从前到后分别是(err,req,res,next)。
app.get('/',function(req,res){ //路由
throw new Error('服务器内部发生了错误') //抛出一个自定义的错误
rea.send('home page')
})
app.use(function(err,req,res,next){ //错误级别的中间件
console.log('发生了错误:'+err.message) //在服务器打印错误消息
res.send('Error'+err.message) //向客户端响应错误相关的内容
})
注意:错误级别的中间件必须注册在所有路由之后!
express内置的中间件
自express4.16.0版本开始,express内置了三个常用的中间件,极大的提高了express项目开发效率和体验。
①express.static快速托管静态资源的内置中间件,例如:HTML文件、图片、css样式等(无兼容性)
②express.json解析JSON格式的请求体数据(有兼容性,仅在4.16.0+版本可用)
③express.urlencoded解析URL-encoded格式的请求体数据(有兼容性,仅在4.16.0+版本可用)
//配置解析application/json格式数据的内置中间件
app.use(express.json())
//配置解析application/x-www-form-urlencoded格式数据的内置中间件
app.use(express.urlencoded({extended:false}))
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(80,()=>{
console.log('server running at http://127.0.0.1')
})
第三方的中间件
非express官方内置的,而是有第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。例如咋:在express@4.16.0之前的版本中,经常使用body-parser这个第三方中间件,来解析请求体数据。使用步骤如下:
①运行npm install body-parser安装中间件
②使用require导入中间件
③调用app.use()注册中间件
const express=require('express')
const app=express()
// 导入解析表单数据的中间件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('server running at http://127.0.0.1')
})
注意:express内置的express.urlencoded中间件,就是基于body-parser这个第三方中间件进一步封装出来的。
自定义中间件
手动模拟一个类似于express.urlencoded这样的中间件,来解析post提交到服务器的表单数据。
①定义中间件
②监听req的data事件
③监听req的end事件
④使用querystring模块解析请求体数据
⑤将解析出来的数据对象挂载为req.body
⑥将自定义中间件封装为模块
定义中间件
使用app.use()来定义全局生效的中间件
app.use(function(req,res,next){
//中间件的业务逻辑
})
监听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模块解析请求体数据
nodejs内置了一个querystring模块,专门用来处理查询字符串。通过这个模块提供的parse()函数,可以青松把查询字符串,解析成对象的格式。
//导入处理querystring的nodejs内置模块
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() //最后,一定要调用next()函数,执行后续的业务逻辑
})
将自定义中间件封装为模块
为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块
//导入处理querystring的nodejs内置模块
const qs=require('querystring')
const bodyParser=(req,res,next)=>{
// 定义中间件具体的业务逻辑
// 定义一个str字符串,专门用来存储客户端发送过来的请求体
let str=''
// 监听req的data事件
req.on('data',(chunk)=>{
str +=chunk
})
// 监听req的end事件
req.on('end',()=>{
console.log(str)
//TODO:把字符串格式的请求体数据,解析成对象格式
//调用qs.parse()方法,把查询字符串解析为对象
const body=qs.parse(str)
req.body=body
next()
})
}
module.exports=bodyParser
使用express写接口
编写get接口
apiRouter.get('/get',(req,res)=>{
//获取到客户端通过查询字符串,发送到服务器的数据
const query=req.qurey
//调用res.send()方法,把数据响应给客户端
res.send({
status:0, //状态,0表示成功过,1表示失败
msg:'get请求成功', //状态描述
data:query //需要响应给客户端的具体数据
})
})
编写post接口
apiRouter.post('/post',(req,res)=>{
//获取到客户端通过查询字符串,发送到服务器的url-encoded数据
const body=req.body
//调用res.send()方法,把数据响应给客户端
res.send({
status:0, //状态,0表示成功过,1表示失败
msg:'post请求成功', //状态描述
data:body //需要响应给客户端的具体数据
})
})
注意:如果要获取url-encoded格式的请求体数据,必须配置中间件app.use(express.urlencoded({extend:false}))
cors跨域资源共享
get和post接口,不支持跨域请求。解决接口跨域的方案主要有两种:
①cors(主流的解决方案,推荐使用)
②JSONP(有缺陷的解决方案:只支持get请求)
cors是express的一个第三方中间件。通过安装和配置cors中间件,可以很方便的解决跨域问题。
①运行npm install cors安装中间件
②使用const cors=require('cors')导入中间件
③在路由之前调用app.use(cors())配置中间件
什么是cors
cors(Cross-Origin Resource Sharing,跨域资源共享)由一些列http响应头组成,这些http响应头决定浏览器是否阻止前端JS代码蛞蝓获取资源。
浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了cors相关的http响应头,就可以解除浏览器的跨域访问限制。
注意:
①cors主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了cors的接口。
②cors在浏览器中有兼容性。只有支持XMLHttpRequest Leel2的浏览器,才能正常访问开启了cors的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。
cors相关的三个响应头
cors响应头部 - Access-Control-Allow-Origin
响应头部中可以携带一个Access-Control-Allow-Origin字段,其语法如下:
Access-Control-Allow-Origin:<origin>|*
其中,origin参数的值指定了允许访问该资源的外域URL。
例如,下面的字段值将只允许来自http://itcast.n的请求
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请求的分类
客户端在请求cors接口时,根据请求方式和请求头的不同,可以将cors的请求分为两大类,分别是:简单请求和预检请求
简单请求
同时满足以下两大条件的请求,就属于简单请求:
①请求方式:get、post、head三者之一
②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三者之一)
预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求:
①请求方式为get、post、head之外的请求method类型
②请求头中包含自定义头部字段
③向服务器发送了application/json格式的数据
在浏览器与服务器正式通信之前,浏览器会先发送option请求进行预检,以获知服务器是否允许该实际请求,所以这一次的option请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
简单请求和预检请求的区别
简单请求的特点:客户端与服务器直接只会发送一次请求。
预检请求的特点:客户端与服务器之间会发送两次请求,option预检请求成功之后,才会发起真正的请求。
JSONP接口
概念:浏览器端通过<script>标签的src属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做JSONP。
特点:
①JSONP不属于真正的ajax请求,因为它没有使用XMLHttpRequest这个对象
②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接口的步骤
①获取客户端发送过来的回调函数的名字
②得到要通过jsonp形式发送给客户端的数据
③根据前两步得到的数据,拼接出一个函数调用的字符串
④把上一步拼接得到的字符串,响应给客户端的<script>标签进行解析执行
实现jsonp接口的具体代码
app.get('/api/jsonp',(req,res)=>{
//获取客户端发送过来的回调函数的名字
const funcName=req.query.callback
//得到要通过jsonp形式发送给客户端的数据
const data={name:'zs',age:22}
//根据前两部得到的数据,拼接出一个函数调用的字符串
const scriptStr=`${funcName}(${JSON.stringify(data)})`
//把上一步拼接得到的字符串,响应给客户端的<script>标签进行解析执行
res.send(scriptStr)
})
在网页中使用jQuery发起jsonp请求
调用$.ajax()函数,提供jsonp的配置选项,从而发起jsonp请求。
$('#btnJSONP').on('click',function(){
$.ajax({
method:'get',
url:'http://127.0.0.1/api/jsonp',
dataType:'jsonp', //表示要发起jsonp的请求
success:function(res){
console.log(res)
}
})
})