0
点赞
收藏
分享

微信扫一扫

零基础入门Node.js教程(三)--- Express

静悠 2022-04-06 阅读 98
前言❤️ 努力,为了将来遇到喜欢的人事物的时候,可以有自信说出,我值得 ❤️

零基础入门Node.js教程(三)--- Express

一、零基础入门Node.js教程(三)— Express

(1)初识 Express

1.1 Express 简介

1.1.1 什么是 Express

1️⃣ 官方给出的概念:Express基于 Node.js 平台,快速、开放、极简的 Web 开发框架

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

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

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

1.1.2 Express 能做什么

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

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

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


1.2 Express 的基本使用

1.2.1 安装

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

1.2.2 创建基本的 Web 服务器
1.2.3 监听 GET 请求

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

1.2.4 监听 POST 请求

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

1.2.5 把内容响应给客户端

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

代码演示如下:

// 监听客户端的 GET 和 POST 请求,并向客户端响应具体的内容
app.get('/user', (req, res) => {
    // 调用 express 提供的 res.send() 方法,向客户端响应一个 JSON 对象
    res.send({ name: 'battledao', age: 23, gender: '男' })
})
app.post('/user', (req, res) => {
    // 调用 express 提供的 res.send() 方法,向客户端响应一个 文本字符串
    res.send('请求成功')
})
1.2.6 获取 URL 中携带的查询参数

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

代码演示如下:

app.get('/', (req, res) => {
    // 通过 req.query 可以获取到客户端发送过来的 查询参数
    // 注意:默认情况下,req.query 是一个空对象
    console.log(req.query)
    res.send(req.query)
})
1.2.7 获取 URL 中的动态参数

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

代码演示如下:

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

1.3 托管静态资源

1.3.1 express.static()

express 提供了一个非常好用的函数,叫做 express.static(),通过它,我们可以非常方便地创建一个静态资源服务器;

例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:

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

1.3.2 托管多个静态资源目录

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

😆温馨提醒😆:访问静态资源文件时,express.static() 函数会根据目录的添加顺序查找所需的文件;

1.3.3 挂载路径前缀

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

现在,你就可以通过带有 /public 前缀地址来访问 public 目录中的文件了:

  • http://localhost:3000/public/images/kitten.jpg
  • http://localhost:3000/public/css/style.css
  • http://localhost:3000/public/js/app.js

1.4 nodemon

1.4.1 为什么要使用 nodemon

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

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

1.4.2 安装 nodemon

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

1.4.3 使用 nodemon

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

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


(2)Express 路由

2.1 路由的概念

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

2.1.1 Express 中的路由

1️⃣ 在 Express 中,路由指的是客户端的请求服务器处理函数之间的映射关系

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

2.1.2 Express 中的路由的例子
2.1.3 路由的匹配过程

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

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

😆路由匹配的注意点😆:

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

2.2 路由的使用

2.2.1 最简单的用法

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

const express = require('express')
// 创建 Web 服务器, 命名为 app
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')
})
2.2.2 模块化路由

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

  1. 创建路由模块对应的 .js 文件;
  2. 调用 express.Router() 函数创建路由对象;
  3. 向路由对象上挂载具体的路由;
  4. 使用 module.exports 向外共享路由对象;
  5. 使用 app.use() 函数注册路由模块;
2.2.3 创建路由模块

完整代码演示如下:

// 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
2.2.4 注册路由模块

代码演示如下:

// 1. 导入路由模块
const router = require('./03.router')
// 2. 使用 app.use() 注册路由模块
app.use(router)
2.2.5 为路由模块添加前缀

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


(3)Express 中间件

3.1 中间件的概念

3.1.1 什么是中间件

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

3.1.3 Express 中间件的调用流程

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

3.1.3 Express 中间件的格式

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

😆温馨提醒😆:

  • 中间件函数的形参列表中,必须包含 next 参数。而路由处理函数中只包含 req 和 res;
  • next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由

3.2 Express 中间件的初体验

3.2.1 定义中间件函数

可以通过如下的方式,定义一个最简单的中间件函数,示例代码如下:

// 常量mw 所指向的,就是一个中间件函数
const mw = function (req, res, next) {
    console.log('这是最简单的中间件函数')
    // 注意: 在当前中间件的业务处理完毕后,必须调用 next( )函数
    // 表示把流转关系,转交给下一个中间件或路由
    next()
}
3.2.2 全局生效的中间件

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

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

const mw = function (req, res, next) {
    console.log('这是最简单的中间件函数')
    // 表示把流转关系,转交给下一个中间件或路由
    next()
}
// 全局生效的中间件
app.use(mw)
3.2.3 定义全局中间件的简化形式

代码演示如下:

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

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

完整代码演示如下:

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

// 这是定义全局中间件的简化形式
app.use((req, res, next) => {
    // 获取到请求到达服务器的时间
    const time = Date.now()
    // 为 req 对象,挂载自定义属性,从而把时间共享给后面的所有路由
    req.startTime = time
    next()
})

