NodeJS(三)Express 实践

本文详细介绍了Express,一个基于Node.js的Web开发框架,解释了为何在已有HTTP模块的情况下仍需使用Express,以及Express的基本用法,包括创建Web服务器和托管静态资源。此外,还探讨了nodemon工具在开发中的便利性,以及Express的路由和中间件概念,包括其匹配过程、使用和分类。

系列文章目录

NodeJS(三)path+http 模块实践



一、什么是 Express

1.1 Express的概念

官方的概念:Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架。

通俗的理解:Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器的。

Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。

Express 的中文官网: http://www.expressjs.com.cn/

1.2 为什么有了HTTP模块还要用Express ?

对于前端程序员来说,最常见的两种服务器,分别是:
Web 网站服务器:专门对外提供 Web 网页资源的服务器。
API 接口服务器:专门对外提供 API 接口的服务器。

http 内置模块用起来很复杂,开发效率低;Express 是基于内置的 http 模块进一步封装出来的,能够极大的提高开发效率。

http 内置模块与 Express 类似于浏览器中 Web API 和 jQuery 的关系。后者是基于前者进一步封装出来的。

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

二、 Express 的基本使用

2.1 创建基本的 Web 服务器

首先,下载express

npm i express@4.17.1

步骤:

  1. 导入 express
  2. 创建 web 服务器
  3. 启动 web 服务器
  4. 监听客户端的 GET 和 POST 请求,并向客户端响应具体的内容。

示例代码如下:

// 1. 导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()

// 4. 监听客户端的 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() 方法,可以把处理好的内容,发送给客户端:

  res.send('请求成功')
})
app.get('/', (req, res) => {
  // 通过 req.query 可以获取到客户端发送过来的 查询参数
  // 注意:默认情况下,req.query 是一个空对象
  console.log(req.query)
  res.send(req.query)
})
// 注意:这里的 :id 是一个动态的参数
app.get('/user/:ids/:username', (req, res) => {
//通过 req.params 对象,可以访问到 URL 中,通过 : 匹配到的动态参数:
  // req.params 是动态匹配到的 URL 参数,默认也是一个空对象
  console.log(req.params)
  res.send(req.params)
})

// 3. 启动 web 服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})

2.2 托管静态资源

  1. express.static()
    express.static(),创建一个静态资源服务器.
    例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:
app.use(express.static('public '))

即可以直接在网页访问 public目录下的图片、CSS 文件、JavaScript 文件:
http://localhost:3000/images/bg.jpg
http://localhost:3000/css/style.css
http://localhost:3000/js/login.js

注意:Express 在指定的静态目录中查找文件,并对外提供资源的访问路径。
因此,存放静态文件的目录名不会出现在 URL 中。

  1. 托管多个静态资源目录
    如果要托管多个静态资源目录,请多次调用 express.static() 函数。访问静态资源文件时,express.static() 函数会根据目录的添加顺序查找所需的文件。
app.use(express.static('public '))
app.use(express.static('users '))
  1. 挂载路径前缀
    如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下的方式:
    目的:通过带有 /public 前缀地址来访问 public 目录中的文件。
app.use('./public', express.static('./public'))

如访问:
http://localhost:3000/public/images/kitten.jpg
http://localhost:3000/public/css/style.css
http://localhost:3000/public/js/app.js

