Node.js 学习三——Express

XYR121212

2136人浏览 · 2024-06-15 22:18:10

XYR121212 · 2024-06-15 22:18:10 发布

Express

1. Express 简介

官方给出的概念：Express 是基于 Node.js 平台，快速、开放、极简的 Web 开发框架。
通俗的理解：Express 的作用和 Node.js 内置的 http 模块类似，是专门用来创建 Web 服务器的。
Express 的本质：就是一个 npm 上的第三方包，提供了快速创建 Web 服务器的便捷方法。

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

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

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

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

1.1 安装

npm i express

1.2 Express 的基本使用

//1.导入express 
const express = require('express');

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

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

可以直接在vscode 终端运行，点击Terminal->New Terminal
在这里插入图片描述

为了避免每次修改都有重新运行js文件，可以下载 nodemon，这样每次保存就可以直接启动服务器。

npm i nodemon

在这里插入图片描述

1.3 监听 GET 请求

app.get('请求URL', function(req, res){
/*处理函数*/
})

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

示例代码

//1.导入express 
const express = require('express');

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

//4.监听客户端的 GET 和 POST 请求，并向客户端响应具体的内容
app.get('/user', (req, res) => {
    //调用 express 提供的 res.send() 方法，向客户端响应一个文本字符串 
    res.send({ name: 'zs', age: 20, gender: '男' })
})

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

浏览器输入http://127.0.0.1:8080/user
在这里插入图片描述
页面显示

1.4 监听 POST 请求

app.post('请求URL', function(req, res){
/*处理函数*/
})

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

示例代码

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

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

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

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

req.query 默认是一个空对象
客户端使用？name =zs & age = 20，可以通过req.query 对象访问到， req.query.name, req.query.age

示例代码

app.get('/', (req, res) => {
    //调用 express 提供的 res.send() 方法，向客户端响应一个文本字符串 
    console.log(req.query);
    res.send(req.query)
})

浏览器输入
在这里插入图片描述
浏览器显示

终端输出

1.6 获取 URL 中的动态参数

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

app.get('/user/:id',(req, res)=>{
  console.log(req.params)
  })

ULR 地址中，可以通过 :参数名的形式，匹配动态参数值
req.params 默认是一个空对象，里面存放这通过动态匹配到的参数值

示例代码

app.get('/user/:id/:username', (req, res) => {
    res.send(req.params)
    console.log(req.params);
})

浏览器输入
在这里插入图片描述
浏览器显示

终端输出

1.7 托管静态资源 express.static()

通过express.static()，我们可以非常方便地创建一个静态资源服务器，例如，通过如下代码就可以将 public 目录下的图片、CSS 文件、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 中。

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

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

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

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

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

2.Express 路由

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

2.1 Express路由组成

Express 中的路由分 3 部分组成，分别是请求的类型、请求的 URL 地址、处理函数
在这里插入图片描述

2.2 路由的匹配过程

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

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

2.3 模块化路由

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

//03.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

const express = require('express')
const app = express()

//1.导入路由模块
const router = require('./03.router.js')

//2. 注册路由模块
app.use(router)

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

blog.csdnimg.cn/direct/c9787b60f79f49159029b3318c53221f.png)
在这里插入图片描述

3. Express 中间件

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

3.1 Express中间件的调用流程

当一个请求到达 Express 的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理。
在这里插入图片描述

3.2 Express中间件的格式

Express 的中间件，本质上就是一个 function 处理函数，Express 中间件的格式如下：
Express 的中间件，本质上就是一个 function 处理函数，Express 中间件的格式如下：
在这里插入图片描述
注意：
中间件函数的形参列表中，必须包含 next 参数。而路由处理函数中只包含 req 和 res。

3.3 next 函数的作用

next 函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由。
在这里插入图片描述

3.4 定义多个全局中间件

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

//这是第一个全局中间件
app.use((req, res, next) => {
    console.log('这是第一个全局中间件')
    next()
})

//这是第二个全局中间件
app.use((req, res, next) => {
    console.log('这是第二个全局中间件')
    next()
})

//这是第三个全局中间件
app.use((req, res, next) => {
    console.log('这是第三个全局中间件')
    next()
})

3.5 局部生效的中间件

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

const nml = function (req, res, nex) {
    console.log('调用了局部生效的中间件');
}

app.get('/', nml, (req, res) => {
    res.send('hello')
})

3.6 定义多个局部中间件

可以在路由中，通过如下两种等价的方式，使用多个局部中间件：
在这里插入图片描述

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

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

4. 中间件的分类

Express 官方把常见的中间件用法，分成了 5 大类，分别是：

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

4.1 应用级别的中间件

通过 app.use() 或 app.get() 或 app.post() ，绑定到 app 实例上的中间件，叫做应用级别的中间件，代码示例如下：
在这里插入图片描述

4.2 路由级别的中间件

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

4.3 错误级别的中间件

错误级别中间件的作用：专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题。
格式：错误级别中间件的 function 处理函数中，必须有 4 个形参，形参顺序从前到后，分别是 (err, req, res, next)。
在这里插入图片描述
注意：
错误级别的中间件，必须注册在所有路由之后！

4.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+ 版本中可用）

//express.json() 这个中间件解析表单中的JSON格式数据
app.use(express.json())

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

在这里插入图片描述

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

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

在这里插入图片描述

4.5 第三方的中间件

非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。
例如：在 express@4.16.0 之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。使用步骤如下：

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

