📂node.js
🔖node.jsJavaScript
2023-03-13 23:07阅读: 91评论: 0推荐: 0

express

Express 简介

  1. 什么是 Express
    官方给出的概念：Express 是基于 Node.js 平台，快速、开放、极简的 Web 开发框架。
    通俗的理解：Express 的作用和 Node.js 内置的 http 模块类似，是专门用来创建 Web 服务器的。
    Express 的本质：就是一个 npm 上的第三方包，提供了快速创建 Web 服务器的便捷方法。
    Express 的中文官网： http://www.expressjs.com.cn/
  2. 进一步理解 Express
    思考：不使用 Express 能否创建 Web 服务器？
    答案：能，使用 Node.js 提供的原生 http 模块即可。
    思考：既生瑜何生亮（有了 http 内置模块，为什么还有用 Express）？
    答案：http 内置模块用起来很复杂，开发效率低；Express 是基于内置的 http 模块进一步封装出来的，能够极大的提高开发效率。
    思考：http 内置模块与 Express 是什么关系？
    答案：类似于浏览器中 Web API 和 jQuery 的关系。后者是基于前者进一步封装出来的。
  3. Express 能做什么
    对于前端程序员来说，最常见的两种服务器，分别是：
    ⚫ Web 网站服务器：专门对外提供 Web 网页资源的服务器。
    ⚫ API 接口服务器：专门对外提供 API 接口的服务器。
    使用 Express，我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。

Express 的基本使用

  1. 安装
    在项目所处的目录中，运行如下的终端命令，即可将 express 安装到项目中使用：
    npm i express默认安装最新版本
    npm i express@版本号安装指定版本
  2. 创建基本的 Web 服务器
// 1. 导入 express
const express= require('express')
// 2. 创建 web 服务器实例
const app=express()
// 3. 启动 web 服务器
app.listen(8080,()=>{
    console.log("Server is running at https://127.0.0.1:8080");
})
  1. 监听 GET 请求
    通过 app.get() 方法，可以监听客户端的 GET 请求，具体的语法格式如下：
    image
  2. 监听 POST 请求
    通过 app.post() 方法，可以监听客户端的 POST 请求，具体的语法格式如下：
    image
  3. 把内容响应给客户端
    通过 res.send() 方法，可以把处理好的内容，发送给客户端：
// 监听客户端的 GET 和 POST 请求，并向客户端响应具体的内容
app.get("/user",(req,res)=>{
    let json={
        "name":'zs',
        "age":"18"
    }
    // 调用 express 提供的 res.send() 方法，向客户端响应一个 JSON 对象
    res.send(json)
    console.log(json);
})
 
app.post("/",(req,res)=>{
    // 调用 express 提供的 res.send() 方法，向客户端响应一个 文本字符串
    res.send("请求类型是"+req.method)
    console.log("请求类型是"+req.method);
})

image
image

  1. 获取 URL 中携带的查询参数
    通过 req.query 对象，可以访问到客户端通过查询字符串的形式，发送到服务器的参数，默认情况下，req.query 是一个空对象
    地址栏中查询参数的格式?name=xxx&age=18，以?开头表示后接查询参数，参数名=参数值，不同参数之间以&隔开
    image
app.get("/user",(req,res)=>{
  // 通过 req.query 可以获取到客户端发送过来的 查询参数
    res.send(req.query)
    console.log(req.query);
})

image
7. 获取 URL 中的动态参数
通过 req.params 对象，可以访问到 URL 中，通过 : 匹配到的动态参数：
image

app.post("/user/:name/:age",(req,res)=>{
    // 调用 express 提供的 res.send() 方法，向客户端响应一个 文本字符串
    res.send(req.params)
    console.log(req.params);
})

image

托管静态资源

  1. express.static()
    app.use('前缀地址', express.static(目录名/目录路径))
    express 提供了一个非常好用的函数，叫做 express.static()，通过它，我们可以非常方便地创建一个静态资源服务器，
    例如，通过如下代码就可以将 public 目录下的文件对外开放访问了：
    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. 托管多个静态资源目录
    如果要托管多个静态资源目录，请多次调用 express.static() 函数：
    访问静态资源文件时，express.static() 函数会根据目录的添加顺序查找所需的文件, 查找到文件后就不会往下查找了。
