一、初识 express
1. 什么是 express
官方给出的概念:基于 Node.js 平台,快速、开放、极简的 Web 开发框架。
通俗的理解:Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器的。
Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。
-
不使用 Express 能否创建 Web 服务器?
答案:能,使用 Node.js 提供的原生 http 模块即可。
-
既生瑜何生亮(有了 http 内置模块,为什么还有用 Express)?
答案:http 内置模块用起来很复杂,开发效率低;Express 是基于内置的 http 模块进一步封装出来的,能够极大的提高开发效率。
-
http 内置模块与 Express 是什么关系?
答案:类似于浏览器中 Web API 和 jQuery 的关系。后者是基于前者进一步封装出来的。
2. 能做什么?
使用 Express,我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。
- Web 网站服务器:专门对外提供 Web 网页资源的服务器。
- API 接口服务器:专门对外提供 API 接口的服务器。
3. 基本使用
3.1. 安装
在项目所处的目录中,运行如下的终端命令,即可将 express 安装到项目中使用:
npm i express@4.7.1
3.2. 创建基本的 Web 服务器
// 1. 导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()
// 3. 启动服务器
app.listen(80)
3.3. 监听请求
通过 app.请求类型
监听
监听 GET 请求
app.get('请求URL', (req, res) => { /* 处理函数 */ })
监听 POST 请求
app.post('请求URL', (req, res) => { /* 处理函数 */ })
3.4. 响应内容
通过 res.send()
方法,可以把处理好的内容,发送给客户端:
app.get('/abc', (req, res) => {
// 向客户端发送 JSON 对象,也可以发送其他任意内容
res.send({id: 1, name: '张三'})
})
3.5. 获取 URL 中携带的查询参数
通过 req.query
对象,可以获取到客户端使用 查询字符串 的形式发送到服务器的参数,即 URL 中 ?
后的参数。
app.get('/ls', (req, res) => {
// 客户端使用 ?name=xxx&age=18 这种查询字符串形式时,可以通过 req.query 对象获取到
const {
name = '李四',
age = 18
} = req.query || {}
res.send(`我的名字是${name},我今年${age}岁啦`)
})
3.6. 获取 URL 中的动态参数
通过 req.params
对象,可以访问到 URL 中通过 :
匹配到的动态参数,如 /detail/:id
中的 :id
即表示名为 id
的动态参数
app.get('/detail/:id', (req, res) => {
const {id} = req.params
res.send(`当前详情数据的 id 为 ${id}`)
})
4. 托管静态资源
4.1. express.static()
express 提供了一个非常好用的函数,叫做 express.static()
,通过它,我们可以非常方便地创建 一个静态资源服务器 ,例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:
const express = require('express')
const app = express()
// 静态资源目录 public
app.use(express.static('public'))
访问静态资源
http://127.0.0.1/images/1.png
http://127.0.0.1/css/index.css
注意
express
在指定的静态目录中查找文件,并对外提供资源的访问路径,因此存放静态文件的目录名不会出现在 URL 中。
4.2. 托管多个静态资源目录
如果要托管多个静态资源目录,请多次调用 express.static() 函数:
app.use(express.static('public'))
app.use(express.static('files'))
访问静态资源文件时,express.static()
函数会根据目录的添加顺序查找所需的文件。
4.3. 挂载路径前缀
如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下的方式:
app.use('/public', express.static('public'))
现在,你就可以通过带有 /public
前缀地址来访问 public 目录中的文件了:
http://127.0.0.1/public/images/1.png
http://127.0.0.1/public/css/index.css
二、路由
1. 路由的概念
1.1. 什么是路由
广义上来讲,路由就是映射关系。在 Express 中,路由指的是 客户端的请求 与 服务器处理 函数之间的 映射关系
。
Express 中的路由分 3 部分组成,分别是 请求的类型
、请求的URL地址
、处理函数
,格式如下:
app.METHOD(PATH, HANDLER)
1.2. 路由的匹配过程
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数。
在匹配时,会按照路由的顺序进行匹配,如果 请求类型
和 请求的URL
同时匹配成功,则 Express 会将这次请求,转交给对应的 function 函数进行处理。
2. 路由的使用
2.1. 最简单的用法
在 Express 中使用路由最简单的方式,就是把路由挂载到 app 上,示例代码如下:
const express = require('express')
const app = express()
app.get('/', (req, res) => {
res.send(`Hello World.`)
})
app.post('/', (req, res) => {
res.send({id: 1, name: '张三'})
})
app.listen(80, () => {
console.log('服务已启动')
})
2.2. 模块化路由
为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块。
将路由抽离为单独模块的步骤如下:
- 创建路由模块对应的 .js 文件
- 调用
express.Router()
函数创建路由对象 - 向路由对象上挂载具体的路由
- 使用
module.exports
向外共享路由对象 - 使用
app.use()
函数注册路由模块
// router/user.js
const express = require('express')
const router = express.Router()
router.get('/user/list', (req, res) => {
res.send('用户列表')
})
router.post('/user/add', (req, res) => {
res.send('添加用户')
})
module.exports = router
// app.js
const express = require('express')
// 导入用户路由模块
const userRouter = require('./router/user')
const app = express()
// 注册路由模块
app.use(userRouter)
app.listen(80)
23. 为路由模块添加前缀
类似于托管静态资源时,为静态资源统一挂载访问前缀一样,路由模块添加前缀的方式也非常简单:
// 使用 app.use() 注册路由模块,并添加统一的访问前缀 /api
app.use('/api', userRouter)
三、中间件
1. 中间件的概念
1.1. 什么是中间件?
中间件(Middleware),特指业务流程的 中间处理环节。
1.2. 现实生活中的例子
在处理污水的时候,一般都要经过三个处理环节,从而保证处理过后的废水,达到排放标准。
处理污水的这三个中间处理环节,就可以叫做中间件。
1.3. 中间件的调用流程
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。
1.4. 中间件的格式
本质上就是一个 function
处理函数,Express 中间件的格式如下:
app.get('/', (req, res, next) => {
next()
})
app.get('/', (req, res) => {
res.send('响应内容')
})
注意:中间件函数的形参列表中,必须包含 next 参数。而路由处理函数中只包含 req 和 res。
1.5. next 函数的作用
next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
1.6. 中间件的作用
多个中间件之间,共享同一份 req 和 res。基于这样的特性,我们可以在上游的中间件中,统一为 req 或 res 对象添加自定义的属性或方法,供下游的中间件或路由进行使用。
2. 全局中间件
客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件。
const express = require('express')
const app = express()
app.use((req, res, next) => {
console.log('第1个全局中间件')
next()
})
app.use((req, res, next) => {
console.log('第2个全局中间件')
next()
})
app.use((req, res, next) => {
console.log('第3个全局中间件')
next()
})
3. 局部中间件
不使用 app.use()
定义的中间件,叫做局部生效的中间件,示例代码如下:
const express = require('express')
const app = express()
// 定义中间件函数
const mw1 = (req, res, next) => {
console.log('第1个局部中间件')
next()
}
const mw2 = (req, res, next) => {
console.log('第2个局部中间件')
next()
}
// 两种定义局部中间件的方式
app.get('/index', mw1, mw2, (req, res) => res.send('第一种写法'))
app.post('/index', [mw1, mw2], (req, res) => res.send('第二种写法'))
app.listen(80)
4. 中间件的分类
为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是:
- 应用级别 的中间件
- 路由级别 的中间件
- 错误级别 的中间件
- Express内置 的中间件
- 第三方 的中间件
4.1. 应用级别的中间件
通过 app.use()
或 app.get()
或 app.post()
,绑定到 app 实例上的中间件,叫做应用级别的中间件,代码示例如下:
const express = require('express')
const app = express()
const mw1 = (req, res, next) => {
console.log('局部中间件')
next()
}
app.use((req, res, next) => {
console.log('全局中间件')
next()
})
app.get('/', mw1, (req, res) => {
res.send('响应内容')
})
app.listen(80)
4.2. 路由级别的中间件
绑定到 express.Router()
实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上,代码示例如下
const express = require('express')
const router = express.Router()
router.use((req, res, next) => {
console.log('路由中间件')
next()
})
router.get('/user/list', (req, res) => {
res.send('用户列表')
})
router.post('/user/add', (req, res) => {
res.send('添加用户')
})
module.exports = router
4.3. 错误级别的中间件
错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。
格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是 (err, req, res, next)。
const express = require('express')
const app = express()
app.get('/', (req, res) => {
throw new Error('服务器内部发生了错误!')
res.send('Home page.')
})
// 定义错误级别的中间件,捕获整个项目的异常错误,从而防止程序的崩溃
app.use((err, req, res, next) => {
console.log('发生了错误!' + err.message)
res.send('Error:' + err.message)
})
app.listen(80)
4.4. 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+ 版本中可用)
app.use(express.json())
app.use(express.urlencoded({ extended: false }))
4.5. 第三方中间件
非 Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。
四、CORS 跨域资源共享
1. 跨域的原因
- 跨域是是因为浏览器的
同源策略
限制,是 浏览器 的一种安全机制,服务端之间是不存在跨域的。 - 所谓同源指的是两个页面具有相同的
协议
、主机
和端口
,三者有任一不相同即会产生跨域。
2. 什么是 CORS ?
CORS (Cross-Origin Resource Sharing,跨域资源共享)由一系列 HTTP 响应头组成,这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源。
浏览器的同源安全策略默认会阻止网页跨域获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头,就可以解除浏览器端的跨域访问限制。
3. 使用 cors 中间件解决跨域问题
cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。
- 安装中间件:
npm install cors
- 导入中间件:
const cors = require('cors')
- 配置中间件:
app.use(cors())
4. CORS 的注意事项
- CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。
- CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口
5. CORS 常见响应头
5.1. 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', '*')
5.2. 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、Custom-Header 请求头
// 注意:多个请求头之间需使用英文逗号隔开
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Custom-Header')
5.3. Access-Control-Allow-Methods
默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求。
如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods
来指明实际请求所允许使用的 HTTP 方法。
// 只允许 POST, GET, DELETE, HEAD 请求方法
res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD')
// 允许所有的 HTTP 请求方法
res.setHEader('Access-Control-Allow-Methods', '*')
6. 请求分类
6.1. 简单请求
同时满足以下两大条件的请求,就属于简单请求:
- 请求方式: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)
6.2. 预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求:
- 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
- 请求头中包含自定义头部字段
- 向服务器发送了 application/json 格式的数据
在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据
6.3. 简单请求和预检请求的区别
简单请求的特点:客户端与服务器之间只会 发生一次请求
。
预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求。