express
1、初识express
Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架。 通俗的理解:Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器的。 Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。
Express 的中文官网: http://www.expressjs.com.cn/
注:
使用 Node.js 提供的原生 http 模块在不使用express的条件下可以创建web服务器
http 内置模块用起来很复杂,开发效率低;Express 是基于内置的 http 模块进一步封装出来的,能够极大的提高开发效率。
http内置模块与Express的关系:类似于浏览器中的Web API和JQuery的关系,后者基于前者进一步封装。
对于前端程序员来说,最常见的两种服务器,分别是:
⚫ Web 网站服务器:专门对外提供 Web 网页资源的服务器。
⚫ API 接口服务器:专门对外提供 API 接口的服务器。 使用 Express,我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。
2、Express的基本使用
1、安装:
在所处项目中运行如下命令:
npm i express
2、创建基本的web服务器
//导入express
const express = require('express')
//创建web服务器
const app = express();
//监听客户端的GET和POST请求,并向客户端响应具体内容
app.get('/user', (req, res) => {
//调用express提供的res.send()方法,向客户端响应一个JSON对象
res.send({
name: "zs",
age: 20,
gender: "男"
})
})
app.post('/user', (req, res) => {
//调用express提供的res.send()方法,向客户端响应一个文本字符串
res.send('请求成功')
})
app.get('/', (req, res) => {
//通过req.query可以获取到客户端发送过来的查询参数
//注意:默认情况下,req.query是一个空对象
console.log(req.query);
res.send(req.query)
})
app.get('/user/:id/:name', (req, res) => {
//req.params是动态匹配到的url参数,默认也是一个空对象
console.log(req.params);
res.send(req.params)
})
//启动服务器
app.listen(80, () => {
console.log('express server running at http://127.0.0.1');
})
3、托管静态资源 express.static( )
express 提供了一个非常好用的函数,叫做 express.static(),通过它,我们可以非常方便地创建一个静态资源服务器, 例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:
const express = require('express');
const app = express();
//在这里,调用express.static()方法,快速的对外提供静态资源
app.use(express.static('./html'));
app.listen(80, () => {
console.log("listening on port");
});
注意:Express 在指定的静态目录中查找文件,并对外提供资源的访问路径。 因此,存放静态文件的目录名不会出现在 URL 中。
4、挂载路径前缀
如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下的方式:
const express = require('express');
const app = express();
//在这里,调用express.static()方法,快速的对外提供静态资源
app.use('/user', express.static('./html'));
app.listen(80, () => {
console.log("listening on port");
});
现在,你就可以通过带有 /user 前缀地址来访问 html目录中的文件了:
3、Express路由
路由的概念与基本使用:
广义上来讲,路由就是映射关系。
在 Express 中,路由指的是客户端的请求与服务器处理函数之间的映射关系。 Express 中的路由分 3 部分组成,分别是请求的类型、请求的 URL 地址、处理函数,格式如下:
app.METHOD(PATH,HANDLER)
路由的匹配过程:
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数。 在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的 URL 同时匹配成功,则 Express 会将这次请求,转 交给对应的 function 函数进行处理。
路由匹配的注意点:
① 按照定义的先后顺序进行匹配
② 请求类型和请求的URL同时匹配成功,才会调用相应的函数
在 Express 中使用路由最简单的方式,就是把路由挂载到 app 上,示例代码如下:
const express = require('express');
const app = express();
//在这里,调用express.static()方法,快速的对外提供静态资源
//挂载路由
app.get('/', (req, res) => {
res.send('hello world!');
})
app.post('/', (req, res) => {
res.send('Post Request');
})
app.listen(80, () => {
console.log("listening on port");
});
模块化路由:
为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块。
将路由抽离为单独模块的步骤如下:
① 创建路由模块对应的 .js 文件
② 调用 express.Router() 函数创建路由对象
③ 向路由对象上挂载具体的路由
④ 使用 module.exports 向外共享路由对象
⑤ 使用 app.use() 函数注册路由模块
//这是路由模块
//导入express
const express = require('express');
const router = express.Router();
//挂载具体路由
router.get('/', (req, res) => {
res.send('GEt user list')
})
router.post('/', (req, res) => {
res.send('ADD new user')
})
//向外导出路由对象
module.exports = router
const express = require('express');
const app = express();
// app.use(express.static(path.join(__dirname)))中间件
//导入路由模块
const router = require('./01.router');
//注册路由模块
//app.use()的作用就是来注册全局中间件
app.use(router)
app.listen(80, () => {
console.log('listening on port');
});
为路由模块添加前缀
类似于托管静态资源时,为静态资源统一挂载访问前缀一样,路由模块添加前缀的方式也非常简单:
//导入路由模块
const router = require('./01.router');
//使用app.use()注册路由模块,并添加同意访问前缀/user
app.use('/user', router)
4、Express中间件
中间件概念
中间件(Middleware ),特指业务流程的中间处理环节。
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。
Express 的中间件,本质上就是一个 function 处理函数,Express 中间件的格式如下:
next 函数的作用 :next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
定义一个简单地中间件
全局生效的中间件 客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件。
const mw = function (req, res, next) {
console.log('这是最简单的中间件函数');
//把流转关系转交给下一个中间件或路由
next();
}
//将mw注册为全局生效的中间件
app.use(mw);
const express = require('express');
const app = express();
const mw = function (req, res, next) {
console.log('这是最简单的中间件函数');
//把流转关系转交给下一个中间件或路由
next();
}
//将mw注册为全局生效的中间件
app.use(mw);
app.get('/', (req, res) => {
res.send('Home Page');
})
app.get('/user', (req, res) => {
res.send('User Page');
})
app.listen(80, () => {
console.log('listening on port');
});
在发起请求时,会打印出" 这是最简单的中间件函数"
简化中间件写法:
app.use(function (req, res, next) {
console.log('这是最简单的中间件函数');
// //把流转关系转交给下一个中间件或路由
next();
});
中间件的作用
多个中间件之间,共享同一份 req 和 res。基于这样的特性,我们可以在上游的中间件中,统一为 req 或 res 对象添 加自定义的属性或方法,供下游的中间件或路由进行使用。
定义多个全局中间件
可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行 调用,示例代码如下:
const express = require("express");
const app = express();
//定义第一个全局中间件
app.use((res, req, next) => {
console.log("这是第一个全局中间件");
next();
})
//定义第二个全局中间件
app.use((res, req, next) => {
console.log("这是第二个全局中间件");
next();
})
//定义一个路由
app.get('/', (req, res) => {
res.send('User page!')
})
app.listen(80, () => {
console.log('listen on port');
})
局部生效的中间件
不使用 app.use() 定义的中间件,叫做局部生效的中间件。
在请求第一个路由时,会打印‘调用了局部中间件’,而再调用第二个路由时就不会打印。
const express = require('express');
const app = express();
const mw1 = (req, res, next) => {
console.log('调用了局部中间件');
next();
};
app.get('/', mw1, (req, res) => {
res.send('homePage')
})
app.get('/user', (req, res) => {
res.send('UserPage')
})
app.listen(80, () => {
console.log('listening on port');
});
定义多个局部中间件:
可以在路由中,通过如下两种等价的方式,使用多个局部中间件
使用中间件的五个注意事项:
① 一定要在路由之前注册中间件
② 客户端发送过来的请求,可以连续调用多个中间件进行处理
③ 执行完中间件的业务代码之后,不要忘记调用 next() 函数
④ 为了防止代码逻辑混乱,调用 next() 函数后不要再写额外的代码
⑤ 连续调用多个中间件时,多个中间件之间,共享 req 和 res 对象
中间件的分类:
为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是:
① 应用级别的中间件
通过 app.use() 或 app.get() 或 app.post() ,绑定到 app 实例上的中间件,叫做应用级别的中间件
② 路由级别的中间件
绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不 过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上
③ 错误级别的中间件
错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。 格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是 (err, req, res, next)。
注意:错误级别的中间件, 必须注册在所有路由之后!
④ Express 内置的中间件
自 Express 4.16.0 版本开始,Express 内置了 3 个常用的中间件,极大的提高了 Express 项目的开发效率和体验:
① express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等(无兼容性)
② express.json 解析 JSON 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
const express = require('express')
const app = express()
const port = 80;
//出了错误级别的中间件,其他中间件,必须在路由之前配置
//通过express.json()中间件,解析表单中的json格式的数据
app.use(express.json())
app.post('/', (req, res) => {
//在服务器中可以接受req.body这个属性的,来接受客户端发送过来的请求体数据
//默认情况下如果不配置解析数据表单数据的中间件,req.body默认为undefined
console.log(req.body);
res.send('Hello World!')
})
app.listen(port, () => console.log(`Example app listening on port ${port}!`))
postman种客户端发送的请求体数据:
③ express.urlencoded 解析 URL-encoded 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
app.use(express.urlencoded({
extended: false
}));
app.post('/book', (req, res) => {
//在服务器中可以接受req.body这个属性的,来接受JSON格式的表单数据和url-encoded格式的数据
console.log(req.body);
res.send('OK!')
})
⑤ 第三方的中间件
非 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()
const port = 80
//导入解析表单中的数据
const parser = require('body-parser')
//使用app.use()注册中间件
app.use(express.urlencoded({
extended: false
}))
app.post('/', (req, res) => {
console.log(req.body);
res.send('OK!');
})
app.get('/', (req, res) => res.send('Hello World!'))
app.listen(port, () => console.log(`Example app listening on port ${port}!`))
自定义中间件
使用 app.use() 来定义全局生效的中间件
监听 req 的 data 事件
在中间件中,需要监听 req 对象的 data 事件,来获取客户端发送到服务器的数据。 如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 data 事件可能会触 发多次,每一次触发 data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。
const express = require('express')
const app = express()
const port = 80
app.use((req, res, next) => {
//定义中间件具体业务
let str = '';
//监听req的data事件
req.on('data', (chunk) => {
str += chunk
})
})
app.get('/', (req, res) => res.send('Hello World!'))
app.listen(port, () => console.log(`Example app listening on port ${port}!`))
监听 req 的 end 事件
当请求体数据接收完毕之后,会自动触发 req 的 end 事件。 因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。
const express = require('express')
const app = express()
const port = 80
app.use((req, res, next) => {
//定义中间件具体业务
let str = '';
//监听req的data事件
req.on('data', (chunk) => {
str += chunk
})
//监听req的end事件
req.on('end', () => {
//在str中存放的是完整的请求体数据
console.log(str);
//把字符串格式的请求体数据,解析成对象格式
})
})
app.post('/user', (req, res) => {
res.send('OK?')
})
app.get('/', (req, res) => res.send('Hello World!'))
app.listen(port, () => console.log(`Example app listening on port ${port}!`))
使用 querystring 模块解析请求体数据
Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse() 函数,可以轻松把 查询字符串,解析成对象的格式。示例代码如下
const express = require('express')
const app = express()
const qs = require('querystring');
const port = 80
app.use((req, res, next) => {
//定义中间件具体业务
let str = '';
//监听req的data事件
req.on('data', (chunk) => {
str += chunk
})
//监听req的end事件
req.on('end', () => {
//在str中存放的是完整的请求体数据
// console.log(str);
//把字符串格式的请求体数据,解析成对象格式
const body = qs.parse(str);
console.log(body);
})
})
app.post('/user', (req, res) => {
res.send('OK?')
})
app.get('/', (req, res) => res.send('Hello World!'))
app.listen(port, () => console.log(`Example app listening on port ${port}!`))
将解析出来的数据对象挂载为 req.body
上游的中间件和下游的中间件及路由之间,共享同一份 req 和 res。因此,我们可以将解析出来的数据,挂载为 req 的自定义属性,命名为 req.body,供下游使用。示例代码如下:
在客户端显示:
将自定义中间件封装为模块
为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块。
//导入Node.js的内置querystring模块
const qs = require('querystring');
const bodyParse = (req, res, next) => {
//定义中间件具体业务
let str = '';
//监听req的data事件
req.on('data', (chunk) => {
str += chunk
})
//监听req的end事件
req.on('end', () => {
//在str中存放的是完整的请求体数据
// console.log(str);
//把字符串格式的请求体数据,解析成对象格式
const body = qs.parse(str);
req.body = body;
next();
})
}
module.exports = bodyParse;
在外界就可以得到此函数。