三、nodemon

  1. 为什么要使用 nodemon
    在编写调试 Node.js 项目的时候,如果修改了项目的代码,则需要频繁的手动 close 掉,然后再重新启动,非常繁琐。
    当基于 Node.js 编写了一个网站应用的时候,传统的方式,是运行 node app.js 命令,来启动项目。这样做的坏处是:代码被修改之后,需要手动重启项目。
    现在,我们可以使用 nodemon(https://www.npmjs.com/package/nodemon) 这个工具,它能够监听项目文件的变动,当代码被修改后,nodemon 会自动帮我们重启项目,极大方便了开发和调试。

  2. 安装 nodemon
    在终端中,运行如下命令,即可将 nodemon 安装为全局可用的工具。

npm install -g nodemon

  1. 使用 nodemon
    我们可以将 node 命令替换为 nodemon 命令,使用 nodemon app.js 来启动项目。从而实现自动重启项目的效果。

四、 Express 路由

4.1 路由的概念

4.1.1 什么是路由

广义上来讲,路由就是映射关系。

4.1.2. Express 中的路由

在 Express 中,路由指的是客户端的请求与服务器处理函数之间的映射关系。
Express 中的路由分 3 部分组成,分别是请求的类型、请求的 URL 地址、处理函数,格式如下:

app.METHOD(path, handler)

4.2 路由的匹配过程

每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数。

在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的 URL 同时匹配成功,则 Express 会将这次请求,转交给对应的 function 函数进行处理。

路由匹配的注意点:
① 按照定义的先后顺序进行匹配
② 请求类型和请求的URL同时匹配成功,才会调用对应的处理函数。

4.3 路由的使用

  1. 最简单的用法
    在 Express 中使用路由最简单的方式,就是把路由挂载到 app 上,示例代码如下:
const express = require('express')
const app = express()

// 挂载路由
app.get('/', (req, res) => {
  res.send('hello world.')
})
app.post('/', (req, res) => {
  res.send('Post Request.')
})

app.listen(80, () => {
  console.log('http://127.0.0.1')
})

  1. 模块化路由
    为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块。
    将路由抽离为单独模块的步骤如下:
    ① 创建路由模块对应的 .js 文件
    ② 调用 express.Router() 函数创建路由对象
    ③ 向路由对象上挂载具体的路由
    ④ 使用 module.exports 向外共享路由对象
    ⑤ 使用 app.use() 函数注册路由模块

  2. 创建路由模块
    router.js 如下

// 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. 注册路由模块
// 1. 导入路由模块
const router = require('./03.router')
// 2. 注册路由模块
app.use( router)
  1. 为路由模块添加前缀
    类似于托管静态资源时,为静态资源统一挂载访问前缀一样,路由模块添加前缀的方式示例如下:
// 1. 导入路由模块
const router = require('./03.router')
// 2. 注册路由模块
app.use('/api', router)

4.4 Express 中间件

4.4.1 什么是中间件

中间件(Middleware ),特指业务流程的中间处理环节。

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

4.4.2 Express 中间件的调用

当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理。Express 的中间件,本质上就是一个 function 处理函数。
1 )定义中间件函数:

//定义一个最简单的中间件函数
 const mw = function (req, res, next) {
   console.log('这是最简单的中间件函数')
 //把流转关系,转交给下一个中间件或路由
  next()
 }

注意:中间件函数的形参列表中,必须包含 next 参数。而路由处理函数中只包含 req 和 res。

next 函数的作用:表示把流转关系转交给下一个中间件或路由。

2 )定义全局中间件的简化形式

app.use((req, res, next) => {
  console.log('这是最简单的中间件函数')
  next()
})

4.4.2 定义多个全局中间件

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

// 定义第一个全局中间件
app.use((req, res, next) => {
  console.log('调用了第1个全局中间件')
  next()
})
// 定义第二个全局中间件
app.use((req, res, next) => {
  console.log('调用了第2个全局中间件')
  next()
})

// 定义一个路由
app.get('/user', (req, res) => {
  res.send('User page.')
})

4.4.3 局部生效的中间件

不使用 app.use() 定义的中间件,叫做局部生效的中间件,示例代码如下:

app.get('/', [mw1, mw2], (req, res) => {
  res.send('Home page.')
})
app.get('/user', (req, res) => {
  res.send('User page.')
})

4.4.5 中间件的5个使用注意事项

① 一定要在路由之前注册中间件
② 客户端发送过来的请求,可以连续调用多个中间件进行处理
③ 执行完中间件的业务代码之后,不要忘记调用 next() 函数
④ 为了防止代码逻辑混乱,调用 next() 函数后不要再写额外的代码
⑤ 连续调用多个中间件时,多个中间件之间,共享 req 和 res 对象

4.5 中间件的分类

Express 官方把常见的中间件用法,分成了 5 大类,分别是:
① 应用级别的中间件
② 路由级别的中间件
③ 错误级别的中间件
④ Express 内置的中间件
⑤ 第三方的中间件

4.5.1 应用级别的中间件

通过 app.use() 或 app.get() 或 app.post() ,绑定到 app 实例上的中间件,叫做应用级别的中间件,代码示例如下:

// 应用级别的中间件 (全局)
app.use((req, res, next) => {
  next()
})
// 应用级别的中间件 (局部)
app.get('/', mw1, (req, res) => {
  res.send('Home page.')
})

4.5.2 路由级别的中间件

绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不
过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上,代码示例如下:

const express = require('express')
// 2. 创建路由对象
const router = express.Router()

router.use((req, res, next) => {
  next()
})

