初识 Express

1、初识 Express

1.1、什么是 Express

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

1.2、Express 能做什么

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

1.3、安装 Express

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

1.4、创建基本的 Web 服务器

# 导入 express
const express = require('express');

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

# 调用 app.listen(端口号, 启动成功后的回调函数)，启动服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
});

1.5、监听 GET 请求

# 通过 app.get() 方法，可以监听客户端的 GET 请求
# 参数1：客户端请求的 URL 地址
# 参数2：请求对应的处理函数
# req: 请求对象（包含了与请求相关的属性和方法）
# res: 响应对象（包含了与响应相关的属性和方法）
app.get('请求URL', (req, res) => {/* 处理函数 */})

1.6、监听 POST 请求

# 通过 app.post() 方法，可以监听客户端的 GET 请求
# 参数1：客户端请求的 URL 地址
# 参数2：请求对应的处理函数
# req: 请求对象（包含了与请求相关的属性和方法）
# res: 响应对象（包含了与响应相关的属性和方法）
app.post('请求URL', (req, res) => {/* 处理函数 */})

1.7、把内容响应给客户端

# 通过 res.send() 方法，可以把处理好的内容，发送给客户端
app.get('/user', (req, res) => {
  # 向客户端发送 JSON 对象
  res.send({ name: 'ls', age: 18, gender: '男' });
});

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

1.8、获取 URL 中携带的查询参数

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

1.9、获取 URL 中的动态参数

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

1.10、托管静态资源

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

# 通过如下代码就可以将 public 目录下地图片、CSS文件、JavaScript文件对外开放访问了
app.use(express.static('public'))

# 托管多个静态资源目录，多次调用 express.static() 函数
app.use(express.static('public'))
app.use(express.static('files'))

# 如果希望在托管地静态资源访问路径之前，挂载路径前缀，可以使用如下地方式
app.use('/public', express.static('public'))

2、nodemon

2.1、为什么要使用 nodemon

• 在编写调试 Node.js 项目地时候，如果修改了项目地代码，则需要频繁地手动 close 掉，然后再重新启动，非常频繁
• 使用 nodemon 这个工具，能够监听项目文件的变动，当代码被修改后，nodemon 会自动帮我们重启项目，极大方便了开发和调试

2.2、安装 nodemon

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

2.3、使用 nodemon

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

# 使用 nodemon启动服务
nodemon app.js

3、Express 路由

3.1、什么是路由

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

app.method(path, handler)

3.2、路由的例子

# 匹配 GET 请求，请求 URL 为 /api
app.get('/api', (req, res) => {
  res.send('Hello World');
});

# 匹配 POST 请求，请求 URL 为 /api
app.POST('/api', (req, res) => {
  res.send('Hello World');
});

3.3、路由的匹配过程

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

3.4、路由的使用

# 在 Express 中使用路由最简单的方式，就是把路由挂载到 app 上
# 导入 express
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！')});

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

3.5、模块化路由

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

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

3.6、创建路由模块

# 导入 express
const express = require('express');

# 创建路由对象
const router = express.Router();

# 挂载获取用户列表的路由
router.get('/user/list', (req, res) => {
  res.send('Get user list');
});

# 挂载添加用户的路由
router.post('/user/add', (req, res) => {
  res.send('Add new user');
});

# 向外导出路由对象
module.exports = router;

3.7、注册路由模块

# 导入路由模块
const userRouter = require('./router/user.js');

# 使用 app.use() 注册路由模块
app.use(userRouter);

3.8、为路由模块添加前缀

# 导入路由模块
const userRouter = require('./router/user.js');

# 使用 app.use() 注册路由模块。并添加统一的访问前缀 /api
app.use('/api', userRouter);

4、Express 中间件

4.1、什么是中间件

• 中间件（Middleware），特指业务流程的中间处理环节
• 当一个请求到达 Express 的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理
• Express 的中间键，本质上就是一个 function 处理函数
• 中间件的函数形参列表中必须包含 next 参数
• next 函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由

4.2、定义中间件函数

# 可以通过如下的方式，定义一个最简单的中间件函数
# 常量 mw 所指向的，就是一个中间件函数
const mw = function(req, res, next) {
  console.log('这是一个最简单的中间件函数');
  # 在当前中间件的业务处理完毕后，必须调用 next() 函数
  # 表示把流程关系转交给下一个中间件或路由
  next();
}

4.3、全局生效的中间件

• 客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件
• 通过调用 app.use(中间件函数)，即可定义一个全局生效的中间件

# 常量 mw 所指向的，就是一个中间件函数
const mw = function(req, res, next) {
  console.log('这是一个最简单的中间件函数');
  next();
}
# 全局生效的中间件
app.use(mw);

4.4、中间件的作用

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

4.5、定义多个全局中间件

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

# 第一个全局中间件
app.use((req, res, next) => {
  console.log('调用了第一个全局中间件');
  next();
});

# 第二个全局中间件
app.use((req, res, next) => {
  console.log('调用了第二个全局中间件');
  next();
});

# 请求这个路由，会依次触发上述两个全局中间件
app.get('/user', (req, res) => {
  res.send('Home page');
});

4.6、局部生效的中间件

不使用 app.use() 定义的中间件，叫做局部生效的中间件

# 定义中间件函数 mw
const mw = function(req, res, next) {
  console.log('这是中间件函数');
  next();
}

# mw 这个中间件只在当前路由中生效，这种属于局部生效的中间件
app.get('/', mw, (req, res) => {
  res.send('Homw page.');
});

4.7、定义多个局部中间件

# 可以在路由中，通过如下两种等价方式，使用多个局部中间件
# 方式一
app.get('/', mw1, mw2, (req, res) => { res.send('Home page.') });

