Express简介
什么是Express
官方的概念: Express是基于Node.js平台, 快速、开放、极简的Web开发框架。
通俗的理解: Express的作用和Node.js内置的http模块类似, 是专门用来创建Web服务器的。
Express的本质:就是一个npm上的第三方包, 提供了快速创建web服务器的便捷方法。
Express的中文官网: www.expressjs.com.cn
进一步理解Express
思考: 不使用Express能否创建Web服务器? 答案: 能, 使用Node.js提供的原生http模块即可。
思考: 既然有了http模块, 为什么还要用Express? 答案: http内置模块用起来很复杂, 开发效率低; Express是基于内置的http模块进一步封装出来的。 能够极大的提高开发效率。
思考: http内置模块与Express是什么关系? 答案: 类似于浏览器中Web API和jQuery的关系, 后者是基于前者的进一步封装出来的。
Express能做什么
对于前端程序员来说, 最常见的两种服务器,分别是:
- Web网站服务器: 专门对外提供Web网页资源的服务器。
- API接口服务器: 专门对外提供API接口的服务器。
使用Express, 我们可以方便、快速的创建Web网站的服务器或API接口的服务器。
Express的基本使用
安装
在项目所处的目录中, 运行如下的终端命令, 即可将express安装到项目中使用:
npm i express@4.17.1
创建基本的Web服务器
// 1. 导入express
const express = require('express')
// 2. 创建 web 服务器
const app = express()
// 3. 调用app.listen(端口号, 启动成功后的回调函数), 启动服务器
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 默认是一个空对象
// 客户端使用 ?name=zs&age=20 这种查询字符串形式, 发送到服务器的参数
// 可以通过 req.query 对象访问到, 例如:
// req.query.name req.query.age
console.log(req.query)
})
获取URL中的动态参数
通过req.params对象, 可以访问到URL中, 通过 :匹配到的动态参数:
app.get('/user/:id/:name', (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
http://localhost:3000/public/css/style.css
http://localhost:3000/public/js/app.js
nodemon
为什么要使用nodemon
在编写调试Node.js项目的时候, 如果修改了项目的代码, 则需要频繁的手动close掉, 然后再重新启动, 非常繁琐。
现在, 可以使用nodemon(www.npmjs.com/package/nod… 它能够监听项目文件的变动, 当代码被修改后, nodemon会自动帮我们重启项目, 极大方便了开发好调试。
安装nodemon
在终端中, 运行如下命令, 即可将nodemon安装为全局可用的工具:
npm install -g nodemon
使用nodemon
当基于Node.js编写了一个网站应用的时候, 传统的方式, 是运行node app.js命令, 来启动项目, 这样做的坏处是:
代码被修改之后, 需要手动重启项目。
现在, 我们可以将node命令替换成nodemon命令, 使用nodemon app.js来启动项目, 这样做的好处是:代码被修改后, 会被 nodemon监听到, 从而实现自动启动项目的效果。
node app.js
<!-- 将上面的命令, 替换成下面的命令, 即可实现自动重启项目的效果 -->
nodemon app.js
Express路由
路由的概念
什么是路由
广义上来讲, 路由就是映射关系。
Express中的路由
在Express中, 路由指的是客户端的请求与服务器处理函数之间的映射关系。 Express中的路由分3部分组成, 分别是请求的类型, 请求的URL地址, 处理函数, 格式如下:
app.METHOD(PATH, HANDLER)
Express中路由的例子
// 匹配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函数进行处理。
路由匹配的注意点:
- 按照定义的先后顺序进行匹配
- 请求类型和请求的URL同时匹配成功,才会调用对应的处理函数
路由的使用
最简单的用法
在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')})
// 启动web服务器
app.listen(80, () => {
console.log('server running at http://127.0.0.1')
})
模块化路由
为了方便对路由进行模块化的管理, Express不建议将路由直接挂载到app上, 而是推荐将路由抽离为单独的模块。
将路由抽离为单独模块的步骤如下:
- 创建路由模块对应的.js文件
- 调用
express.Router()函数创建路由对象 - 向路由对象上挂载具体的路由
- 使用
module.express向外共享路由对象 - 使用
app.use()函数注册路由模块
创建路由模块
// 导入express
var express = require('express')
// 创建路由对象
var router = express.Router()
// 挂载获取用户列表的路由
router.get('/user/listen', function(req, res) {
res.send('Get user list')
})
router.post('/user/add', function(req, res) {
res.send('Add new user.')
})
// 向外导出路由对象
module.exports = router
注册路由模块
// 导入路由模块
const userRouter = require('./router/user.js')
// 使用app.use()注册路由模块
app.use(userRouter)
为路由模块添加前缀
类似于托管静态资源时, 为静态资源统一挂载访问前缀一样, 路由模块添加前缀的方式也非常简单:
const userRouter = require('./router/user.js')
app.use('api', userRouter)
Express中间件
中间件的概念
现实生活中的例子
在处理污水的时候, 一般都要经过三个处理环节, 从而保证处理过后的废水, 达到排放标准。
处理污水的这三个中间处理环节, 就可以叫做中间件。
Express中间件的调用流程
当一个请求到达Express的服务器之后, 可以连续调用多个中间件, 从而对这次请求进行预处理。
Express中间件的格式
Express的中间件, 本质上就是一个function处理函数, Express中间件的格式如下:
注意: 中间件函数的形参列表中, 必须包好next参数。 而路由处理函数中只包含req和res。
next函数的作用
next函数是实现多个中间件连续调用的关键, 它表示把流转关系转交给下一个中间件或者路由。
Express中间件的初体验
定义中间件的函数
// 常量mw 所指向的就是一个中间件函数
const mw = function(req, res, next) {
console.log('这是一个中间件函数')
// 注意:在当前中间件的业务处理完毕后,必须调用next()函数
// 表示把流转关系转交给下一个中间件或路由
next()
}
全局生效的中间件
客户端发起的任何请求, 到达服务器之后, 都会出发的中间件, 叫做全局生效的中间件。
通过调用app.use(中间件函数), 即可定义一个全局生效的中间件, 示例代码如下:
// 常量mw所指向的就是一个中间件函数
const mw = function(req, res, next) {
console.log('这是一个最简单的中间件函数')
next()
}
// 全局生效的中间件
app.use(mw)
定义全局中间件的简化形式
// 全局生效的中间件
app.use(function(req, res, next) {
console.log('这是一个最简单的中间件函数')
next()
})
中间件的作用
多个中间件之间, 共享一份req和res, 基于这样的特性, 我们可以在上游的中间件, 统一为req或res对象添加自定义的属性和方法, 供下游的中间件或路由进行使用。
定义多个全局中间件
可以使用app.use()连续定义多个全局中间件, 客户端在请求到达服务器之后, 会按照中间件定义的先后顺序依次进行调用,示例代码如下:
// 第一个全局中间件
app.use(function(req, res, next) {
console.log('调用了第1个中间件')
next()
})
// 第2个全局中间件
app.use(function(req, res, next) {
console.log('调用了第2个中间件')
next()
})
// 请求路由, 会依次调用上述的两个全局中间件
app.get('/user', (req, res) => {
res.send('Home page.')
})
局部生效的中间件
不使用app.use()定义的中间件, 叫做局部生效的中间件, 示例代码如下:
// 定义中间件函数mw1
const mw1 = function(req, res, next) {
console.log('这是中间件函数')
next()
}
// mw1这个中间件只在"当前路由中生效", 这种用法属于局部生效的中间件
app.get('/', mw1, function(req, res){
res.send('Home page.')
})
// mw1 这个中间件不会影响下面这个路由
app.get('/user', function(req, res){
res.send('user page.')
})
定义多个局部中间件
可以在路由中, 通过如下两种等价方式, 使用多个局部中间件:
// 以下两种写法是完全等价的, 可以根据自己的喜好, 选择任意一种方式
app.get('/', mw1, mw2, (req, res) => {res.send('home page') })
app.get('/', [mw1, mw2], (req, res) => {res.send('home page.')})
了解中间件的5个使用注意事项
- 一定要在路由之前注册中间件
- 客户端发送过来的请求, 可以连续调用多个中间件进行处理
- 执行完中间件的业务代码之后, 不要忘记调用next()函数
- 为了防止代码逻辑混乱, 调用next()函数后不要再写额外的代码
- 连续调用多个中间件时, 多个中间件之间, 共享req和res对象
中间件的分类
为了方便大家理解和记忆中间件的使用, Express官方把常见的中间件用法, 分成了5大类, 分别是:
- 应用级别的中间件
- 路由级别的中间件
- 错误级别的中间件
- Express内置的中间件
- 第三方的中间件
应用级别中间件
通过app.use()或app.get()或者app.post(), 绑定到app实例上的中间件, 叫做应用级别的中间件, 代码示例如下:
// 应用级别的中间件, (全局中间件)
app.use((req, res, next) => {
next()
})
// 应用级别中间件, (局部中间件)
app.get('/', mw1, (req, res) => {
res.send('home page.')
})
路由级别的中间件
绑定到express.Router()实例上的中间件, 叫做路由级别的中间件, 它的用法和应用级别中间件没有任何区别, 只不过, 应用级别中间件时绑定到app实例上, 路由级别中间件绑定到router实例上, 代码示例如下:
var app = express()
var router = express.Router()
// 路由级别的中间件
router.use(function(req, res, next) {
console.log('Tmie', Date.now())
next()
})
app.use('/', router)
错误级别的中间件
错误级别中间件的作用: 专门用来捕获整个项目中发生的异常错误, 从而防止项目异常崩溃的问题。
格式: 错误级别的中间件的function处理函数中,必须有4个形参, 形参顺序从前到后,分别是(err, req, res, next)。
// 路由
app.get('/', function(req, res) {
// 抛出一个自定义错误, 如果不定义错误中间价, 系统崩溃, 定义后会执行错误中间件
throw new Error('服务器内部发生了错误')
res.send('home page.')
})
// 错误级别中间件
app.use(function(err, req, res, next) {
// 在服务打印错误消息
console.log('发生了错误', err.message)
// 想客户端响应错误相关内容
res.send('Error!' + err.message)
})
注意:错误级别的中间件, 必须注册在所有路由之后!
Express内置的中间件
自Express 4.16.0版本开始, Express内置了3个常用的中间件, 极大的提高了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}))
第三方的中间件
非Express官方内置的,而是由第三方开发出来的中间件, 叫做第三方中间件, 在项目中, 大家可以按需下载并配置第三方中间件, 从而提高项目的开发效率
例如; 在express@4.16.0之前的版本中,经常使用body-parser这个第三方中间件, 来解析请求体数据。 使用步骤如下:
- 运行
npm install body-parser安装中间件 - 使用
require导入中间件 - 调用
app.use()注册并使用中间件
注意: Express内置的express.urlencoded中间件,就是基于body-parser这第三方中间件进一步封装出来的。
自定义中间件
需求描述和实现步骤
自己手动模拟一个类似于express.urlencoded这样的中间件, 来解析POST提交到服务器的表单的数据。
实现步骤
- 定义中间件
- 监听req 的data事件
- 监听req 的end事件
- 使用querystring模块解析请求提数据
- 将解析出来的数据对象挂载为req.body
- 将自定义中间件封装为模块
定义中间件
使用app.use()定义全局生效的中间件, 代码如下
app.use(funcion(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 模块解析请求体数据
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)
req.body = body
next()
})
将自定义的中间件封装为模块
为了优化代码的结构, 我们可以把自定义的中间函数, 封装为独立的模块, 示例代码如下:
const qs = require('querystring')
function bodyParser (req, res, next) {
}
// 向外到处解析请求体数据的中间件函数
module.exports = bodyParser
//--------------------分割线----------------------
const myBodyParser = require('custom-body-parser')
app.use(myBodyParser)
使用Express写接口
创建基本的服务器
// 导入 express模块
const express = require('express')
// 创建express的服务器实例
const app = express()
// write your code here
// 调用app.listen方法, 指定接口端口号并启动web服务器
app.listen(80, function() {
console.log('Express running at http://127.0.0.1')
})
创建API路由模块
// apiRouter.js 路由模块
const express = require('express')
const apiRouter = express.Router()
// TODO:
module.exports = apiRouter
// ------------------------------------
// app.js 导入并注册路由模块
const apiRouter = require('./apiRouter.js')
app.use('/api', apiRouter)
编写GET接口
apiRouter.get('/get', (req, res) => {
const query = req.query
res.send({
status: 0,
msg: 'GET请求成功',
data: query
})
})
编写POST接口
apiRouter.post('/post', (req, res) => {
const body = req.body
res.send({
status: 0,
msg: 'POST请求成功!',
data:body
})
})
CORS跨域资源共享
接口的跨域问题
解决接口跨域问题的方案主要有两种:
- CORS (主流的解决方案, 推荐使用)
- JSONP(有缺陷的解决方案, 只支持GET请求)
使用cors中间件解决跨域问题
cors是Express的一个第三方中间件, 通过安装和配置cors中间件, 可以很方便地解决跨域问题。 使用步骤分为如下3步:
- 运行npm install cors安装中间件
- 使用const cors = require('cors')导入中间件
- 在路由之前调用app.use(cors())配置中间件
什么是CORS
CORS由一系列HTTP响应头组成, 这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源。
浏览器的同源安全策略默认会阻止网页“跨域”获取资源, 但如果接口服务器配置了CORS相关的HTTP响应头, 就可以解决浏览器端的访问限制。
CORS的注意事项
- CORS主要在服务器端进行配置, 客户端浏览器无须做任何配置, 即可请求开启了CORS的接口。
- 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。 例如, 下面的字段值将只允许来自www.baidu.com的请求:
res.setHeader('Access-Control-Allow-Origin', 'http://www.baidu.com')
如果指定了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-With、With、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, Content-Type(只有三个值application/x-www-form-urlencoded, multipart/form-data, text/plain)
预检请求
只要符合以下任何一个条件的请求, 都需要进行预检请求:
- 请求方式为GET, POST, HEAD之外的请求method类型
- 请求头中包含自定义头部字段
- 向服务器发送了application/json格式的数据
在浏览器与服务器正式通信之前, 浏览器会发送OPTION请求进行预检, 以获知服务器是否允许该实际请求, 所以这一次的OPTION请求称为 “预检请求”。 服务器成功响应预检请求后, 才会发送真正的请求, 并且携带真实数据。
简单请求和预检请求的区别
简单请求的特点: 客户端与服务器之间只会发生一次请求 预检请求的特点: 客户端与服务器之间会发生两次请求, OPTION预检请求成功之后, 才会发起真正的请求。
JSONP接口
回顾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接口的步骤
- 获取客户端发送过来的回调函数的名字
- 得到要通过JSONP形式发送给客户端的数据
- 根据前两步得到的数据, 拼接出一个函数调用的字符串
- 把上一步拼接得到的字符串, 响应给客户端
实现JSONP接口的具体代码
app.get('/api/jsonp', (req, res) => {
// 1. 获取客户端发送过来的回调函数的名字
const functionName = req.query.callback
// 2. 得到要通过JSONP 形式发送给客户端的数据
const data = {name: 'zs', age: 22}
// 3. 根据前两步得到的数据, 拼接出一个函数调用的字符串
const scriptStr = `${functionName}(${JSON.stringify(data)})`
// 4. 把上一步拼接得到的字符串, 响应给客户端,<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)
}
})
})