Express与中间件
一、简述
Express 是基于Node.js平台,快速、开放、极简的Web开发框架。
Express的作用和Node.js内置的http模块类似,是专门用来创建web服务器的。
Express的本质:
- 就是一个 npm 上的第三方包,提供了快速创建 Web服务器的便捷方法。
- http 内置模块用起来复杂,开发效率低。Express是基于内置模块http模块进行封装的,能够极大的提高开发效率。
常见的两种服务器
- web 网站服务器:专门对外提供web网页资源的服务器
- API接口服务:专门对外提供API接口的服务器
使用Express,可以快速创建Web网站的服务器或API接口服务器。
二、Express的基本使用
// 初始化
npm init -y
1、安装
// 在项目根目录下,执行命令
npm i express@4.17.1
2、创建基本的 Web 服务器
// 1、导入express模块
const express = require('express');
// 2、创建web服务器
const app = express();
// 3、调用app.listen(端口号,启动成功后的回调函数),启动服务
app.listen(80, () => [
console.log('服务启动了!');
});
3、监听 GET 请求
通过app.get()
方法,可以监听客户端的 GET 请求,语法如下:
// 参数一:客户端请求的 URl 地址
// 参数二:请求对应的处理函数
// req:请求对象(包含了与请求相关的属性与方法)
// res:响应对象(包含了与响应相关的属性与方法)
app.get('请求URL', (req, res) => {
// 处理函数
});
4、监听 POST 请求
通过app.post()
方法,可以监听客户端POST请求,语法如下:
// 参数一:客户端请求的 URl 地址
// 参数二:请求对应的处理函数
// req:请求对象(包含了与请求相关的属性与方法)
// res:响应对象(包含了与响应相关的属性与方法)
app.post('请求URl',(req, res) => {
// 处理函数
});
5、把内容响应给客户端
通过res.send()
方法,可以把处理好的内容,发送给客户端:
const express = require('express');
const app = express();
app.get('/list', (req, res) => {
// 向客户端响应 JSON 对象
const obj = {
label: '高数一',
num: 108,
}
res.send(obj);
});
app.post('/list', (req, res) => [
// 向客户端响应文本
res.send('请求成功!');
});
app.listen(80, () => {
console.log('服务启动了!');
});
6、 获取URl中携带的查询参数
通过req.query
对象,可以访问到客户端通过查询字符串
的形式,发送到服务器的参数:
app.get('/list', (req, res) => {
// req.query默认是一个空对象
// 客户端使用 ?name=zs&age=20 这种查询字符串形式,发送到服务端的参数
// 可以通过 req.query 对象访问到,例如:
// req.query.name, req.query.age
console.log(req.query);
});
7、获取URl中的动态参数
通过req.params
对象,可以访问到URL中,通过:
匹配动态参数:
// URL 地址中,可以通过 :参数名 的形式,匹配动态参数值
app.get('/list:id', (req, res) => [
// req.params 是一个空对象
// 里面存放着通过 : 动态匹配到的参数值
console.log(req.params);
});
8、托管静态资源
通过 express.static()
,我们可以非常方便的创建一个静态资源服务器
,例如,通过如下代码就可以将public目录下的图片、css文件、js文件对外开放访问了。
app.use(express.static('public'));
app.use(express.static('files'));
// 如果要托管多个静态资源目录,请多次调用 express.static()函数
// 访问时,express.static()函数会根据目录的添加顺序查找所需的文件
现在,可以访问public目录中的所有文件了
http://localhost:3000/images/bg.jpg
http://localhost:3000/css/style.css
http://localhost:3000/js/login.js
注意:Express在指定的静态目录中查找文件,并对外提供资源的访问路径,因此,存放静态文件的目录名不会出现在URL中。
9、挂载路径前缀
如果希望在托管的静态资源访问路径
之前,挂载路径前缀
,方法如下:
app.use('/public', express.static('public'));
现在,就可以通过带有 /public 前缀地址来访问 public 目录中的文件了
http://localhost:3000/public/images/kitten.jpg
http://localhost:3000/public/css/style.css
http://localhost:3000/public/js/app.js
三、nodemon
在编写调试 Node.js 项目的时候,如果修改了项目代码,则需要频繁的手动close掉,然后再重新启动,非常繁琐。
现在可以使用nodemon
这个工具,它能够监听项目文件的变化
,当代码被修改后,nodemon会自动帮我们重启项目
。
安装 nodemon
npm install -g nodemon
// mac
sudo npm install nodemon -g
四、Express中的路由
1、简述
在Express中,路由指的是客户端的请求
与服务端处理函数
之间的映射关系。格式如下:
app.method(path,handler);
2、Express中路由的例子
在Express中使用路由最简单的方式,就是把路由直接挂载到app上,代码如下:
const express = require('express');
const app = express();
// 挂载路由
// 匹配get请求,且请求url为 /
app.get('/', (req, res) => {
res.send('helllo 啊!');
});
// 匹配post请求,且请求url为 /
app.post('/', (req, res) => {
res.send('hi');
});
app.listen(80, () => [
console.log('服务启动 !');
});
3、路由的匹配过程
匹配请求类型
和url
,都匹配,才会处理。
4、模块化路由
为了方便对路由进行模块化的管理
,Express 不建议 将路由直接挂载到app上,而是推荐将路由抽离为单独的模块
。
将路由抽离为单独模块的步骤:
- 创建路由模块对应的js文件
- 调用
express.Router()
函数创建路由对象 - 向路由对象上挂载具体的路由
- 使用
module.exports
向外共享路由对象 - 使用
app.use()
函数注册路由模块
5、创建路由模块
// 导入express
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;
6、路由的使用
注册路由模块
// 导入路由模块
const userRouter = require('./router/user.js');
// 使用 app.use() 注册路由模块
app.use(userRouter);
7、为路由模块添加前缀
// 导入路由模块
const userRouter = require('./router/user.js');
// 使用 app.use() 注册路由模块,并添加统一的访问前缀 /api
app.use('/api', userRouter);
Express 的中间件
1、简述
中间价,特指业务流程
的中间处理环节
2、例子
3、Express中间件的调用流程
当一个请求到达Express的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理
4、Express中间件的格式
Express的中间件,本质上就是一个function处理函数
,Express中间件格式如下:
注意:中间件函数的形参列表中,必须包含next函数
,而路由处理函数中只包含req和res。
next函数
是实现 多个中间件连续调用
的关键,它表示把流转关系转交给下一个中间件或路由。
5、定义中间件函数
// 常量 mw 所指向的,就是一个中间件
const mw = (req, res, next) => {
console.log('这是一个简单的中间件');
// 注意:在当前中间件的业务处理完毕之后,必须调用 next() 函数
// 表示把流转关系转交给下一个中间件或路由
next();
}
6、全局生效
的中间件
客户端发起的任何请求
,到达服务器之后,都会触发的中间件
,叫做全局生效的中间件。
// 常量 mw 所指向的,就是一个中间件
const mw = (req, res, next) => {
console.log('这是一个简单的中间件');
// 注意:在当前中间件的业务处理完毕之后,必须调用 next() 函数
// 表示把流转关系转交给下一个中间件或路由
next();
}
// 全局生效的中间件
app.use(mw);
全局中间件简写
app.use((req, res, next) => {
console.log('这是一个最简单的中间件函数');
next();
});
7、中间件的作用
多个中间件之间,共享同一份req和res
。基于这样的特性,我们可以在上游
中间件,统一为req和res对象添加自定义的属性或者方法
,供下游的中间件或路由进行使用
。
8、定义多个全局中间件
可以使用app.use()连续定义多个全局中间件
。客户端请求到服务器之后,会按照中间件定义的先后顺序一次进行调用
,示例代码如下:
app.use((req,res,next) => {
console.log('调用了第一个全局中间件');
next();
})
app.use((req,res,next) => {
console.log('调用了第二个全局中间件');
next();
})
// 请求这个路由,会依次触发上述两个全局中间件
app.get('/user', (req,res) => {
res.send('user 响应数据');
});
9、局部生效的中间件
不使用app.use()
定义的中间件,叫做局部生效的中间件
,示例代码如下:
// 定义中间件函数
const mw = (req, res, next) => {
console.log('我是中间件函数');
next();
}
// mw这个中间件只有在以下路由中生效,局部生效中间件
app.get('/user', mw, (req,res) => {
res.send('响应数据');
});
10、定义多个局部中间件
可以在路由中,通过以下两种方式,使用多个局部中间件
app.get('/', mw1, mw2, (req, res) => { res.send() });
app.get('/', [mw1, mw2], (req, res) => { res.send() });
11、中间件的5个使用注意事项
- 一定要在
路由之前
注册中间件 - 客户端发起请求,
可以连续调用多个
中间件进行处理 - 执行完中间件代码后,
不要忘记调用next()函数
- 为了防止代码逻辑混乱,调用next()函数后不要再写额外代码
- 连续调用多个中间件时,多个中间件之间,
共享req与res
12、中间件的分类
为了方便记忆,Express官方把常见的中间件分成了5大类:
应用级别
中间件路由级别
中间件错误级别
中间件Express内置
的中间件第三方
的中间件`
12.01、应用级别的中间件
通过app.use()或app.get()或app.post()
,绑定到app实例上的中间件
,叫做应用级别的中间件。
// 应用级别的中间件(全局中间件)
app.use((req,res,next) => {
next();
});
// 应用级别的中间件(局部中间件)
app.get('/', mw, (req,res) => {
res.send();
});
12.02、路由中间件
绑定到express.Router()
实例上的中间件,叫做路由中间件
。用法类似应用中间件。不过,应用中间件是绑定到app实例上,路由中间件是绑定到router实例上
。
const express = require('express');
const app = express()
const router = express.Router();
// 路由中间件
router.use((req, res, next) => {
console.log('路由中间件');
next();
});
app.use('/api', router);
12.03、错误级别中间件
错误中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常奔溃的问题。
错误中间件处理函数中,一共有四个形参,分别是(err,req,res,next)
注意:错误中间件必须在所有路由之后。
app.get('/',(req,res) => {
throw new Error('服务器内部发生了错误'); // 抛出一个自定义的错误
res.send();
})
// 错误中间件
app.use((err,req,res,next) => {
console.log('发生了错误' + err.message);
res.send('erroe' + err.message); // 向客户端响应回去错误内容
});
12.04、Express的内置中间件
12.05、第三方中间件
13、自定义中间件
描述
自己手动模拟一个类似express.urlencoded这样的中间件,来解析post提交到服务器的表单数据。
- 定义中间件
// 使用app.use()来定义全局生效的中间件
app.use((req,res,next) => {
// 中间件业务逻辑
});
- 监听req的data事件
// 在中间件中,需要监听req对象的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.boey,供下游使用。
req.on('end', () => {
// 调用qs.parse()方法,把查询字符串解析为对象
const body = qs.parse(str);
// 将解析出来的请求体对象,挂载为req.body属性
req.body = body;
next();
});
- 将自定义中间件封装为模块
myBodyModel.js
// 将自定义的中间件,封装为独立的模块
const qs = require('querystrring');
const bodyModel = (req,res,next) => {
// 逻辑代码
}
// 抛出解析请求体数据的中间件函数
module.express = bodyModel;
// 导入自定义中间件模块
const myBodyModel = require('myBodyModel');
// 注册自定义的中间件模块,全局
app.use(myBodyModel);