app.get('/', (req, res) => {
    res.send('Home page.' + req.startTime)
})
app.get('/user', (req, res) => {
    res.send('User page.' + req.startTime)
})

app.listen(80, () => {
    console.log('http://127.0.0.1')
})
3.2.5 定义多个全局中间件

可以使用 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个全局中间件')
    next()
})

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

app.listen(80, () => {
    console.log('http://127.0.0.1')
})
3.2.6 局部生效的中间件

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

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

// 1. 定义中间件函数
const mw1 = (req, res, next) => {
    console.log('调用了局部生效的中间件')
    next()
}

// 2. 创建路由
app.get('/', mw1, (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')
})
3.2.7 定义多个局部中间件

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

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

3.3 中间件的分类

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

  1. 应用级别的中间件
  2. 路由级别的中间件
  3. 错误级别的中间件
  4. Express 内置的中间件
  5. 第三方的中间件
3.3.1 应用级别的中间件

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

// 应用级别的中间件(全局中间件)
app.use((req, res, next) => {
    next()
})

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

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

3.3.3 错误级别的中间件

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

2️⃣ 格式:错误级别中间件的 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')
})

😆温馨提醒😆:错误级别的中间件,必须注册在所有路由之后;

3.3.4 Express内置的中间件

自 Express 4.16.0 版本开始,Express 内置了 3 个常用的中间件,极大的提高了 Express 项目的开发效率和体验:

  1. express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等(无兼容性)
  2. express.json 解析 JSON 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
  3. express.urlencoded 解析 URL-encoded 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
// 导入 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
    console.log(req.body)
    res.send('ok')
})

app.post('/book', (req, res) => {
    // 在服务器端,可以通过 req,body 来获取 JSON 格式的表单数据和 url-encoded 格式的数据
    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@4.16.0 之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:

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

😆温馨提醒😆:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 这个第三方中间件进一步封装出来的;


(4)使用 Express 写接口

4.1 创建基本的服务器

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

 // write your code here...

// 调用 app.listen 方法,指定端口号并启动Web服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})

4.2 创建 API 路由模块

4.3 编写 GET 接口

4.4 编写 POST 接口


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

4.5 CORS 跨域资源共享

4.5.1 接口的跨域问题

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

  1. CORS(主流的解决方案,推荐使用
  2. JSONP(有缺陷的解决方案:只支持 GET 请求)
4.5.2 使用 cors 中间件解决跨域问题

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

使用步骤分为如下 3 步:

  1. 运行 npm install cors 安装中间件;
  2. 使用 const cors = require('cors') 导入中间件;
  3. 在路由之前调用 app.use(cors()) 配置中间件;
4.5.3 什么是 CORS

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

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

在这里插入图片描述
😆CORS 的注意事项😆:

  • CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口;
  • CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+);
4.5.4 CORS 响应头部 - Access-Control-Allow-Origin

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

Access-Control-Allow-Origin: <origin> | *

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

例如,下面的字段值将只允许来自 https://blog.csdn.net/battledao/ 的请求:

res.setHeader('Access-Control-Allow-Origin', 'https://blog.csdn.net/battledao/')

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

res.setHeader('Access-Control-Allow-Origin', '*')
4.5.5 CORS 响应头部 - Access-Control-Allow-Headers

1️⃣ 默认情况下,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 三者之一)

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

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

1️⃣ 默认情况下,CORS 仅支持客户端发起 GETPOSTHEAD 请求。

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

4.5.7 CORS请求 - 简单请求

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

  1. 请求方式:GETPOSTHEAD 三者之一
  2. 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.8 CORS请求 - 预检请求

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

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

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

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

1️⃣ 简单请求的特点:客户端与服务器之间只会发生一次请求

2️⃣ 预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求


4.6 JSONP 接口

4.6.1 回顾 JSONP 的概念与特点

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

2️⃣ 特点:

  • JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。
  • JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求。
4.6.2 创建 JSONP 接口的注意事项

如果项目中已经配置了 =CORS 跨域资源共享,为了防止冲突,必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下:

4.6.3 实现 JSONP 接口的步骤
  1. 获取客户端发送过来的回调函数的名字;
  2. 得到要通过 JSONP 形式发送给客户端的数据;
  3. 根据前两步得到的数据,拼接出一个函数调用的字符串;
  4. 把上一步拼接得到的字符串,响应给客户端的 <script> 标签进行解析执行;
4.6.4 实现 JSONP 接口的具体代码
4.6.5 在网页中使用 jQuery 发起 JSONP 请求

调用 $.ajax() 函数,提供 JSONP 的配置选项,从而发起 JSONP 请求,示例代码如下:


二、总结

😝 由于内容较多,所以我决定分开写啦,我会坚持一直更新呢!喜欢的朋友们记得点点赞哦! 😝

举报

相关推荐

0 条评论