const express = require('express')
// 1. 导入解析表单数据的中间件 body-parser
const parse = require('body-parser')

const app = express()
// 2. 使用 app.use() 注册中间件
app.use(parse.urlencoded({ extended: false }))

app.post('/book', (req, res) => {
    // 如果没有配置任何解析表单数据的中间件，则 req.body 默认等于 undefined
    console.log(req.body)
    res.send('book')
})

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

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

5. 自定义中间件

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

实现步骤：

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

const express = require('express')
// 导入 Node.js 内置的 querystring 模块
const qs = require('querystring')

const app = express()

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

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

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

对自定义的中间块进行模块化拆分

//14.custom-body-parser.js
// 导入 Node.js 内置的 querystring 模块
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', () => {
        //把字符串格式的请求数据，解析成对象格式
        const body = qs.parse(str)
        req.body = body
        next()
    })
}

module.exports = bodyParser

const express = require('express')
// 1. 导入自己封装的中间件模块
const bodyParser = require('./14.custom-body-parser')

const app = express()

// 2. 将自定义的中间件函数，注册为全局可用的中间件
app.use(bodyParser)


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

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

6. 使用 Express 写接口

//16.apiRouter.js
const express = require('express')


const router = express.Router()
// 在这里挂载对应的路由
router.get('/get', (req, res) => {
    // 通过 req.query 获取客户端发送到服务器的数据(查询字符串)
    const query = req.query
    // 调用 res.send() 方法，向客户端响应处理的结果
    res.send({
        status: 0,// 0 表示处理成功，1 表示处理失败
        msg: 'GRT请求成功', // 状态的描述
        data: query// 需要响应给客户端的数据
    })
})


router.post('/post', (req, res) => {
    // 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
    const body = req.body
    res.send({
        status: 1,
        msg: 'POST请求成功',
        data: body
    })
})

router.delete('/delete', (req, res) => {
    res.send({
        status: 0,
        msg: 'DELETE请求成功',
    })
})

module.exports = router

const express = require('express')
// 导入路由模块
const apiRouter = require('./16.apiRouter')

const app = express()

// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))

// 把路由模块，注册到 app 上
app.use('/api', apiRouter)
// 启动服务器
app.listen(80, () => {
    console.log('http://127.0.0.1');
})

在这里插入图片描述
------------------------------------------------ ------------------------------------------------
------------------------------------------------ ------------------------------------------------ ------------------------------------------------

7. CORS 跨域资源共享

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

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

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

cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件，可以很方便地解决跨域问题。
使用步骤分为如下 3 步：

运行 npm install cors 安装中间件
使用 const cors = require(‘cors’) 导入中间件
在路由之前调用 app.use(cors()) 配置中间件

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

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

注意：

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

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

响应头部中可以携带一个 Access-Control-Allow-Origin 字段，其语法如下:
在这里插入图片描述
其中，origin 参数的值指定了允许访问该资源的外域 URL。

例如，下面的字段值将只允许来自 http://itcast.cn 的请求：
在这里插入图片描述
如果指定了 Access-Control-Allow-Origin 字段的值为通配符 *，表示允许来自任何域的请求，示例代码如下：

在这里插入图片描述

默认情况下，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 对额外的请求头进行声明，否则这次请求会失败！
在这里插入图片描述
默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求。
如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法。
示例代码如下：
在这里插入图片描述

7.3 CORS请求的分类

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

简单请求
预检请求

7.3.1 简单请求

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

请求方式：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）

7.3.2 预检请求

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

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

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

7.3.3 简单请求和预检请求的区别

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

8. JSONP 接口

8.1 JSONP 的概念与特点

概念：浏览器端通过 <script> 标签的 src 属性，请求服务器上的数据，同时，服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP。
特点：

JSONP 不属于真正的 Ajax 请求，因为它没有使用 XMLHttpRequest 这个对象。
JSONP 仅支持 GET 请求，不支持 POST、PUT、DELETE 等请求。

8.2 创建 JSONP 接口的注意事项

如果项目中已经配置了 CORS 跨域资源共享，为了防止冲突，必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下：
在这里插入图片描述

8.3 实现 JSONP 接口的步骤

获取客户端发送过来的回调函数的名字
得到要通过 JSONP 形式发送给客户端的数据
根据前两步得到的数据，拼接出一个函数调用的字符串
把上一步拼接得到的字符串，响应给客户端的 <script> 标签进行解析执行

//必须在配置cors中间件之前，配置JSONP接口
app.get('/api/jsonp', (req, res) => {
    //TODO:定义JSONP接口具体的实现过程
    //1.得到函数的名称
    const funcName = req.query.callback
    //2.定义要发送到客户端的数据对象
    const data = {
        name: 'zs',
        age: 20
    }
    //3.拼接出一个函数的调用
    const scriptStr = `${funcName}(${JSON.stringify(data)})`
    //4.把拼接的字符串响应给客户端
    console.log(scriptStr);
    res.send(scriptStr)
})

在网页中使用 jQuery 发起 JSONP 请求
调用 $.ajax() 函数，提供 JSONP 的配置选项，从而发起 JSONP 请求，示例代码如下：

 $("#btnJSONP").on('click', function () {
                $.ajax({
                    type: 'GET',
                    url: 'http://127.0.0.1/api/jsonp',
                    dataType: 'jsonp',
                    success: function (res) {
                        console.log(res);
                    }
                })
            })