目标
◆ 能够使用 express.static() 快速托管静态资源
◆ 能够使用 express 路由精简项目结构
◆ 能够使用常见的 express 中间件
◆ 能够使用 express 创建 API 接口
◆ 能够在 express 中启用 cors 跨域资源共享
拖拉到0606了 (;´༎ຶД༎ຶ`)
一、初识 Express
1.什么是 Express
官方给出的概念:Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架
。
通俗的理解:Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器
的。
Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法
。
🔗Express 的中文官网:4.17.1
2.进一步理解 Express
思考:不使用 Express 能否创建 Web 服务器?
答案:能,使用 Node.js 提供的原生 http 模块即可。
思考:既生瑜何生亮(有了 http 内置模块,为什么还有用 Express)?
答案:http 内置模块用起来很复杂,开发效率低;Express 是基于内置的 http 模块进一步封装出来的,能够极大的提高开发效率
。
思考:http 内置模块与 Express 是什么关系?
答案:类似于浏览器中 Web API 和 jQuery 的关系。后者是基于前者进一步封装出来的
3.Express 能做什么
对于前端程序员来说,最常见的两种服务器,分别是:
⚫ Web 网站服务器:专门对外提供 Web 网页资源的服务器。
⚫ API 接口服务器:专门对外提供 API 接口的服务器。
使用 Express,我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器
4.Express 的基本使用
4.1安装
在项目所处的目录中,运行如下的终端命令,即可将 express 安装到项目中使用:
4.2创建基本的 Web 服务器
4.3监听 GET 请求
通过 app.get() 方法,可以监听客户端的 GET 请求,具体的语法格式如下:
4.4 监听 POST 请求
通过 app.post() 方法,可以监听客户端的 POST 请求,具体的语法格式如下:
4.5把内容响应给客户端
通过 res.send() 方法,可以把处理好的内容,发送给客户端:
4.6获取 URL 中携带的查询参数
通过 req.query
对象,可以访问到客户端通过查询字符串
的形式,发送到服务器的参数:
4.7获取 URL 中的动态参数
通过 req.params 对象,可以访问到 URL 中,通过 : 匹配到的动态参数:
4.8总结代码
// 导入express
const express = require('express')
// 创建web服务器
const app = express()
// 挂载路由 监听客户端的请求并向客户端响应具体的内容
app.get('/', (req, res) => {
res.send('hello world.')
})
app.post('/', (req, res) => {
res.send('Post Request.')
})
// 调用app.listen 启动服务器
app.listen(80, () => {
console.log('http://127.0.0.1')
})
5.托管静态资源
5.1express.static()
express 提供了一个非常好用的函数,叫做 express.static(),通过它,我们可以非常方便地创建一个静态资源服务器
例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:
app.use(express.static('public'))
注意:Express 在指定的
静态目录中查找文件,并对外提供资源的访问路径。
因此,存放静态文件的目录名不会出现在 URL 中
。
const express = require('express')
const app = express()
// 在这里,调用 express.static() 方法,快速的对外提供静态资源
app.use('/files', express.static('./files'))
//根据添加顺序访问文件
app.use(express.static('./clock'))
app.listen(80, () => {
console.log('express server running at http://127.0.0.1')
})
5.2托管多个静态资源目录
如果要托管多个静态资源目录,请多次调用 express.static() 函数:
5.3挂载路径前缀
如果希望在托管的静态资源访问路径之前,挂载路径前缀
,则可以使用如下的方式:
二、nodemon
1.为什么要使用 nodemon
在编写调试 Node.js 项目的时候,如果修改了项目的代码,则需要频繁的手动 close 掉,然后再重新启动,非常繁琐。
🔗现在,我们可以使用 nodemon 这个工具
它能够监听项目文件的变动,当代码被修改后,nodemon 会自动帮我们重启项目
,极大方便了开发和调试
。
2. 安装 nodemon
在终端中,运行如下命令,即可将 nodemon 安装为全局可用的工具:
node i -g nodemon
3.使用 nodemon
当基于 Node.js 编写了一个网站应用的时候,传统的方式
,是运行 node app.js 命令,来启动项目。
这样做的坏处是:代码被修改之后,需要手动重启
项目。
现在,我们可以将 node 命令替换为 nodemon 命令
,使用 nodemon app.js 来启动项目
。
这样做的好处是:代码被修改之后,会被 nodemon 监听到,从而实现自动重启项目
的效果。
4.nodemon报错解决方案
原因:
笔记本禁止运行脚本
解决办法:
1.找到笔记本中的powerShell,右键以管理员身份打开
2.输入set-ExecutionPolicy RemoteSigned
三、Express 路由
1.路由就是映射关系、
2.生活中的路由
3.Express 中的路由
路由指的是客户端的请求与服务器处理函数
之间的映射关系。
Express 中的路由分 3 部分组成,分别是请求的类型、请求的 URL 地址、处理函数
4. Express 中的路由的例子
5.路由的匹配过程
每当一个请求到达服务器之后,需要先经过路由的匹配
,只有匹配成功之后,才会调用对应的处理函数。
在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的 URL 同时匹配成功
,则 Express 会将这次请求,转交给对应的 function 函数进行处理。
6. 路由的使用
6.1 最简单的用法
在 Express 中使用路由最简单的方式,就是把路由挂载到 app
上,示例代码如下:
6.2模块化
路由
为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块
。
将路由抽离为单独模块的步骤如下:
① 创建路由模块对应的 .js 文件
② 调用 express.Router()
函数创建路由对象
③ 向路由对象上挂载具体的路由
④ 使用 module.exports
向外共享路由对象
⑤ 使用 app.use()
函数注册路由模块
// 这是路由模块
// 1. 导入 express
const express = require('express')
// 2. 创建路由对象
const router = express.Router()
// 3. 挂载具体的路由
router.get('/user/list', (req, res) => {
res.send('Get user list.')
})
router.post('/user/add', (req, res) => {
// 向客户端响应文本消息
res.send('Add new user.')
})
// 4. 向外导出路由对象
module.exports = router
// 1. 导入路由模块
const router = require('./03.router')
// 2. 注册路由模块
app.use('/api', router)
app.use()函数作用:注册全局中间件
四、Express 中间件
1.特指业务流程的中间处理环节
2.Express 中间件的调用流程
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理
3.Express 中间件的格式
Express 的中间件,本质上就是一个 function 处理函数,Express 中间件的格式如下:
4.next 函数
是实现多个中间件连续调用的关键,它表示把流转关系转交
给下一个中间件或路由。
5.定义中间件
// // 定义一个最简单的中间件函数
// const mw = function (req, res, next) {
// console.log('这是最简单的中间件函数')
// // 把流转关系,转交给下一个中间件或路由
// next()
// }
// // 将 mw 注册为全局生效的中间件
// app.use(mw)
// 这是定义全局中间件的简化形式
app.use((req, res, next) => {
console.log('这是最简单的中间件函数')
next()
})
6.中间件的作用
多个中间件之间,共享同一份 req 和 res
。基于这样的特性,我们可以在上游的中间件中,统一
为 req 或 res 对象添加自定义的属性或方法,供下游
的中间件或路由进行使用。
7.定义多个全局中间件
可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行。
8.局部生效的中间件
不使用
app.use() 定义的中间件,叫做局部生效的中间件.
9. 定义多个局部中间件
可以在路由中,通过如下两种等价的方式,使用多个局部中间件:
10.了解中间件的5个使用注意事项
① 一定要在路由之前
注册中间件
app.use;注册中间件
app.get定义路由器
② 客户端发送过来的请求,可以连续调用多个中间件
进行处理
③ 执行完中间件的业务代码之后,不要忘记调用 next() 函数
④ 为了防止代码逻辑混乱
,调用 next() 函数后不要再写额外的代码
⑤ 连续调用多个中间件时,多个中间件之间,共享
req 和 res 对象
11.Express中间件的分类(5类)
为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是
11.1应用级别的中间件
通过 app.use() 或 app.get() 或 app.post() ,绑定到 app 实例上的中间件
,叫做应用级别的中间件
11.2路由级别的中间件
绑定到 express.Router()
实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上
11.3 错误级别的中间件
作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。
格式:错误级别中间件的 function 处理函数中,必须有 4
个形参,形参顺序从前到后,分别是 (err, req, res, next)。
注意:错误级别的中间件,必须注册在所有路由之后
11.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+ 版本中可
// 导入 express 模块
const express = require('express')
// 创建 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 方法,指定端口号并启动web服务器
app.listen(80, function () {
console.log('Express server running at http://127.0.0.1')
})
11.5第三方的中间件
在 express@4.16.0 之前的版本中,经常使用 body-parser
这个第三方中间件,来解析请求体数据。
使用步骤如下:
① 运行 npm install body-parser 安装中间件
② 使用 require 导入中间件
③ 调用 app.use() 注册并使用中间件
注意:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 这个第三方中间件进一步封装出来的。
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 1. 导入解析表单数据的中间件 body-parser
const parser = require('body-parser')
// 2. 使用 app.use() 注册中间件
app.use(parser.urlencoded({ extended: false }))
// app.use(express.urlencoded({ extended: false }))
app.post('/user', (req, res) => {
// 如果没有配置任何解析表单数据的中间件,则 req.body 默认等于 undefined
console.log(req.body)
res.send('ok')
})
// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
console.log('Express server running at http://127.0.0.1')
})
12.自定义中间件[没看]
13.使用express写接口
注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件
app.use(express.urlencoded({ extended: false }))
五、CORS 跨域资源共享
1.接口的跨域问题
刚才编写的 GET 和 POST接口,存在一个很严重的问题:不支持跨域请求
。
解决接口跨域问题的方案主要有两种:
① CORS(主流的解决方案,推荐使用)
② JSONP(有缺陷的解决方案:只支持 GET 请求
2.使用 cors 中间件解决跨域问题
cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。
使用步骤分为如下 3 步:
① 运行 npm install cors 安装
中间件
② 使用 const cors = require(‘cors’) 导入
中间件
③ 在路由之前调用 app.use(cors()) 配置
中间件
3.什么是 CORS
CORS (Cross-Origin Resource Sharing,跨域资源共享)由一系列 HTTP 响应头
组成,这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源
。
浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头
,就可以解除浏览器端的跨域访问限制
4.CORS 跨域资源共享的注意事项
① CORS 主要在服务器端
进行配置。客户端浏览器无须做任何额外的配置
,即可请求开启了 CORS 的接口。
② CORS 在浏览器中有兼容性
。只有支持XMLHttpRequest Level2
的浏览器,才能正常访问开启了 CORS 的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)
5.CORS 响应头部 - Access-Control-Allow-Origin
响应头部中可以携带一个 Access-Control-Allow-Origin
字段
6.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
对额外的请求头进行声明
,否则这次请求会失败!
7.CORS 响应头部 - Access-Control-Allow-Methods
默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求。
如果客户端希望通过 PUT、DELETE
等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法
。
8.CORS请求的分类
客户端在请求 CORS 接口时,根据请求方式和请求头的不同,可以将 CORS 的请求分为两大类,分别是:
-
(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) -
(2)预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求:
① 请求方式为GET、POST、HEAD 之外的请求 Method 类型
② 请求头中包含自定义头部字段
③ 向服务器发送了application/json 格式
的数据
在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据
8.1简单请求和预检请求的区别
简单请求的特点:客户端与服务器之间只会发生一次请求。
预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求
9.JSONP
概念:浏览器端通过 <script> 标签的 src 属性
,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP。
特点:
① JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。
② JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求
9.1 创建 JSONP 接口的注意事项
如果项目中已经配置了 CORS 跨域资源
共享,为了防止冲突
,必须在配置 CORS 中间件之前声明 JSONP 的接口
。否则JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下:
220616完善博客