app.use('/', 'router')

4.5.3 错误级别的中间件

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

错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是 (err, req, res, next)。
注意:错误级别的中间件,
必须注册在所有路由之后!

// 1. 定义路由
app.get('/', (req, res) => {
  // 1.1 人为的制造错误
  throw new Error('服务器内部发生了错误!')
  res.send('Home page.')
})

// 2. 定义错误级别的中间件,捕获整个项目的异常错误,从而防止程序的崩溃
app.use((err, req, res, next) => {
  console.log('发生了错误!' + err.message)
  res.send('Error:' + err.message)
})

4.5.4 Express内置的中间件

自 Express 4.16.0 版本开始,Express 内置了 3 个常用的中间件:
① express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等(无兼容性)
② express.json 解析 JSON 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
③ express.urlencoded 解析 URL-encoded 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)

// 通过 express.json() 这个中间件,解析表单中的 JSON 格式的数据
app.use(express.json())
// 通过 express.urlencoded() 这个中间件,来解析 表单中的 url-encoded 格式的数据
app.use(express.urlencoded({ extended: false }))

4.5.5 第三方的中间件

非 Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。
例如:在 express@4.16.0 之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:
① 运行 npm install body-parser 安装中间件
② 使用 require 导入中间件
③ 调用 app.use() 注册并使用中间件
注意:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 这个第三方中间件进一步封装出来的。

4.5.6 自定义中间件

  1. 需求描述与实现步骤
    自己手动模拟一个类似于 express.urlencoded 这样的中间件,来解析 POST 提交到服务器的表单数据。
    实现步骤:
    ① 定义中间件
    ② 监听 req 的 data 事件
    ③ 监听 req 的 end 事件
    ④ 使用 querystring 模块解析请求体数据
    ⑤ 将解析出来的数据对象挂载为 req.body
    ⑥ 将自定义中间件封装为模块

使用 app.use() 来定义全局生效的中间件,代码如下:

app.use(func(req, res, next){
})
  1. 监听 req 的 data 事件
    在中间件中,需要监听 req 对象的 data 事件,来获取客户端发送到服务器的数据。
    如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 data 事件可能会触
    发多次,每一次触发 data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。
let str = ''
  // 2. 监听 req 的 data 事件
  req.on('data', (chunk) => {
    str += chunk
  1. 监听 req 的 end 事件
    当请求体数据接收完毕之后,会自动触发 req 的 end 事件。
    因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。示例代码如下:
// 3. 监听 req 的 end 事件
  req.on('end', () => {
    // 在 str 中存放的是完整的请求体数据
	console.log(str)
    // TODO: 把字符串格式的请求体数据,解析成对象格式
  1. 使用 querystring 模块解析请求体数据
    Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse() 函数,可以轻松把
    查询字符串,解析成对象的格式。示例代码如下:
// 导入 Node.js 内置的 querystring 模块
const qs = require('querystring')
// 调用qs.parse(str) 方法解析查询字符串
  const body = qs.parse(str)
  1. 将解析出来的数据对象挂载为 req.body
    上游的中间件和下游的中间件及路由之间,共享同一份 req 和 res。因此,我们可以将解析出来的数据,挂载为 req
    的自定义属性,命名为 req.body,供下游使用。示例代码如下:
req.on('end', () => {
    // 在 str 中存放的是完整的请求体数据
    // console.log(str)
    // TODO: 把字符串格式的请求体数据,解析成对象格式
    const body = qs.parse(str)
    req.body = body
    next()
  })
  1. 将自定义中间件封装为模块
    为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块,示例代码如下
    custom-body-parser.js
const qs = require('querystring')

const bodyParser = (req, res, next) => {
  // 定义中间件具体的业务逻辑
  // 1. 定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
  let str = ''
  // 2. 监听 req 的 data 事件
  req.on('data', (chunk) => {
    str += chunk
  })
  // 3. 监听 req 的 end 事件
  req.on('end', () => {
    // 在 str 中存放的是完整的请求体数据
    // console.log(str)
    // TODO: 把字符串格式的请求体数据,解析成对象格式
    const body = qs.parse(str)
    req.body = body
    next()
  })
}

module.exports = bodyParser

index.js

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 1. 导入自己封装的中间件模块
const customBodyParser = require('./custom-body-parser')
// 2. 将自定义的中间件函数,注册为全局可用的中间件
app.use(customBodyParser)

app.post('/user', (req, res) => {
  res.send(req.body)
})

// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值