app.use(express.static('./clock'))// 或app.use(express.static('clock'))
app.use(express.static('./files'))// 或app.use(express.static('files'))

image
如图clock和files文件夹下都有index.html文件，因为app.use(express('clock'))在app.use(express('files'))前面，所以会优先返回clock下的index.js文件
image
调换顺序，则返回files中的index.html

app.use(express.static('files'))
app.use(express.static('clock'))

image
image

  1. 挂载路径前缀
    如果希望在托管的静态资源访问路径之前，挂载路径前缀，则可以使用如下的方式：
    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

  1. 为什么要使用 nodemon
    在编写调试 Node.js 项目的时候，如果修改了项目的代码，则需要频繁的手动 close 掉，然后再重新启动，非常繁琐。
    现在，我们可以使用 nodemon（https://www.npmjs.com/package/nodemon） 这个工具，它能够监听项目文件的变动，当代码被修改并被保存后，nodemon 会自动帮我们重启项目，极大方便了开发和调试。
  2. 安装 nodemon
    在终端中，运行如下命令，即可将 nodemon 安装为全局可用的工具：
    npm i nodemon -g
  3. 使用 nodemon
    当基于 Node.js 编写了一个网站应用的时候，传统的方式，是运行 node app.js 命令，来启动项目。这样做的坏处是：代码被修改之后，需要手动重启项目。
    现在，我们可以将 node 命令替换为 nodemon 命令，使用 nodemon app.js 来启动项目。这样做的好处是：代码被修改之后，会被 nodemon 监听到，从而实现自动重启项目的效果
    image

image

Express路由

  1. 什么是路由
    广义上来讲，路由就是映射关系。

  2. 现实生活中的路由
    image
    按键 1 -> 业务查询
    按键 2 -> 手机充值
    按键 3 -> 业务办理
    按键 4 -> 密码服务与停复机
    按键 5 -> 家庭宽带
    按键 6 -> 话费流量
    按键 8 -> 集团业务
    按键 0 -> 人工服务
    在这里，路由是按键与服务之间的映射关系

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

  4. 路由的匹配过程
    每当一个请求到达服务器之后，需要先经过路由的匹配，只有匹配成功之后，才会调用对应的处理函数。
    在匹配时，会按照路由的顺序进行匹配，如果请求类型和请求的 URL 同时匹配成功，则 Express 会将这次请求，转交给对应的 function 函数进行处理。
    路由匹配的注意点：
    ① 按照定义的先后顺序进行匹配
    ② 请求类型和请求的URL同时匹配成功，才会调用对应的处理函数
    image

  5. 使用方法

    1. 最简单的用法(使用较少)
      在 Express 中使用路由最简单的方式，就是把路由挂载到 app 上，示例代码如下：
    		// 引入express模块
    		const express= require('express')
    		// 创建 web 服务器实例
    		const app =express()
    		// 挂载路由
    		app.get('/',(req,res)=>{
    		    res.send('url:'+req.url+', \r\n'+'请求类型: '+req.method)
    		})
    		app.post('/',(req,res)=>{
    		    res.send('url:'+req.url+', \r\n'+'请求类型: '+req.method)
    		})
    		// 启动服务器
    		app.listen(8080,()=>{
    		    console.log("Server is running at http://127.0.0.1:8080");
    		})

    image

    image

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

    创建路由模块来专门存放路由：03_myRouter.js

    		// 路由模块
    		// 导入express模块
    		const express =require('express')
    		// 创建路由对象
    		const router=express.Router()
    		// 将路由挂载到路由对象上
    		router.get('/user/list',(req,res)=>{
    		    res.send(`url:${req.url},\r\n请求类型: ${req.method}`)
    		})
    		//req.url不包含固定前缀
    		router.post('/user/add',(req,res)=>{
    		    res.send(`url:${req.url},\r\n请求类型: ${req.method}`)
    		})
    		// 向外导出路由对象。因为router本来就是对象，且这里只需暴露一个对象，所以可以直接赋值给module.exports，而不用用{}括起来
    		module.exports=router

    注册路由模块来使用路由：02_myOwn模块化路由.js

    		const express=require('express')
    		const app =express()
    		// 1. 导入路由模块
    		const router=require('./03_myRouter.js')
    		// 2. 注册路由模块。第一个参数表示地址栏的固定前缀，如果不需要加固定前缀可以省略该参数
    		app.use('/api',router)
    		app.listen(8080,()=>{
    		    console.log('Server is running at http://127.0.01:8080');
    		})

    image

    image

