2021-10-10Express

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

Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。 Express 的中文官网: Express - 基于 Node.js 平台的 web 应用开发框架 - Express 中文文档 | Express 中文网

安装

npm i express@4.17.1
//在项目所处的目录中,运行终端命令

Express 的基本使用

const express = require('express')
const app=express()
//调用app.listen(端口,启动成功后的回调函数)
​
监听客户端的 GET 和 POST 请求(下方代码块)
​
app.listen(80,()=>{
    console.log('express server running at http://127.0.0.1')
})
//  监听客户端的 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)
})
// 注意:这里的 :id 是一个动态的参数
app.get('/user/:ids/:username', (req, res) => {
  // req.params 是动态匹配到的 URL 参数,默认也是一个空对象
  console.log(req.params)
  res.send(req.params)
})

托管静态资源

const express = require('express')
const app = express()
//在托管的静态资源访问路径之前,添加路径前缀
app.use('/files', express.static('./files'))
// 在这里,调用 express.static() 方法,快速的对外提供静态资源
app.use(express.static('托管内容文件夹'))
//托管多个静态资源目录,请多次调用 express.static() 函数
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})

路由

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

模块化路由

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

const express = require('express')
const app = express()
// app.use('/files', express.static('./files'))
// 1. 导入路由模块
const router = require('./03.router')
// 2. 注册路由模块
app.use('/api', router)
// 注意: app.use() 函数的作用,就是来注册全局中间件
app.listen(80, () => {
  console.log('http://127.0.0.1')
})
// 这是路由模块
// 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

中间件

全局

const express = require('express')
const app = express()
// 这是定义全局中间件的简化形式
app.use((req, res, 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('http://127.0.0.1')
})

局部

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 1. 定义中间件函数
const mw1 = (req, res, next) => {
  console.log('调用了局部生效的中间件1')
  next()
}
const mw2 = (req, res, next) => {
  console.log('调用了局部生效的中间件2')
  next()
}
// 同时使用多个局部中间件
1、app.get('/', mw1,mw2, (req, res) => {
  res.send('Home page.')
})
2、app.get('/', [mw1,mw2], (req, res) => {
  res.send('Home page.')
})
app.get('/user', (req, res) => {
  res.send('User page.')
})
// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

应用级别的中间件

通过 app.use() 或 app.get()/app.post() 函数,绑定到 app 实例上的中间件

路由级别的中间件

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

错误级别的中间件

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

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 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)
})
// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

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

Express 内置的中间件

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

第三方的中间件

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

① 运行 npm install body-parser 安装中间件 ② 使用 require 导入中间件 ③ 调用 app.use() 注册并使用中间件

自定义中间件

实现步骤: ① 定义中间件 ② 监听 req 的 data 事件 ③ 监听 req 的 end 事件 ④ 使用 querystring 模块解析请求体数据 ⑤ 将解析出来的数据对象挂载为 req.body ⑥ 将自定义中间件封装为模块

定义中间件 使用 app.use() 来定义全局生效的中间件

赋值变量.use((req,res,next)=>{})

监听 req 的 data 事件 在中间件中,需要监听 req 对象的 data 事件,来获取客户端发送到服务器的数据。如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 data 事件可能会触发多次,每一次触发 data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。

//定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
  //监听 req 的 data 事件
  req.on('data', (chunk) => {
    str += chunk
  })

监听 req 的 end 事件 当客户端最终把所有数据发送到服务器之后,会自动触发 req 的 end 事件。 因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。

// 监听 req 的 end 事件
  req.on('end', () => {
    // 在 str 中存放的是完整的请求体数据
    // console.log(str)
    // TODO: 把字符串格式的请求体数据,解析成对象格式
    const body = qs.parse(str)
    req.body = body
    next()
  })

使用 querystring 模块解析请求体数据 Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse() 函数,可以轻松把查询字符串,解析成对象的格式。

 //导入node内置模块 querystring 模块
const qs=require('querystring')
const body=qs.parse(str)

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

为了方便在后续的业务处理流程中,能够直接访问当前中间件解析出来的请求体对象,我们将解析出来的数据,挂载为 req 的自定义属性,命名为 req.body

// 监听 req 的 end 事件
  req.on('end', () => {
    // 在 str 中存放的是完整的请求体数据
    // console.log(str)
    // TODO: 把字符串格式的请求体数据,解析成对象格式
    const body = qs.parse(str)
    req.body = body
    next()
  })

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

使用 Express 写接口

创建基本的服务器==>创建 API 路由模块

// 导入 express
const express = require('express')
// 创建服务器实例
const app = express()
// 导入路由模块
const router = require('./16.apiRouter')
// 把路由模块,注册到 app 上
app.use('/api', router)
// 启动服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})
​
const express = require('express')
const router = express.Router()
定义接口
module.exports = router

编写 GET 接口/编写 POST 接口

//定义 GET 接口
router.get('/get', (req, res) => {
  // 通过 req.query 获取客户端通过查询字符串,发送到服务器的数据
  const query = req.query
  // 调用 res.send() 方法,向客户端响应处理的结果
  res.send({
    status: 0, // 0 表示处理成功,1 表示处理失败
    msg: 'GET 请求成功!', // 状态的描述
    data: query, // 需要响应给客户端的数据
  })
})

// 定义 POST 接口
router.post('/post', (req, res) => {
  // 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
  const body = req.body
  // 调用 res.send() 方法,向客户端响应结果
  res.send({
    status: 0,
    msg: 'POST 请求成功!',
    data: body,
  })
})
CORS 跨域资源共享

解决接口跨域问题的方案主要有两种: ① CORS(主流的解决方案,推荐使用) ② JSONP(有缺陷的解决方案:只支持 GET 请求)

使用 cors 中间件解决跨域问题

cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。 使用步骤分为如下 3 步: ① 运行 npm install cors 安装中间件 ② 使用 const cors = require('cors') 导入中间件 ③ 在路由之前调用 app.use(cors()) 配置中间件

CORS 的注意事项 ① CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。 ② CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)

上一篇:初步认识express,并创建web服务器,挂载静态资源


下一篇:初识Express和Express路由和中间件