Express教程

2023-04-06

Author：lzugis

一、初识Express

1. Express简介

Express 是基于Node.js平台，快速、开放、极简的Web开发框架。是一个 npm 上的第三方包，提供了快速构建 Web 服务器的便捷方法。 使用 Express，我们可以方便、快速的创建Web网站服务器或Api接口服务器。

• Express中文官网
• Express官网

2.基本使用

2.1 安装

# 初始化工程
npm init -y
# 安装依赖
npm i express -S

2.2 创建基本的 Web 服务器

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

2.3 监听 GET 请求

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

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

2.4 监听 POST 请求

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

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

2.5 把内容响应给客户端

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

app.get('/user', (req, res) => {
    // 向客户端发送 JSON 对象
    res.send({ name: 'zs', age:20, gender: '男'})
})

app.post('/user', (req,res) => {
    // 向客户端发送文本内容
    res.send('请求成功')
})

2.6 获取url中的参数

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

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

2.7 获取 URL 中的动态参数

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

// URL 地址中，可以通过 :参数名 的形式，匹配动态参数值
app.get('/user/:id', (req, res) => {
    // req.params 默认是一个空对象
    // 里面存放着通过 : 动态匹配到的参数值
    //http://127.0.0.1/user/2  返回的id就是2
    console.log(req.params)
})

可以有多个动态参数：

app.get('/user/:id/:name', (req, res) => {
    // http://127.0.0.1/user/2/zs  返回的params是 {"id": "3", "name": "zs"}
    console.log(req.params)
})

3. 托管静态资源

3.1 express.static()

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

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

现在，你就可以访问 public 目录中的所有文件了：

http://localhost:3000/images/bg.jpg
http://loaclhost:3000/css/style.css
http://localhost:3000/js/login.js

注意

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

3.2 托管多个静态资源目录

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

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

访问静态资源文件时，express.static() 函数会根据目录的添加顺序查找所需的文件。(比如，public目录和files目录都有index.html文件，那么查找的时候会先查找public目录，如果没查找到，再查找files目录，如果在public目录查找到了，将不会再查找files目录)

3.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

4. nodemon

在编写调试 Node.js 项目的时候，如果修改了项目的代码，则需要频繁的手动 close 掉，然后再重新启动服务，非常繁琐。 现在，我们可以使用 nodemon (www.npmjs.com/package/nodemon) 这个工具，它能够监听项目文件的变动， 当代码被修改后，nodemon 会自动帮我们重启项目，极大方便了开发和调试。

4.1 安装 nodemon

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

npm install -g nodemon

4.2 使用nodemon

当基于 Node.js 编写了一个网站应用的时候，传统的方式，是运行 node app.js 命令，来启动项目。这样做的坏处是：代码被修改之后，需要手动重启项目。 现在，我们可以将 node 命令替换为 nodemon 命令，使用 nodemon app.js 来启动项目。这样做的好处是：代码被修改之后，会被 nodemon 监听到，从而实现自动重启项目的效果。

二、Express 路由

1. 路由的概念

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

app.METHOD(PATH, HANDLER)

1.1 路由的匹配过程

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

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

2. 路由的使用

2.1 最简单的用法

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

const express = require('express')
// 创建 Web 服务器，命名为 app
const app = express()
// 挂载路由
app.get('/', (req, res) => { res.send('Get Request') })
app.post('/', (req, res) => { res.send('Post Request') })
// 启动 Web 服务器
app.listen(3000, () => { console.log('server running at http://127.0.0.1:3000')} )

2.2 模块化路由

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

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

2.3 创建路由模块

var express = require('express')        // 1. 导入 express
var router = express.Router()           // 2. 创建路由对象
router.get('/user/list', function(req, res) {  // 3. 挂载获取用户列表的路由
    res.send('Get user list.')
})
router.post('/user/add', function(req, res) {   // 4. 挂载添加用户的路由
    res.send('Add new user.')
})
module.exports = router         // 5. 向外导出路由对象

2.4 注册路由模块

// 1. 导入路由模块
const userRouter = require('./router/user.js')
// 2. 使用 app.use() 注册路由模块
app.use('/api', userRouter) // 添加前缀

3.中间件

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

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

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

4. 自定义跨域中间件

// 自定义跨域中间件
const allowCors = function (req, res, next) {
  res.header('Access-Control-Allow-Origin', req.headers.origin);
  res.header('Access-Control-Allow-Methods', 'GET,PUT,POST,DELETE,OPTIONS');
  res.header('Access-Control-Allow-Headers', 'Content-Type');
  res.header('Access-Control-Allow-Credentials', 'true');
  next();
};
app.use(allowCors);// 使用跨域中间件