• Nodejs -- 一文了解Express模块

    文章目录

    1. 初识Express

    1.1 Express简介

    官网：Express - Node.js web application framework (expressjs.com)

    1.1.1 什么是Express

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

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

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

    1.1.2 进一步理解Express

    • 思考：不使用Express能否创建Web服务器？
      • 答案：能，使用Node.js提供的原生http模块即可。
    • 思考：既生瑜何生亮（有了http内置模块，为什么还有用Express)?
      • 答案：http内置模块用起来很复杂，开发效率低；Express是基于内置的http模块进一步封装出来的，能够极大的提高开发效率。
    • 思考：http内置模块与Express是什么关系？
      • 答案：类似于浏览器中Web API和jQuery的关系。后者是基于前者进一步封装出来的。

    1.1.3 Express能做什么

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

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

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

    1.2 Express的基本使用

    1.2.1 安装

    在项目所处的目录中，运行如下的终端命令，即可将express安装到项目中使用：

    npm i express

    • 1

    1.2.2 基本使用

    创建最基本的服务器

    // 导入express
const express = require('express')

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

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

// get方法
app.get('/user', (req, res) => {
    res.send({name: "huo", age: 20, gender: "男"})
})

// post方法
app.post('/user', (req, res) => {
    res.send("请求成功")
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20

    1.2.3 监听GET请求

    通过app.get()方法，可以监听客户端的GET请求，具体的语法格式如下：

    app.get()接受两个参数

    • 参数1：客户端请求地址的URL
    • 参数2：请求对应的处理函数
      • req：请求对象（包含了与请求相关的属性和方法）
      • res：相应对象（包含了与响应相关的属性与方法）

    1.2.4 监听POST请求

    与GET处理方法一致

    通过app.post()方法，可以监听客户端的POST请求，具体的语法格式如下：

    app.gpost()接受两个参数

    • 参数1：客户端请求地址的URL
    • 参数2：请求对应的处理函数
      • req：请求对象（包含了与请求相关的属性和方法）
      • res：相应对象（包含了与响应相关的属性与方法）

    1.2.5 把内容响应给客户端

    通过res.send()方法，可以把处理好的内容，发送给客户端

    // get方法
app.get('/user', (req, res) => {
    res.send({name: "huo", age: 20, gender: "男"})
})

    • 1
    • 2
    • 3
    • 4

    1.2.6 获取URL中携带的查询参数

    通过req.quey对像，可以访问到客户端通过查询字符串的形式，发送到服务器的参数：

    • req.query默认是一个空对象
    • 客户端使用?name=zs&age=20这种查询字符串形式，发送到服务器的参数可以通过req.query对像访问到
    • 如：req.query.namereq.query.age
    // 导入express
const express = require('express')

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

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

app.get('/user', (req, res) => {
    console.log(req.query)
    res.send(req.query)
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15

    image-20221128145230629

    1.2.7 获取URL中的动态参数

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

    冒号是固定写法，后面的字符串是一个合法的变量名就可以，获取的时候使用req.params.{paramName}

    app.get('/user/:id/:name', (req, res) => {
    // 这里的 :id 是一个动态参数, 默认是一个空对象
    console.log(req.params)
    res.send(req.params)
})

    • 1
    • 2
    • 3
    • 4
    • 5

    image-20221128145800308

    1.3 托管静态资源

    1.3.1 expess.static()

    express提供了一个非常好用的函数，叫做express.static()，通过它，我们可以非常方便地创建一个静态资源服务器，例如，通过如下代码就可以将public目录下的图片、CSS文件、JavaScript文件对外开放访问了：

    app.use(express.static('public')) // 其中传入的参数是要作为静态资源的目录

    • 1

    后续就可以访问public目录中的所有文件

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

    image-20221128150017861

    1.3.2 托管多个静态资源目录

    如果要托管多个静态资源目录，请多次调用express.static()函数：

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

    • 1
    • 2

    访问静态资源文件时，express.static()函数会根据目录的添加顺序查找所需的文件。

    如果在前面的文件夹找到了对应文件，就不会在后面的文件夹里面找了

    1.3.3 挂载路径前缀

    如果希望在托管的静态资源访问路径之前，挂载路径前缀，则可以使用如下的方式：

    app.use("/public", express.static("public"))

    • 1

    一般都会加一个和文件夹同名的前缀

    然后就可以通过带有/public前缀地址来访问public目录中的文件了：

    image-20221128150820109

    1.4 nodeman

    1.4.1 为什么要使用 nodemon

    在编写调试Node.js项目的时候，如果修改了项目的代码，则需要频繁的手动close掉，然后再重新启动，非常繁琐。

    现在，我们可以使用nodemon(https://www.npmjs.com/package/nodemon)这个工具，它能够监听项目文件的变动，当代码被修改后，nodemon会自动帮我们重启项目，极大方便了开发和调试。

    1.4.2 安装nodemon

    在cmd中运行下面命令即可在全局安装

    npm i -g nodemon

    • 1

    1.4.3 使用nodemon

    当基于Node.js编写了一个网站应用的时候，传统的方式，是运行node app.js命令，来启动项目。这样做的坏处是：代码被修改之后，需要手动重启项目。

    现在，我们可以将node命令替换为nodemon命令，使用**nodemon app.js**来启动项目。这样做的好处是：代码被修改之后，会被nodemon监听到，从而实现自动重启项目的效果

    2. Express路由

    2.1 路由的概念

    2.1.1 什么是路由

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

    2.1.2 显示生活中的路由

    image-20221128152210506

    2.1.3 Express中的路由

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

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

    app.METHOD(PATH, HANDLER)

    • 1

    2.1.4 Express中路由的例子

    //四配GET清求，且请求URL为/
app.get('/',function (req,res){
    res.send('Hello World!')
})

//匹配POST请求，且请求URL为/
app.post('/',function (req,res){
    res.send('Got a POST request')
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9

    2.1.5 路由的匹配过程

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

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

    image-20221128152608226

    路由匹配的注意点：

    • 按照定义的先后顺序进行匹配
    • 请求类型和请求的URL同时匹配成功，才会调用对应的处理函数

    2.2 路由的使用

    2.2.1 最简单的用法

    在Express中使用路由最简单的方式，就是把路由挂载到app上，示例代码如下：

    // 导入express
const express = require('express')

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

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

// 挂载路由
app.get('/user', (req, res) => {
    console.log(req.query)
    res.send(req.query)
})

app.post('/user', (req, res) => {
    res.send("请求成功")
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20

    但是当项目比较大的时候，会导致app上挂载了过多的路由，所以一般不会采用这种方式挂载

    2.2.2 模块化路由

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

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

    • 创建路由模块对应的js文件
    • 调用express.Router0()数创建路由对象
    • 向路由对象上挂载具体的路由
    • 使用module.exports向外共享路由对象
    • 使用app.use()函数注册路由模块

    index.js

    // 导入express
const express = require('express')
const router = require("./router")

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

// 挂载路由
app.use(router)

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14

    router.js

    const express = require("express")
const router = express.Router()

router.get('/user', (req, res) => {
    console.log(req.query)
    res.send(req.query)
})

router.get('/user/:id/:name', (req, res) => {
    // 这里的 :id 是一个动态参数
    console.log(req.params)
    res.send(req.params)
})

router.post('/user', (req, res) => {
    res.send("请求成功")
})

module.exports = router

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19

    2.2.3 为路由模块添加统一前缀

    类似于托管静态资源时，为静态资源统一挂载访问前缀一样，路由模块添加前缀的方式也非常简单：

    const router = require("./router")

// 挂载路由，添加统一前缀 /api
app.use("/api", router)

    • 1
    • 2
    • 3
    • 4

    3. Express中间件

    app.use()的作用就是用来注册全局中间件

    3.1 中间件的概念

    3.1.1 什么是中间件

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

    3.1.2 现实生活中的例子

    在处理污水的时候，一般都要经过三个处理环节，从而保证处理过后的废水，达到排放标准。

    处理污水的这三个中间处理环节，就可以叫做中间件。

    中间件一般都有输入和输出，上一级的输出作为下一级的输入

    image-20221128154031834

    3.1.3 Express中间件的调用流程

    当一个请求到达Express的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理

    image-20221128154134575

    3.1.4 Express的中间件的格式

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

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

    区分一个函数是中间件函数还是路由函数就区分参数列表有几个即可

    image-20221128154357435

    3.1.5 next函数的作用

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

    image-20221128155029795

    3.2 Express中间件初体验

    3.2.1 定义中间件函数

    可以通过如下方式，定义一个最简单的中间件函数

    const express = require("express")

app = express()

// 定义一个中间件函数
const middleware = (req, res, next) => {
    console.log("进入了自定义中间件函数")

    // 把流转关系，转交给下一个中间件或者路由
    next()
}

app.listen(80, () => {
    console.log("server start")
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15

    3.2.2 全局生效的中间件

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

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

    // 定义一个中间件函数
const middleware = (req, res, next) => {
    console.log("进入了自定义中间件函数")

    // 把流转关系，转交给下一个中间件或者路由
    next()
}

// 注册为全局生效的中间件
app.use(middleware) 

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10

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

    直接在app.use()中传入函数

    // 注册为全局生效的中间件的简化形式
app.use((req, res, next) => {
    console.log("进入了自定义中间件函数")
    // 把流转关系，转交给下一个中间件或者路由
    next()
}) 

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

    3.2.4 中间件的作用

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

    image-20221128160937112

    例如：为所有请求设置到达服务器的时间，后续就可以通过req.startTime访问开始时间

    app.use((req, res, next) => {
    const time = Date.now()
    req.startTime = time
    
    next()
})

app.get("/user", (req, res)=>{
    console.log(req.startTime)
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10

    3.2.5 定义多个全局中间件

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

    app.use((req, res, next) => {
    console.log("第一个中间件")
    next()
})

app.use((req, res, next) => {
    console.log("第二个中间件")
    next()
})

app.get("/user", (req, res)=>{
    console.log(req.startTime)
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13

    3.2.6 局部生效的中间件

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

    const mw = (req, res, next) => {
    console.log("这是中间件函数")
    next()
}

//mw只在当前路由中生效，这种用法属于“局部生效”的中间件
app.get("/user", mw, (req, res) => {
    res.send('success')
})

// mw 这个中间件不会影响下面这个路由
app.get("/user", (req, res) => {
    res.send("success")
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14

    3.2.7 定义多个局部中间件

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

    //以下两种写法是"完全等价"的，可根据自己的喜好，选择任意一种方式进行使用
app.get('/', mw1, mw2, (req,res)=>res.send('Home page.')}
app.get('/', [mw1 ,mw2], (req,res)=>{res.send('Home page.')})

    • 1
    • 2
    • 3

    3.2.8 了解中间件的五个注意事项

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

    3.3 中间件的分类

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

    • 应用级别的中间件
    • 路由级别的中间件
    • 错误级别的中间件
    • Express内置的中间件
    • 第三方的中间件

    3.3.1 应用级别的中间件

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

    只要是直接通过app.xxx调用的，都可以理解为是应用级别的中间件

    // 应用级别的中间件（全局中间件）
app.use((req, res, next) => {
    console.log("这是中间件函数")
    next()
})

// 应用级别的中间件（局部中间件）
app.get("/user", mw, (req, res) => {
    res.send('success')
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10

    3.3.2 路由级别的中间件

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

    const express = require("express")
const router = express.Router()

// 路由级别的中间件
router.use((req, res, next) => {
    console.log("Time: ", Date.now())
    next()
})

module.exports = router

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10

    3.3.3 错误级别的中间件

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

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

    // 路由
app.get("/user", (req, res) => {
    throw new Error("服务器内部发生了错误！")
    res.send("Home Page")
})

// 错误级别的中间件，捕获整个项目的异常错误
app.use((err, req, res, next) => {
    console.log("Error: " + err.message)
    res.send("Error: " + err.message)
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11

    错误级别的中间件，必须注册在所有路由之后，如果放在前面会导致在该中间件之后的错误无法被捕获

    3.3.4 Express内置的中间件

    自Express4.16.0版本开始，Express内置了3个常用的中间件，极大的提高了Express项目的开发效率和体验：

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

// 配置解析 application/x-www-form-urlencoded 格式数据的内置中间件
app.use(express.urlencoded({ extended: false }))

app.post('/user', (req, res)=>{
	// 在服务器, 可以使用 req.body 这个属性，来接受客户端端发过来的请求体数据
    // 在默认情况下，如果把配置解析表单数据的中间价， 则 req.body 默认等于 undefined
    console.log(req.body)
    res.send('ok')
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12

    除了错误级别的中间件，其他的中间件，必须在路由之前进行配置

    3.3.5 第三方中间件

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

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

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

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

    3.4 自定义中间件

    3.4.1 需求描述与实现步骤

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

    1. 定义中间件
    2. 监听req的data事件
    3. 监听req的end事件
    4. 使用querystring模块解析请求体数据
    5. 将解析出来的数据对象挂载为req.body
    6. 将自定义中间件封装为模块

    3.4.2 定义中间件

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

    app.use((req, res, next) => {
    // 中间件的业务逻辑
	next()
})

    • 1
    • 2
    • 3
    • 4

    3.4.3 监听req的data事件

    在中间件中，需要监听req对象的data事件，来获取客户端发送到服务器的数据。

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

    // 1. 定义一个 str 字符串，专门用来存储客户端发送过来的请求体数据
let str = ''

// 2. 监听 req 的data事件
req.on('data', (chunk) => {
    str += chunk
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    3.4.4 监听req的end事件

    当请求体数据接收完毕之后，会自动触发req的end事件。

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

    // 3. 监听 req 对象的 end 事件
req.on('end', () => {
    // 在str中存放的就是完整的请求体数据
    console.log(str)
})

    • 1
    • 2
    • 3
    • 4
    • 5

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

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

    const qs = require('querystring')

const body = qs.parse(str)

    • 1
    • 2
    • 3

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

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

    // 3. 监听 req 对象的 end 事件
req.on('end', () => {
    // 在str中存放的就是完整的请求体数据
    const body = qs.parse(str)
    req.body = body
    console.log("中间件", req.body)
    next()
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    3.4.7 自定义中间件

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

    //custom-body-parser.js 模块中的代码
const qs = require('querystring')
function bodyParser(req,res,next){/*省略其它代码*/}
module.exports = bodyParser//向外导出解析请求体数据的中间件函数

// ------------------分隔线----------------------
//1,导入自定义的中间件模块
const myBodyParser = require('custom-body-parser')
//2,注册自定义的中间件模块
app.use(myBodyParser)

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10

    3.4.8 最终代码

    index.js

    // 导入express
const express = require('express')
const bodyParser = require('./custom-body-parser')

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

// 解析表单数据的中间件
app.use(bodyParser)

app.post('/user', (req, res) => {
    console.log("路由接口:", req.body)
    res.send(req.body)
})

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19

    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中存放的就是完整的请求体数据
        req.body = qs.parse(str)
        console.log("中间件", req.body)
        next()
    })
}

module.exports = bodyParser

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22

    4. 使用Express写接口

    4.1 创建基本的服务器

    // 导入express
const express = require('express')

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

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10

    4.2 创建API路由模块

    router.js

    const express = require("express")
const router = express.Router()

router.get('/user', (req, res) => {
    console.log(req.query)
    res.send({
        statue: 0,
        msg: 'GET请求成功',
        data: req.query
    })
})
router.post('/user', (req, res) => {
    res.send("请求成功")
})

module.exports = router

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16

    index.js

    // 导入express
const express = require('express')
const router = require("./router")

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

// 挂载路由
app.use("/api", router)

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14

    4.3 编写GET接口

    router.get('/user', (req, res) => {
    console.log(req.query)
    res.send({
        status: 200,
        msg: 'GET请求成功',
        data: req.query
    })
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    4.4 编写POST接口

    如果要获取URL-encoded格式的请求体数据，必须配置中间件app.use(express.urlencoded({extended:false})

    router.post('/user', (req, res) => {
    console.log(req.body)
    res.send({
        status: 200,
        msg: "POST请求成功",
        data: req.body
    })
})

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    index.js

    // 配置urlencoded
app.use(express.urlencoded({extended: false}))

// 挂载路由
app.use("/api", router)

    • 1
    • 2
    • 3
    • 4
    • 5

    4.5 CORS 跨域资源共享

    4.5.1 接口的跨域问题

    刚才编写的GET和POST接口，存在一个很严重的问题：不支持跨域请求。

    例如在浏览器中通过ajax调用刚刚的接口会出现如下报错

    image-20221128205539513

    只要使用的协议，域名或者端口号有一个不同，就会出现跨域问题

    解决接口跨域问题的方案主要有两种：

    • CORS(主流的解决方案，推荐使用)
    • JSONP(有缺陷的解决方案：只支持GET请求)

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

    cors是Express的一个第三方中间件。通过安装和配置cors中间件，可以很方便地解决跨域问题。

    使用步骤分为如下3步：

    • 运行npm install cors安装中间件
    • 使用const cors=require('cors)导入中间件
    • 在路由之前调用app.use(cors())配置中间件
    // 导入express
const express = require('express')
const router = require("./router")

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

// 配置urlencoded
app.use(express.urlencoded({extended: false}))

// 在路由之前，配置cors这个中间件，从而解决接口跨域的问题
const cors = require('cors')
app.use(cors())

// 挂载路由
app.use("/api", router)

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

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21

    4.5.3 什么是CORS

    CORS(Cross-Origin Resource Sharing, 跨域资源共享)由一系列HTTP响应头组成，这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源。

    浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了CORS相关的HTTP响应头，就可以解除浏览器端的跨域访问限制。

    image-20221128205918700

    4.5.4 CORS的注意事项

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

    4.5.5 CORS响应头部 - Access-Control-Allow-Origin

    响应头部中可以携带一个Access-Control-Allow-Origin字段，其语法如下：

    Access-Control-Allow-Origin:  | *

    • 1

    其中，origin参数的值指定了允许访问该资源的外域URL。

    例如，下面的字段值将只允许来自http://baidu.com的请求：

    res.setHeader('Access-Control-Allow-Origin', 'http://baidu.com')

    • 1

    如果指定了Access-Control–Allow-Origin字段的值为通配符*，表示允许来自任何域的请求，示例代码如下：

    res.setHeader('Access-Control-Allow-Origin', '*')

    • 1

    4.5.6 CORS响应头部 - Access-Control-Allow-Headers

    默认情况下，CORS仅支持客户端向服务器发送如下的9个请求头：

    Accept、Accept-Language、Content–Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type(值仅限于text/plain、multipart/form-data、application,/x-www-form-urlencoded三者之一)

    如果客户端向服务器发送了额外的请求头信息，则需要在服务器端，通过Access-Control-Allow-Headers对额外的请求头进行声明，否则这次请求会失败！

    注意：多个请求头之间使用英文逗号分隔

    // 允许客户端额外想服务器发送 Content-Type 请求头和 X-Custom-Header 请求头
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')

    • 1
    • 2

    4.5.7 CORS响应头部 - Access-Control-Allow-Methods

    默认情况下，CORS仅支持客户端发起GET、POST、HEAD请求。

    如果客户端希望通过PUT、DELETE等方式请求服务器的资源，则需要在服务器端，通过Access-Control–Alow-Methods来指明实际请求所允许使用的HTTP方法。

    示例代码如下：

    // 只允许 POST, GET, DELETE, HEAD 方法
res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD')

// 允许所有的HTTP请求方法
res.setHeader('Access-Control-Allow-Methods', '*')

    • 1
    • 2
    • 3
    • 4
    • 5

    4.5.8 CORS请求的分类

    客户端在请求CORS接口时，根据请求方式和请求头的不同，可以将CORS的请求分为两大类，分别是：

    • 简单请求
    • 预检请求

    4.5.9 简单请求

    同时满足以下两大条件的请求，就属于简单请求：

    • 请求方式：GET、POST、HEAD三者之一
    • HTTP头部信息不超过以下几种字段：无自定义头部字段、Accept、Accept-.Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type(只有三个值application/x-www-form-urlencoded, multipart/form-data, text/plain)

    4.5.10 预检请求

    简单请求的对立面

    只要符合以下任何一个条件的请求，都需要进行预检请求：

    • 请求方式为GET、POST、HEAD之外的请求Method类型
    • 请求头中包含自定义头部字段
    • 向服务器发送了application/json格式的数据

    在浏览器与服务器正式通信之前，浏览器会先发送OPTION请求进行预检，以获知服务器是否允许该实际请求，所以这一次的OPTION请求称为"预检请求”。服务器成功响应预检请求后，才会发送真正的请求，并且携带真实数据。

    4.5.11 简单请求与预检请求的区别

    • 简单请求的特点：客户端与服务器之间只会发生一次请求。
    • 预检请求的特点：客户端与服务器之间会发生两次请求，OPTION预检请求成功之后，才会发起真正的请求。

    image-20221128211519856

    4.6 JSONP接口

    4.6.1 JSONP的概念与特点

    概念：浏览器端通过