目录
初识 Express
1.1 Express 简介
1. 什么是 Express
官方给出的概念:Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架。 通俗的理解:Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器的。 Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。
Express 的中文官网: http://www.expressjs.com.cn/
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 接口的服务器。
1.2 Express 的基本使用
1. 安装 在项目所处的目录中,运行如下的终端命令,即可将 express 安装到项目中使用:
2. 创建基本的 Web 服务器
3. 监听 GET 请求 通过 app.get() 方法,可以监听客户端的 GET 请求,具体的语法格式如下:
4. 监听 POST 请求 通过 app.post() 方法,可以监听客户端的 POST 请求 具体的语法格式如下:
5. 把内容响应给客户端
通过 res.send() 方法,可以把处理好的内容,发送给客户端:
6. 获取 URL 中携带的查询参数
通过 req.query 对象,可以访问到客户端通过查询字符串的形式,发送到服务器的参数:
7. 获取 URL 中的动态参数
通过 req.params 对象,可以访问到 URL 中,通过 : 匹配到的动态参数:
//1.导入express
const express = require('express')
//2.创建web服务器
const app = express()
//3.监听客户端的 GTE 和POST 请求,并向客户端响应具体的内容
app.get('/user', (req, res) => {
//调用express 提供的res.send()方法 向客户端响应一个 json对象
res.send({ name: 'zs', age: 18 })
})
app.post('/user', (req, res) => {
//调用express 提供的res.send()方法 向客户端响应一个 文本字符串
res.send('请求成功')
})
//5.启动web服务器
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
// 6. 获取 URL 中携带的查询参数
app.get('/', (req, res) => {
//通过req.query可以获取到客户端发送的 查询参数
//注意:默认情况下 req.query是一个空对象
console.log(req.query);
res.send(req.query)
})
//这里的:id是一个动态参数
app.get('/user/:id', (res, req) => {
// req.params 是动态匹配的url参数,默认也是一个空对象
console.log(res.params);
req.send(res.params)
})
1.3 托管静态资源
express 提供了一个非常好用的函数,叫做 express.static(),通过它,我们可以非常方便地创建一个静态资源服务器,例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:
2. 托管多个静态资源目录 如果要托管多个静态资源目录,请多次调用 express.static() 函数:
访问静态资源文件时,express.static() 函数会根据目录的添加顺序查找所需的文件。
3. 挂载路径前缀
如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下的方式:
const express = require('express')
const app = express()
//在这里,调用express.static()方法 快速的对外提供静态资源
app.use('/abc', express.static('./files'))
app.use(express.static('./clock'))
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
1.4 nodemon
1. 为什么要使用 nodemon
在编写调试 Node.js 项目的时候,如果修改了项目的代码,则需要频繁的手动 close 掉,然后再重新启动,非常繁琐。 现在,我们可以使用 nodemo(https://www.npmjs.com/package/nodemon) 这个工具,它能够监听项目文件的变动,当代码被修改后,nodemon 会自动帮我们重启项目,极大方便了开发和调试。
2. 安装 nodemon 在终端中,运行如下命令,即可将 nodemon 安装为全局可用的工具:
3. 使用 nodemon
当基于 Node.js 编写了一个网站应用的时候,传统的方式,是运行 node app.js 命令,来启动项目。这样做的坏处是:代码被修改之后,需要手动重启项目。
现在,我们可以将 node 命令替换为 nodemon 命令,使用 nodemon app.js 来启动项目。这样做的好处是:代码被修改之后,会被 nodemon 监听到,从而实现自动重启项目的效果。
2.Express 路由
2.1 路由的概念
1. 什么是路由 广义上来讲,路由就是映射关系。
2. 现实生活中的路由
3. Express 中的路由
在 Express 中,路由指的是客户端的请求与服务器处理函数之间的映射关系。
Express 中的路由分 3 部分组成,分别是请求的类型、请求的 URL 地址、处理函数,格式如下:
4. Express 中的路由的例子
5. 路由的匹配过程
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数。 在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的 URL 同时匹配成功,则 Express 会将这次请求,转交给对应的 function 函数进行处理。
2.2 路由的使用
1. 最简单的用法 Express 中使用路由最简单的方式,就是把路由挂载到 app 上,示例代码如下:
2. 模块化路由
为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块。 将路由抽离为单独模块的步骤如下:
- 创建路由模块对应的 .js 文件
- 调用 express.Router() 函数创建路由对象
- 向路由对象上挂载具体的路由
- 使用 module.exports 向外共享路由对象
- 使用 app.use() 函数注册路由模块
3. 创建路由模块
4. 注册路由模块
5. 为路由模块添加前缀
类似于托管静态资源时,为静态资源统一挂载访问前缀一样 ,由模块添加前缀的方式也非常简单:
const express = require('express')
const app = express()
//导入路由模块
const router = require('./router')
// app.use(express.static)
app.use('/api', router)// 注意app.use的作用就是来注册全局中间件
//注册路由模块
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
3. Express 中间件
3.1 中间件的概念
1. 什么是中间件 中间件(Middleware ),特指业务流程的中间处理环节。
2. 现实生活中的例子
在处理污水的时候,一般都要经过三个处理环节,从而保证处理过后的废水,达到排放标准。处理污水的这三个中间处理环节,就可以叫做中间件。
3. Express 中间件的调用流程
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件 从而对这次请求进行预处理。
4. Express 中间件的格式
Express 的中间件,本质上就是一个 function 处理函数,Express 中间件的格式如下:
注意:中间件函数的形参列表中,必须包含 next 参数。而路由处理函数中只包含 req 和 res。
5. next 函数的作用
next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
3.2 Express 中间件的初体验
1. 定义中间件函数 可以通过如下的方式,定义一个最简单的中间件函数:
2. 全局生效的中间件
客户端发起的任何请求,到达服务器之后,都会触发的中间件,
叫做全局生效的中间件。 通过调用 app.use(中间件函数),即可定义一个全局生效的中间件,示例代码如下
3. 定义全局中间件的简化形式
const express = require('express')
const app = express()
// //定义一个中间件函数
// const mw = function (res, req, next) {
// console.log('这是最简单的中间件函数');
// //把流转关系,转交给下一个中间件路由
// next()
// }
// //把mw注册为全局生效的中间件
// app.use(mw)
//这是定义全局中间件的简化形式
app.use(function (res, req, next) {
console.log('这是最简单的中间件函数');
//把流转关系,转交给下一个中间件路由
next()
})
app.get('/', (req, res) => {
console.log('调用了/这个路由');
res.send('Home page')
})
app.get('/user', (req, res) => {
console.log('调用了/user这个路由');
res.send('user page')
})
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
4. 中间件的作用
多个中间件之间,共享同一份 req 和 res。基于这样的特性,我们可以在上游的中间件中,统一为 req 或 res 对象添加自定义的属性或方法,供下游的中间件或路由进行使用。
5. 定义多个全局中间件
可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用,示例代码如下:
6. 局部生效的中间件 不使用 app.use() 定义的中间件,叫做局部生效的中间件,示例代码如下
7. 定义多个局部中间件 可以在路由中,通过如下两种等价的方式,使用多个局部中间件:
8. 了解中间件的5个使用注意事项
- 一定要在路由之前注册中间件
- 客户端发送过来的请求,可以连续调用多个中间件进行处理
- 执行完中间件的业务代码之后,不要忘记调用 next() 函数
- 为了防止代码逻辑混乱,调用 next() 函数后不要再写额外的代码
- 连续调用多个中间件时,多个中间件之间,共享 req 和 res 对象
const express = require('express')
const app = express()
app.use(function (res, req, next) {
//获取请求到达服务器的实际时间
const time = Date.now()
// 为req对象挂载自定义属性,从而把时间共享给后面所有的路由
req.statrTime = time
console.log('调用了第一个');
next()
})
app.use(function (res, req, next) {
//获取请求到达服务器的实际时间
const time = Date.now()
// 为req对象挂载自定义属性,从而把时间共享给后面所有的路由
req.statrTime = time
console.log('调用了第二个');
next()
})
app.get('/', (req, res) => {
res.send('Home page' + req.statrTime)
})
app.get('/user', (req, res) => {
res.send('user page' + req.statrTime)
})
const mw1 = (function (res, req, next) {
console.log('局部中间件1');
next()
})
const mw2 = (function (res, req, next) {
console.log('局部中间件2');
next()
})
//局部中间件可以是个数组
app.get('/order', mw1, mw2, (req, res) => {
res.send('user page')
})
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
3.3 中间件的分类
为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是:
- 应用级别的中间件
- 路由级别的中间件
- 错误级别的中间件
- Express 内置的中间件
- 第三方的中间件
1. 应用级别的中间件
通过 app.use() 或 app.get() 或 app.post() ,绑定到 app 实例上的中间件,叫做应用级别的中间件,代码示例如下:
2. 路由级别的中间件
绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上,代码示例如下:
3. 错误级别的中间件
错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。 格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是 (err, req, res, next)。
错误级别中间件的 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, () => {
console.log('express server runing at http://127.0.0.1');
})
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+ 版本中可用)
const express = require('express')
const app = express()
//除了错误级别的中间件,其他的中间件,必须在路由之前进行配置
//通过express.json()这个中间件来解析表单中的json格式的数据
app.use(express.json())
//通过express.urlencoded()这个中间件来解析表单中的urlencoded格式的数据
app.use(express.urlencoded({ extended: false }))
app.post('/', (req, res) => {
//在服务器可以使用req,body这个属性来接收客户端发送过来的请求体数据
//默认情况下,如果不配置表单数据的中间件,则req.body默认 等于undefined
console.log(req.body);
res.send('home page')
})
app.post('/book', (req, res) => {
//在服务器可以使用req,body来获取json格式的表单数据url-encoded格式数据
console.log(req.body);
res.send('book page')
})
5. 第三方的中间件
非 Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。
例如:在 express@4.16.0 之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:
- 运行 npm install body-parser 安装中间件
- 使用 require 导入中间件
- 调用 app.use() 注册并使用中间件
注意:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 这个第三方中间件进一步封装出来的。
const express = require('express')
const app = express()
//导入解析表单数据的中间件 body-parser
const parser = require('body-parser')
const { urlencoded } = require('body-parser')
// 使用app.use注册中间件
app.use(parser.urlencoded({ extended: false }))
app.post('/', (req, res) => {
//默认情况下,如果不配置表单数据的中间件,则req.body默认 等于undefined
console.log(req.body);
res.send('home page')
})
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
3.4 自定义中间件
1. 需求描述与实现步骤
- 定义中间件
- 监听 req 的 data 事件
- 监听 req 的 end 事件
- 使用 querystring 模块解析请求体数据
- 将解析出来的数据对象挂载为 req.body
- 将自定义中间件封装为模块
2. 定义中间件
使用 app.use() 来定义全局生效的中间件,代码如下
3. 监听 req 的 data 事件
4. 监听 req 的 end 事件
当请求体数据接收完毕之后,会自动触发 req 的 end 事件。 因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。示例代码如下:
5. 使用 querystring 模块解析请求体数据
Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse() 函数,可以轻松把查询字符串,解析成对象的格式。示例代码如下
6. 将解析出来的数据对象挂载为 req.body
7. 将自定义中间件封装为模块
为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块,示例代码如下:
//导入express
const express = require('express')
//导入 node.js 内置的queryString模块
const qs = require('querystring')
//创建web服务器
const app = express()
//这是解析表单数据的中间件
app.use((req, res, next) => {
//定义中间件具体的业务逻辑
//定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
// 监听req的data事件
req.on('data', (chunk) => {
str += chunk
})
// 监听req的end事件
req.on('end', () => {
// 在 str 中存放的就是完整的请求体数据
const body = qs.parse(str)
console.log(body);
req.body = body
next()
})
})
app.post('/', (req, res) => {
res.send(req.body)
})
//启动web服务器
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
4. 使用 Express 写接口
4.1 创建基本的服务器
4.2 创建 API 路由模块
4.3 编写 GET 接口
4.4 编写 POST 接口
注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件 app.use(express.urlencoded({ extended: false }))
4.5 CORS 跨域资源共享
1. 接口的跨域问题
- ① CORS(主流的解决方案,推荐使用)
- ② JSONP(有缺陷的解决方案:只支持 GET 请求)
2. 使用 cors 中间件解决跨域问题
- ① 运行 npm install cors 安装中间件
- ② 使用 const cors = require('cors') 导入中间件
- ③ 在路由之前调用 app.use(cors()) 配置中间件
- ① CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。
- ② CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服 务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。
5. CORS 响应头部 - Access-Control-Allow-Origin
7. CORS 响应头部 - Access-Control-Allow-Methods
- ① 简单请求
- ② 预检请求
9. 简单请求
- ① 请求方式:GET、POST、HEAD 三者之一
- ② HTTP 头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、 Downlink、Save-Data、Viewport-Width、Width 、Content-Type(只有三个值application/x-www-formurlencoded、multipart/form-data、text/plain)
10. 预检请求
- ① 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
- ② 请求头中包含自定义头部字段
- ③ 向服务器发送了 application/json 格式的数据
- 简单请求的特点:客户端与服务器之间只会发生一次请求。
- 预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求。
4.6 JSONP 接口
1. 回顾 JSONP 的概念与特点
- ① JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。
- ② JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求。
2. 创建 JSONP 接口的注意事项
3. 实现 JSONP 接口的步骤
- ① 获取客户端发送过来的回调函数的名字
- ② 得到要通过 JSONP 形式发送给客户端的数据
- ③ 根据前两步得到的数据,拼接出一个函数调用的字符串
- ④ 把上一步拼接得到的字符串,响应给客户端的 <script> 标签进行解析执行
5. 在网页中使用 jQuery 发起 JSONP 请求
调用 $.ajax() 函数,提供 JSONP 的配置选项,从而发起 JSONP 请求,示例代码如下:
//导入express
const express = require('express')
//创建web服务器
const app = express()
//必须在配置cros之前,配置jsonp接口
app.get('/api/jsonp', (req, res) => {
//① 获取客户端发送过来的回调函数的名字
const funcName = req.query.callback
// ② 得到要通过 JSONP 形式发送给客户端的数据
const data = { name: 'zs', age: 18 }
// ③ 根据前两步得到的数据,拼接出一个函数调用的字符串
const scriptStr = `${funcName}(${JSON.stringify(data)})`
// ④ 把上一步拼接得到的字符串,响应给客户端的 <script> 标签进行解析执行
res.send(scriptStr)
})
//在路由之前,配置cors这个中间件,从而解决接口跨域问题
const cors = require('cors')
app.use(cors())
//导入路由模块
const router = require('./apirouter')
const { json } = require('body-parser')
//配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))
//把路由模块注册到app上
app.use('/api', router)
//启动web服务器
app.listen(80, () => {
console.log('express server runing at http://127.0.0.1');
})
const express = require('express')
const router = express.Router()
//挂载对应的路由
router.get('/get', (req, res) => {
//通过req.query,获取客户端通过查询字符串,发送到服务器的数据
const query = req.query
//通过res.send()向客户端响应处理的结果
res.send({
status: 0,//0 表示成功 1表示失败
msg: 'GET 请求成功',//状态描述
data: query//需要响应给客户端的数据
})
})
router.post('/post', (req, res) => {
//通过req.body,获取客户端请求主体,发送到服务器的数据
const body = req.body
//通过res.send()向客户端响应处理的结果
res.send({
status: 0,//0 表示成功 1表示失败
msg: 'POST 请求成功',//状态描述
data: body //需要响应给客户端的数据
})
})
module.exports = router
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<script src="https://cdn.staticfile.org/jquery/1.10.0/jquery.min.js"> </script>
</head>
<body>
<button id="get">get</button>
<button id="post">post</button>
<button id="jsonp">jsonp</button>
</body>
<script>
$(function () {
//测试get接口
$('#get').on('click', function () {
$.ajax({
type: 'GET',
url: 'http://127.0.0.1/api/get',
data: { name: 'zs', age: 18 },
success: function (res) {
console.log(res);
}
})
})
$('#post').on('click', function () {
$.ajax({
type: 'POST',
url: 'http://127.0.0.1/api/post',
data: { bookname: '水浒传', author: '施耐庵' },
success: function (res) {
console.log(res);
}
})
})
$('#jsonp').on('click', function () {
$.ajax({
type: 'GET',
url: 'http://127.0.0.1/api/jsonp',
dataType: 'jsonp',
success: function (res) {
console.log(res);
}
})
})
})
</script>
</html>