【Node.js】express框架

目录

1初识express框架

[2 初步使用](#2 初步使用)

[2.1 安装](#2.1 安装)

[2.2 创建基本的Web服务器](#2.2 创建基本的Web服务器)

[2.3 监听方法](#2.3 监听方法)

[2.3.1 监听get请求](#2.3.1 监听get请求)

[2.3.2 监听post请求](#2.3.2 监听post请求)

[2.4 响应客户端](#2.4 响应客户端)

[2.5 获取url中的参数(get)](#2.5 获取url中的参数(get))

[2.5.1 获取查询参数](#2.5.1 获取查询参数)

[2.5.2 获取动态参数](#2.5.2 获取动态参数)

[2.6 托管静态资源](#2.6 托管静态资源)

[2.6.1 挂载路径前缀](#2.6.1 挂载路径前缀)

[2.6.2 托管多个静态资源](#2.6.2 托管多个静态资源)

[3 express路由](#3 express路由)

[3.1 最简单的用法](#3.1 最简单的用法)

[3.2 模块化路由](#3.2 模块化路由)

[3.3 挂载前缀](#3.3 挂载前缀)

[4 中间件](#4 中间件)

[4.1 next函数](#4.1 next函数)

[4.2 中间件的特性](#4.2 中间件的特性)

[4.3 创建中间件](#4.3 创建中间件)

[4.3.1 全局中间件](#4.3.1 全局中间件)

[4.3.2 创建多个全局中间件](#4.3.2 创建多个全局中间件)

[4.3.3 创建局部中间件](#4.3.3 创建局部中间件)

[4.3.4 创建多个局部中间件](#4.3.4 创建多个局部中间件)

[4.4 中间件注意事项](#4.4 中间件注意事项)

[4.5 中间件的分类](#4.5 中间件的分类)

[4.5.1 应用级别的中间件](#4.5.1 应用级别的中间件)

[4.5.2 路由级别的中间件](#4.5.2 路由级别的中间件)

[4.5.3 错误级别的中间件](#4.5.3 错误级别的中间件)

[4.5.4 Express内置的中间件](#4.5.4 Express内置的中间件)

[4.5.5 第三方中间件](#4.5.5 第三方中间件)

[4.6 自定义中间件](#4.6 自定义中间件)

[4.6.1 监听事件](#4.6.1 监听事件)

[4.6.2 使用 querystring 模块解析请求体数据](#4.6.2 使用 querystring 模块解析请求体数据)

[4.6.3 将解析出来的数据对象挂载为req.body](#4.6.3 将解析出来的数据对象挂载为req.body)

[4.6.4 将自定义中间件封装为模块](#4.6.4 将自定义中间件封装为模块)


1初识express框架

官方给出的概念: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 的关系。后者是基于前者进一步封装出来的
Express 能做什么?

对于前端程序员来说,最常见的两种服务器,分别是:

  • Web 网站服务器:专门对外提供Web 网页资源的服务器
  • API 接口服务器:专门对外提供API 接口的服务器

使用Express,我们可以方便、快速的创建Web 网站的服务器或API 接口的服务器


2 初步使用

2.1 安装

本章使用4.17.1版本

CoffeeScript 复制代码
npm i express@4.17.1

2.2 创建基本的Web服务器

javascript 复制代码
//导入express
const express = require("express")

//创建web服务器
const app = express()


//...预留位置


//启动服务器,分配端口
app.listen(80, () => {
    //启动成功后执行的回调函数
})

2.3 监听方法

2.3.1 监听get请求

req:请求对象(包含了与请求相关的属性与方法)

res:响应对象(包含了与响应相关的属性与方法)

javascript 复制代码
app.get("请求url", (req, res) => {
    //处理函数
})

2.3.2 监听post请求

javascript 复制代码
app.post("请求url", (req, res) => {
    //处理函数
})

2.4 响应客户端

res对象的send方法

javascript 复制代码
res.send(响应内容)

2.5 获取url中的参数(get)

2.5.1 获取查询参数

查询参数(如:?name=user&age=18)可以通过req对象下的query属性查询

如:

req.query.name

req.query.age


2.5.2 获取动态参数

动态参数(url地址中 :参数名 对应的值)可以通过req对象的params属性查询

req.params默认是一个空对象

里面存放通过:参数名 匹配到的参数值

javascript 复制代码
app.get("/user/:id", (req, res) => {

    //例如访问:http://域名/user/28
    //则req对象中的params对象里会被添加一个id属性,且值为28(属性名由:后的参数名决定)

})

2.6 托管静态资源

express 提供了一个非常好用的函数,叫做express.static(),通过它,我们可以非常方便地创建一个静态资源服务器

例如,通过如下代码就可以将public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:

javascript 复制代码
app.use(express.static("public"))

现在,你就可以访问public 目录中的所有文件了:

http://localhost:3000/images/bg.jpg

http://localhost:3000/css/style.css

http://localhost:3000/js/login.js

注意:Express 在指定的静态目录中查找文件,并对外提供资源的访问路径,因此,存放静态文件的目录名不会出现在URL 中,那么如何添加目录名呢?见下文:


2.6.1 挂载路径前缀

javascript 复制代码
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

还可以通过多次使用express.static()来托管多个静态资源。如下:


2.6.2 托管多个静态资源

javascript 复制代码
app.use("/public", express.static("public"))
app.use("/files", express.static("files"))

如果没有挂载路径前缀,则会按照托管顺序显示,谁先托管显示谁


3 express路由

在Express 中,路由指的是客户端的请求与服务器处理函数之间的映射关系。

Express 中的路由分3 部分组成,分别是请求的类型、请求的URL 地址、处理函数,格式如下:

javascript 复制代码
app.METHOD(PATH, HANDLER)

上文中的监听get/post请求即是一种路由

路由匹配过程:

每当一个请求到达服务器之后,需要先经过路由的匹配,在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的URL 同时匹配成功,则Express 会将这次请求,转交给对应的function 函数进行处理

路由匹配的注意点:

① 按照定义的先后顺序进行匹配

② 请求类型和请求的URL同时匹配成功, 才会调用对应的处理函数

3.1 最简单的用法

把路由挂载到app 上,如上文中的监听get/post请求


3.2 模块化路由

为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到app 上,而是推荐将路由抽离为单独的模块

将路由抽离为单独模块的步骤如下:

① 创建路由模块对应的.js 文件

② 调用express.Router() 函数创建路由对象

③ 向路由对象上挂载具体的路由

④ 使用module.exports 向外共享路由对象

javascript 复制代码
//路由模块.js文件

//导入express
const express = require("express")
//创建路由对象
const router = express.Router()

//挂载路由
router.get("user/list", (req, res) => {

})

//导出路由对象
module.exports = router

⑤ 使用app.use() 函数注册路由模块

javascript 复制代码
//...
//导入路由模块
const userRouter = require("路由模块路径")

//使用app.use注册路由模块
app.use(userRouter)

3.3 挂载前缀

路由模块也可以挂载前缀,原理与托管静态资源同理,本质上都是使用app.user()

在注册路由模块时,前面加上前缀即可

javascript 复制代码
app.use("/api", userRouter)

4 中间件

中间件,特指业务流程的中间处理环节

Express 的中间件,本质上就是一个function 处理函数,Express 中间件的格式如下:


4.1 next函数

next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由


4.2 中间件的特性

多个中间件之间,共享同一份req和res

基于这样的特性,我们可以在上游的中间件中,统一为req 或res 对象添 加自定义的属性或方法,供下游的中间件或路由进行使用


4.3 创建中间件

4.3.1 全局中间件

客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件

通过调用app.use(中间件函数),即可定义一个全局生效的中间件,示例代码如下:

javascript 复制代码
const mw = function(req, res, next) {
    //...
    next()
}

app.use(mw)

简化写法:

javascript 复制代码
app.use(function(req, res, next) {
    //...
    next()
})

4.3.2 创建多个全局中间件

可以使用app.use() 连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用


4.3.3 创建局部中间件

不使用app.use() 定义的中间件,叫做局部生效的中间件,局部中间件只有在绑定了该中间件的路由匹配成功时才会执行

示例代码如下:

javascript 复制代码
const mw = function(req, res, next) {
    //...
    next()
}

app.get("/", mw, function(req, res) {
    //
})

4.3.4 创建多个局部中间件

可以在路由中,通过如下两种等价的方式,使用多个局部中间件:

javascript 复制代码
app.get("/", mw1, mw2, (req, res) => {    //...    })

app.get("/", [mw1, mw2], (req, res) => {    //...    })

4.4 中间件注意事项

① 一定要在路由之前注册中间件

② 客户端发送过来的请求,可以连续调用多个中间件进行处理

③ 执行完中间件的业务代码之后,不要忘记调用next() 函数

④ 为了防止代码逻辑混乱,调用next() 函数后不要再写额外的代码

⑤ 连续调用多个中间件时,多个中间件之间,共享req 和res 对象


4.5 中间件的分类

为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了5 大类,分别是:

① 应用级别的中间件

② 路由级别的中间件

③ 错误级别的中间件

④ Express 内置的中间件

⑤ 第三方的中间件


4.5.1 应用级别的中间件

绑定到 app 实例上的中间件,叫做应用级别的中间件


4.5.2 路由级别的中间件

绑定到express.Router() 实例上的中间件,叫做路由级别的中间件

它的用法和应用级别中间件没有任何区别

只不过,应用级别中间件是绑定到app 实例上,路由级别中间件绑定到router 实例上


4.5.3 错误级别的中间件

错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题

格式:错误级别中间件的function 处理函数中,必须有4 个形参,形参顺序从前到后,分别是(err, req, res, next)

注意:错误级别的中间件, 必须注册在所有路由之后!

javascript 复制代码
app.get("/", (req, res) => {
    throw new Error("error")
    res.send("index")    //不会执行该行
})


app.use(function(err, req, res, next) {
    console.log("发生了错误")
    res.send("error")
})

4.5.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()使用即可

注意:经常用于解析通过post方法传来的数据,获取的数据在req.body中

javascript 复制代码
app.use(express.json())

app.use(express.urlencoded({ extended: flase }))

4.5.5 第三方中间件

非Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置 第三方中间件,从而提高项目的开发效率

例如:在express@4.16.0 之前的版本中,经常使用body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:

① 运行npm install body-parser安装中间件

② 使用require导入中间件

③ 调用app.use() 注册并使用中间件


4.6 自定义中间件

自己手动模拟一个类似于express.urlencoded这样的中间件,来解析POST 提交到服务器的表单数据。 实现步骤:

① 定义中间件

② 监听req 的data 事件

③ 监听req 的end 事件

④ 使用querystring模块解析请求体数据

⑤ 将解析出来的数据对象挂载为req.body

⑥ 将自定义中间件封装为模块


4.6.1 监听事件

当客户端向服务器发送数据时(data事件),响应

如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器

所以data 事件可能会触发多次,每一次触发data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。

javascript 复制代码
let str = ""

req.on("data", (chunk) => {
    str += chunk

})

当请求数据接收完毕之后自动触发end事件

因此,我们可以在req 的end 事件中,拿到并处理完整的请求体数据示例代码如下:

javascript 复制代码
req.on("end", () => {

})

4.6.2 使用 querystring 模块解析请求体数据

Node.js 内置了一个querystring 模块,专门用来处理查询字符串。通过这个模块提供的parse() 函数,可以轻松把查询字符串,解析成对象的格式。示例代码如下:

javascript 复制代码
const qs = require("querystring")

const body = qs.parse(str)

4.6.3 将解析出来的数据对象挂载为req.body

上游的中间件和下游的中间件及路由之间,共享同一份req 和res。因此,我们可以将解析出来的数据,挂载为req 的自定义属性,命名为req.body,供下游使用。示例代码如下:

javascript 复制代码
req.on("end", () => {
    const body = qs.parse(str)
    req.body = body
})

4.6.4 将自定义中间件封装为模块

为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块,示例代码如下:

相关推荐
爱学习的小王!4 小时前
nvm安装、管理node多版本以及配置环境变量【保姆级教程】
经验分享·笔记·node.js·vue
(; ̄ェ ̄)。8 小时前
在Nodejs中使用kafka(三)offset偏移量控制策略,数据保存策略
分布式·后端·kafka·node.js
begei14 小时前
nodejs版本管理,使用 nvm 删除node版本,要删除 Node.js 的某个版本详细操作
node.js
小白探索世界欧耶!~14 小时前
npm/pnpm软链接
前端·npm·node.js
柚子味儿的西瓜14 小时前
npm install --legacy-peer-deps和npm install --force的区别
前端·npm·node.js
_advance14 小时前
🚀不用新建后端项目!用 Vite 插件开发 Node 接口的正确姿势
前端·node.js
OpenTiny社区16 小时前
Node.js技术原理分析系列——如何在Node.js中新增一个内置模块
前端·开源·node.js·opentiny
CDwenhuohuo1 天前
使用 NVM 随意切换 Node.js 版本
node.js
随风起舞11 天前
node.js里的bind,apply, call的区别是什么
前端·javascript·node.js
神秘代码行者1 天前
Node.js Buffer 教程
javascript·node.js