# 方式二
app.get('/', [mw1, mw2], (req, res) => { res.send('Home page') });

4.8、使用中间件注意事项

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

4.9、中间件的分类

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

4.9.1 应用级别的中间件

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

# 通过 app.use() 或 app.get() 或 app.post()，绑定到 app 实例上的中间件，叫做应用级别的中间件
# 应用级别的中间件（全局中间件）
app.use((req, res, next) => {
  next();
});

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

4.9.2 路由级别的中间件

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

# 导入 express 模块
const app = express();

# 创建路由实例
const router = express.Router();

# 创建路由级别中间件
router.use((req, res, next) => {
  next();
});

# 挂载路由
app.use('/', router);

4.9.3 错误级别的中间件

• 错误级别中间件专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题
• 错误级别的中间件，必须注册在所有路由之后
• 错误级别中间件的 function 处理函数，必须有 4 个形参。代码示例如下：

# 路由处理函数
app.get('/', (req, res) => {
  # 抛出一个自定义的错误
  throw new Error('服务器内部发生了错误！');
  res.send('Home Page');
});

# 错误级别的中间件
app.use((err, req, res, next) {
  # 向客户端响应错误相关的内容
  res.send('Error!' + err.message);
});

4.9.4 Express 内置的中间件

• express.static 快速托管静态资源的内置中间件
• express.json() 解析 JSON 格式的请求体数据
• express.urlencoded 解析 URL-encoded 格式的请求体数据

# 配置解析 application/json 格式数据的内置中间件
app.use(express.json());

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

4.9.5 第三方中间件

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

5、使用 Express 写接口

5.1、创建基本的服务器

# 导入 express 模块
const express = require('express');

# 创建 express 的服务器实例
const app = express();

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

5.2、创建 API 路由模块

# 导入 express 模块
const express = require('express');

# 创建路由模块
const apiRouter = express.Router();

# 导出路由
module.exports = apiRouter;

5.3、导入并注册路由模块

# 导入路由
const apiRouter = require('./apiRouter');
# 注册路由
app.use('/api', apiRouter);

5.4、编写 GET 接口

apiRouter.get('/get', (req, res) => {
  # 获取到客户端通过查询字符串，发送到服务器的数据
  const query = req.query;
  # 调用 res.send() 方法，把数据响应给客户端
  res.send({
    status: 200,
    msg: 'GET请求成功！',
    data: query
  });
})

5.5、编写 POST 接口

apiRouter.post('/post', (req, res) => {
  # 获取客户端通过请求体，发送到服务器的 URL-encoded 数据
  # 如果要获取 URL-encoded 格式的请求体数据，必须配置中间件 app.use(express.urlencoded({extended: false}))
  const body = req.body;

  # 调用 res.send() 方法，把数据响应给客户端
  res.send({
    status: 200,
    msg: 'POST请求成功！',
    data: body
  });
})

6、跨域资源共享

6.1、解决接口跨域的方案

• CORS（主流的解决方案）
• JSONP（有缺陷的解决方案）

6.2、什么是 CORS

• CROS（Cross-Origin Resource Sharing，跨域资源共享）由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源
• 浏览器的同源安全策略默认会阻止网页跨域获取资源。但如果接口配置了 CORS 相关的 HTTP 响应头，就可以解决浏览器端的跨域访问限制
• CORS 主要在服务器端进行配置，客户端浏览器无须任何额外的配置，即可请求开启了 CORS 的接口
• CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务器接口

6.3、使用 CORS 中间件解决跨域问题

1. 安装中间件 npm i cors;
2. 导入中间件 const cors = require(‘cors’);
3. 配置注册中间件 app.use(cors);

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

# 指定允许访问该资源的外域 URL
# 只允许来自 http://www.baidu.com 的请求
res.setHeader('Access-Control-Allow-Origin', 'http://www.baidu.com');

# 允许来自任何域的请求，设置该字段的值为通配符 *
res.setHeader('Access-Control-Allow-Origin', '*')

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

• 默认情况下，CORS 仅支持客户端向服务器发送如下的 9 个请求头
• Accept、Accept-Language、Content-Language、DRR、Downlink、Save-Data、Viewport-Width、Width、Content-Type
• 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')

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

• 默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求
• 如果客户端想通过 PUT、DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Allow-Methods 来指明实际请求所允许使用的 HTTP 方法。

# 只允许 POST、GET、DELETE、HEAD 请求方法
res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD');

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

6.4、JSONP 解决接口跨域

• 浏览器通过 <script> 标签的 src 属性，请求服务器上的数据，同时，服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP
• JSONP 不属于真正的 Ajax 请求，因为它没有使用 XMLHttpRequest 这个对象
• JSONP 仅支持 GET 请求，不支持 POST、PUT、DELETE 等请求

6.5、实现 JSONP 接口的步骤

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

app.get('/api/jsonp', (req, res) => {
  # 获取客户端发送过来的回调函数的名字
  const funcName = req.query.callback;

  # 得到要通过 JSONP 形式发送给客户端的数据
  const data = { name: 'zs', age: 18 };

  # 根据前两布得到的数据，拼接出一个函数调用的字符串
  const scriptStr = `${funcName}(${JSON.stringify(data)})`;

  # 把得到的字符串，响应给客户端的 <script> 标签进行解析执行
  res.send(scriptStr);
});

6.6、使用 jQuery 发起 JSONP 请求

# 调用 $.ajax() 函数，提供 JSONP 的配置选项，从而发起 JSONP 请求
$.ajax({
  method: 'GET',
  url: 'http://127.0.0.1/api',
  dataType: 'jsonp',
  success: (res) => {
    console.log(res);
  }
});