【Node.js】Express学习笔记（黑马）-易微帮

初识 Express

Express 简介

什么是 Express？

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

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

进一步理解 Express：

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

Express 能做什么？
对于前端程序员来说，最常见的两种服务器，分别是：

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

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

Express 的基本使用

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

npm install express --save

也可以安装指定版本的express
npm install express@4.17.1

2. 创建基本的Web服务器
在安装express的目录下新建 app.js 文件，并插入如下代码：

// 1.导入 express
const express = require('express')
// 2.创建 web 服务器
const app = express()
// 3.调用 app.listen(端口号， 启动成功后的回调函数)，启动服务器
app.listen(80, () => {
    console.log('服务器已启动(地址：http://127.0.0.1)')
})

然后在终端中运行所创建的web服务器：

node app.js

如果运行成功，就会在控制台打印服务器已启动(地址：http://127.0.0.1)，在浏览器访问链接可以看到返回的Cannot GET /,因为我们还没有写具体的请求响应内容。

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

// 参数1：客户端请求的 URL 地址
// 参数2：请求对应的处理函数
//      req：请求对象（包含了与请求相关的属性和方法）
//      res：响应对象（包含了与响应相关的属性和方法）
app.get('请求URL', function(req, res) { /* 处理函数 */ })

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

// 参数1：客户端请求的 URL 地址
// 参数2：请求对应的处理函数
//      req：请求对象（包含了与请求相关的属性和方法）
//      res：响应对象（包含了与响应相关的属性和方法）
app.post('请求URL', function(req, res) { /* 处理函数 */ })

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

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


app.get('/user', function(req, res) {
    // 向客户端发送 JSON 对象
    res.send({ name:'张三', age:20, gender:'男' })
})
app.post('/user', function(req, res) {
    // 向客户端发送文本内容
    res.send('post请求成功')
})


app.listen(80, () => {
    console.log('服务器已启动(地址：http://127.0.0.1)')
})

通过node 文件名命令运行服务器后，对http://127.0.0.1/user发起get或post请求就可以分别得到res.send发送的数据。

在浏览器打开http://127.0.0.1/user也可以看到所定义的JSON对象在页面上显示，因为浏览器打开默认是GET请求
在这里插入图片描述

6.获取 URL 中携带的查询参数
通过 req.query 对象，可以访问到客户端通过查询字符串的形式，发送到服务器的参数：

app.get('/', function(req, res) {
    // req.query 默认是一个空对象
    // 客户端可以使用 ?name=zs&age=20 这种查询字符串形式，将参数发送到服务器
    // 发送到服务器的参数可以通过req.query访问到
    // 如：req.query.name
    console.log(req.query)
})

运行服务器，浏览器访问http://127.0.0.1/?name=zs&age=20即可在服务器控制台输出如下内容：
在这里插入图片描述

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

app.get('/user/:id', function(req, res) {
    // req.params 是一个空对象
    // 里面存放着通过 : 动态匹配到的参数值
    console.log(req.params)
})

运行服务器，浏览器访问http://127.0.0.1/user/2即可在服务器控制台输出如下内容：
在这里插入图片描述

托管静态资源

1.express.static()
express 提供了一个非常好用的函数，叫做 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 中。

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

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

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

app.listen(80, () => {
    console.log('服务器已启动(地址：http://127.0.0.1)')
})

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

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 install -g nodemon

3.使用 nodemon
当基于 Node.js 编写了一个网站应用的时候，传统的方式，是运行 node app.js 命令，来启动项目。

这样做的坏处是：代码被修改之后，需要手动重启项目。

现在，我们可以将 node 命令替换为 nodemon 命令，使用 nodemon app.js 来启动项目。

这样做的好处是：代码被修改之后，会被 nodemon 监听到，从而实现自动重启项目的效果。

node app.js
# 将上面的终端命令，替换为下面的终端命令，即可实现自动重启项目的效果
nodemon app.js

Express 路由

路由的概念

1.什么是路由

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

2.Express 中的路由

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

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

app.METHOD(PATH, HANDLER)

3.路由的匹配过程

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

在匹配时，会按照路由的顺序进行匹配，如果请求类型和请求的 URL 同时匹配成功，则 Express 会将这次请求，转交给对应的 function 函数进行处理。
在这里插入图片描述
路由匹配的注意点：
① 按照定义的先后顺序进行匹配
② 请求类型和请求的URL同时匹配成功，才会调用对应的处理函数

路由的使用

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

const express = require('express')
// 创建Web服务器，并命名为 app
const app = express()

// 挂载路由
// 匹配 GET 请求，且请求 URL 为 /
app.get('/', (req, res) => { res.send('hello world.') })
// 匹配 POST 请求，且请求 URL 为 /
app.post('/', (req, res) => { res.send('Post Request.') })

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

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

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

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

3.创建路由模块实例
在安装Express的项目目录下新建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

新建app.js文件，在app.js中导入并使用路由模块

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

// 1. 导入路由模块
const router = require('./router')
// 2. 注册路由模块，并添加统一的访问前缀 /api ，便于分类
app.use('/api', router)

// 注意： app.use() 函数的作用，就是来注册全局中间件

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

当请求地址为http://127.0.0.1/api/user/list，且请求方式为 GET 时，可以得到Get user list.的响应

Express 中间件

中间件的概念

1.什么是中间件
中间件（Middleware ），特指业务流程的中间处理环节。

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

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

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

Express 中间件的初体验

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

// 定义一个最简单的中间件函数
const mw = function (req, res, next) {
  console.log('这是最简单的中间件函数')
  // 把流转关系，转交给下一个中间件或路由
  next()
}

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

或者也可以简写为如下格式：

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

实例：

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')})

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

3.定义多个全局中间件
可以使用 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')
})

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

const express = require('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(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

当访问http://127.0.0.1/时，终端输出调用了局部生效的中间件
当访问http://127.0.0.1/user时，不调用定义的局部中间件函数

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

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

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

const mw2 = (req, res, next) => {
  console.log('调用了第二个局部生效的中间件')
  next()
}

// 2. 创建路由
app.get('/', [mw1, mw2], (req, res) => {
  res.send('Home page.')
})
app.get('/user', (req, res) => {
  res.send('User page.')
})

app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

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

中间件的分类

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

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

【Node.js】Express学习笔记（黑马）

目录