Express 中间件

中间件的概念

  1. 什么是中间件
    中间件（Middleware ），特指业务流程的中间处理环节。
  2. 现实生活中的例子
    在处理污水的时候，一般都要经过三个处理环节，从而保证处理过后的废水，达到排放标准。
    image
    处理污水的这三个中间处理环节，就可以叫做中间件
  3. Express 中间件的调用流程
    当一个请求到达 Express 的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理。
    image
  4. Express 中间件的格式
    Express 的中间件，本质上就是一个 function 处理函数，Express 中间件的格式如下：
    image
    注意：中间件函数的形参列表中，必须包含 next 参数。函数体最后必须调用next(), 而路由处理函数中只包含 req 和 res。
  5. next 函数的作用
    next 函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由。
    image

Express 中间件の初体验

  1. 定义中间件函数
    可以通过如下的方式，定义一个最简单的中间件函数
    image
  2. 全局生效的中间件
    客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件。
    通过调用 app.use(中间件函数)，即可定义一个全局生效的中间件，示例代码如下：
    image
    或
    image
  3. 中间件的作用
    多个中间件之间，共享同一份 req 和 res。基于这样的特性，我们可以在上游的中间件中，统一为 req 或 res 对象添加自定义的属性或方法，供下游的中间件或路由进行使用。
    就是路由会用到的公共属性或方法可以定义到中间件中，这样路由就可以直接调用这些属性或方法，就不用单独为每一个路由添加相应的属性或方法了。有点像原型链上的继承
    image

例如：要使每一个路由执行后打印出执行时的时间

const express = require('express')
const app = express()
 
// 这是定义全局中间件的简化形式
app.use((req, res, next) => {
  // 获取到请求到达服务器的时间
  // 新建一个时间对象，并转换成当地的格式，未将时间字符串传入Date()就是返回new Date()代码执行时的时间的字符串
  const time = (new Date()).toLocaleString()
  // 为 req 对象，挂载自定义属性，从而把时间共享给后面的所有路由
  req.startTime = time
  next()
})
// 路由1
app.get('/', (req, res) => {
  res.send('Home page.' + req.startTime)
})
// 路由2
app.get('/user', (req, res) => {
  res.send('User page.' + req.startTime)
})
app.listen(8080, () => {
  console.log('http://127.0.0.1:8080')
})

image

image

  1. 定义多个全局中间件
    可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后，会按照中间件定义的先后顺序依次进行调用，示例代码如下
const express = require('express')
const app = express()
 
// 定义第一个全局中间件
app.use((req, res, next) => {
  console.log('调用了第1个全局中间件')
  next()
})
// 定义第二个全局中间件
app.use((req, res, next) => {
  console.log('调用了第2个全局中间件')
  // res.sent("调用了第2个全局中间件") //中间件中调用res.sent()会报错，但不知道为什么
  next()
})
 
// 定义一个路由
app.get('/user', (req, res) => {
  res.send('User page.')
})
 
app.listen(8080, () => {
  console.log('http://127.0.0.1:8080')
})

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

  1. 定义多个局部中间件
    可以在路由中，通过如下两种等价的方式，使用多个局部中间件：
    image
  2. 了解中间件的5个使用注意事项
    ① 一定要在路由之前注册中间件
    ② 客户端发送过来的请求，可以连续调用多个中间件进行处理
    ③ 执行完中间件的业务代码之后，不要忘记调用 next() 函数
    ④ 为了防止代码逻辑混乱，调用 next() 函数后不要再写额外的代码
    ⑤ 连续调用多个中间件时，多个中间件之间，共享 req 和 res 对象

中间件的分类

为了方便大家理解和记忆中间件的使用，Express 官方把常见的中间件用法，分成了 5 大类，分别是：
① 应用级别的中间件
② 路由级别的中间件
③ 错误级别的中间件
④ Express 内置的中间件
⑤ 第三方的中间件

  1. 应用级别的中间件
    通过 app.use() 或 app.get() 或 app.post() ，绑定到 app 实例上的中间件，叫做应用级别的中间件，代码示例如下
    image
  2. 路由级别的中间件
    绑定到 express.Router() 实例上的中间件，叫做路由级别的中间件，也可以定义局部和全局的中间件。它的用法和应用级别中间件没有任何区别。只不过，应用级别中间件是绑定到 app=express() 实例上，路由级别中间件绑定到 router=express.Router() 实例上，代码示例如下：
    image
// 路由模块
// 导入express模块
const express =require('express')
// 创建路由对象
const router=express.Router()
const mw=function(req,res,next){
    console.log("定义了一个中间件，但还不确定是不是全局的");
    next()
}
// 以这种方式生成的是全局中间件
router.use(mw)
router.use((req,res,next)=>{
    console.log("定义了一个全局中间件");
    next()
})
// 将路由挂载到路由对象上
// 当中间件函数绑定到路由上时，生成的是局部中间件
router.get('/user/list', mw, (req,res)=>{
    res.send(`url:${req.url},\r\n请求类型: ${req.method}`)
})
router.post('/user/add',(req,res)=>{
    res.send(`url:${req.url},\r\n请求类型: ${req.method}`)
})
// 向外导出路由对象。因为router本来就是对象，且这里只需暴露一个对象，所以可以直接赋值给module.exports，而不用用{}括起来
module.exports=router

以http://127.0.0.1:8080/api/user/add 发送POST请求
image
image
以http://127.0.0.1:8080/api/user/add 发送GET请求
image
image
3. 错误级别的中间件
错误级别中间件的作用：专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题。
格式：错误级别中间件的 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('服务器内部发生了错误！')//并且定义了err.message='服务器内部发生了错误！'
  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(8080, function () {
  console.log('Express server running at http://127.0.0.1:8080')
})

image

image
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+ 版本中可用）
image
没有使用express.json()和express.urlencoded()中间件前，无法解析json和URL-encoded 格式的请求体数据

const express = require('express')
// 创建 express 的服务器实例
const app = express()
app.post('/user', (req, res) => {
  // 在服务器，可以使用 req.body 这个属性，来接收客户端发送过来的请求体数据
  // 默认情况下，如果不配置解析表单数据的中间件，则 req.body 默认等于 undefined
  res.send(req.body)
})
 
app.post('/book', (req, res) => {
  // 在服务器端，可以通过 req.body 来获取 JSON 格式的表单数据和 url-encoded 格式的数据
  res.send(req.body)
 
})
 
// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8080, function () {
  console.log('Express server running at http://127.0.0.1:8080')
})

image

image

image

image

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
 
// 注意：除了错误级别的中间件，其他的中间件，必须在路由之前进行配置
// 通过 express.json() 这个中间件，解析表单中的 JSON 格式的数据
app.use(express.json())
// 通过 express.urlencoded() 这个中间件，来解析 表单中的 url-encoded 格式的数据
app.use(express.urlencoded({ extended: false }))
app.post('/user', (req, res) => {
  // 在服务器，可以使用 req.body 这个属性，来接收客户端发送过来的请求体数据
  // 默认情况下，如果不配置解析表单数据的中间件，则 req.body 默认等于 undefined
  res.send(req.body)
})
 
app.post('/book', (req, res) => {
  // 在服务器端，可以通过 req.body 来获取 JSON 格式的表单数据和 url-encoded 格式的数据
  res.send(req.body)
 
})
 
// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8080, function () {
  console.log('Express server running at http://127.0.0.1:8080')
})

image
image

  1. 第三方的中间件
    非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。
    例如：在 express@4.16.0 之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。使用步
    骤如下：
    ① 运行 npm install body-parser 安装中间件
    ② 使用 require 导入中间件
    ③ 调用 app.use() 注册并使用中间件
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
 
// 1. 导入解析表单数据的中间件 body-parser
const parser = require('body-parser')
// 2. 使用 app.use() 注册中间件
app.use(parser.urlencoded({ extended: false }))
// 等效于app.use(express.urlencoded({ extended: false }))
 
app.post('/user', (req, res) => {
  // 如果没有配置任何 解析表单数据 的中间件，则 req.body 默认等于 undefined
  console.log(req.body)
  res.send('ok')
})
 
// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

注意：Express 内置的 express.urlencoded 中间件，就是基于 body-parser 这个第三方中间件进一步封装出来的。

自定义中间件

  1. 需求描述
    自己手动模拟一个类似于 express.urlencoded 这样的中间件，来解析 POST 提交到服务器的表单数据。
    实现步骤：
    ① 定义中间件
    ② 监听 req 的 data 事件
    ③ 监听 req 的 end 事件
    ④ 使用 querystring 模块解析请求体数据
    ⑤ 将解析出来的数据对象挂载为 req.body
    ⑥ 将自定义中间件封装为模块
  2. 定义中间件函数
    定义中间件函数
const bodyParser = (req, res, next) => {
	...
    next()
}
  1. 监听 req 的 data 事件
    在中间件中，需要监听 req 对象（注意不是app=express()对象）的 data 事件，来获取客户端发送到服务器的数据。
    如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以 data 事件可能会触发多次，每一次触发 data 事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。
    image
  2. 监听 req 的 end 事件
    当请求体数据接收完毕之后，会自动触发 req 的 end 事件。
    因此，我们可以在 req 的 end 事件中，拿到并处理完整的请求体数据。示例代码如下：
    image
  3. 使用 querystring 模块解析请求体数据
    Node.js 内置了一个 querystring 模块，专门用来处理查询字符串。通过这个模块提供的 parse() 函数，可以轻松把查询字符串，解析成对象的格式。示例代码如下：
    image
  4. 将解析出来的数据对象挂载为 req.body
    上游的中间件和下游的中间件及路由之间，共享同一份 req 和 res。因此，我们可以将解析出来的数据赋值给req.body，供下游使用。示例代码如下：
    req.body = qs.parse(str)
  5. 将自定义中间件封装为模块
    为了优化代码的结构，我们可以把自定义的中间件函数，封装为独立的模块，示例代码如下：
    image
    custom-body-parser.js
// 导入 Node.js 内置的 querystring 模块
const qs = require('querystring')
 
const bodyParser = (req, res, next) => {
  // 定义中间件具体的业务逻辑
  // 1. 定义一个 str 字符串，专门用来存储客户端发送过来的请求体数据
  let str = ''
  // 注意是给req绑定事件而不是给app=express()绑定
  // 2. 监听 req 的 data 事件
  req.on('data', (chunk) => {
    str += chunk
  })
  // 3. 监听 req 的 end 事件
  req.on('end', () => {
    // 在 str 中存放的是完整的请求体数据
    // console.log(str)
    // TODO: 把字符串格式的请求体数据，解析成对象格式
    req.body = qs.parse(str)
    // 别忘了最后调用next()转接给路由
    // 注意是在req.on('end',(){})的回调函数末尾调用next()
    next()
  })
  // next() //不是在这里调用next()，但是还是比较疑惑为什么不能在这里调用？
}
// 直接把中间件函数暴露出去
module.exports = bodyParser

主函数入口

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
 
// 1. 导入自己封装的中间件模块
const customBodyParser = require('./14.custom-body-parser')
// 2. 将自定义的中间件函数，注册为全局可用的中间件
// 注意不要写成app.use(customBodyParser())
app.use(customBodyParser)
app.post('/user', (req, res) => {
  res.send(req.body)
})
 
// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8080, function () {
  console.log('Express server running at http://127.0.0.1:8080')
})

image

使用 Express 写接口

  1. 创建基本的服务器
    image
  2. 创建 API 路由模块
    image
  3. 编写 GET 接口
    image
  4. 编写 POST 接口
    image
    注意：如果要获取 URL-encoded 格式的请求体数据，必须配置中间件 app.use(express.urlencoded({ extended: false }))

本文作者：Code6E

本文链接：https://www.cnblogs.com/road2code/p/17213092.html

版权声明：本作品采用知识共享署名-非商业性使用-禁止演绎 2.5 中国大陆许可协议进行许可。

posted @   Code6E  阅读(91)  评论(0)  编辑  收藏  举报
点击右上角即可分享
微信分享提示
SQL AI 助手
💬
评论
📌
收藏
💗
关注
👍
推荐
🚀
回顶
➖
收起
  1. 1 404 not found REOL
404 not found - REOL
00:00 / 00:00
An audio error has occurred.