express框架基础

1 了解 Express

1.1 概念

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

1.2 进一步理解

没有Express也可以创建Web服务器，用原生http。
原生http复杂，效率低下，Express是对于http进一步封装出来的，开发效率高。

1.3 两种服务器

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

2 Express的基本使用

2.1 安装

在项目所在终端运行如下命令：

npm i express@4.17.1

2.2 创建基本的Web服务器

// 1.创建 express
const express = require('express')
// 2.创建 web 服务器
const app = express()
// 3.调用 app.listen(端口号)
app.listen(8080,()=>{
    console.log('express server running at http://127.0.0.1:8080')
})

2.3 监听 GET 请求

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

2.4 监听 POST 请求

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

2.5 把内容相应给客户端

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

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

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

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

2.7 获取 URL 中的动态参数

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

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

alt text

3 托管静态资源

3.1 调用 express.static() 方法，快速的对外提供静态资源

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

app.use(express.static('./clock'))

app.listen(8080, () => {
    console.log('express server running at http://127.0.0.1');
})

3.2 托管多个静态资源目录

多次调用express.static()函数:
按顺序托管，只能查看到第一个托管到的

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

3.3 挂载路径前缀

app.use('/abc',express.static('./files'))

3.4 nodemon 更新代码自动帮我们重启项目

全局安装

npm install -g nodemon

使用 nodemon

nodemon app.js

4 Express 路由

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

app.METHOD(PATH,HANDLER)

4.1 Express 中的路由的例子

// 匹配 GET 请求，且请求 URL 为 /
app.get('/',function(req,res){
    res.send('hello world!')
})

// 匹配 POST 请求，且请求 URL 为 /
app.post('/',function(req,res){
    res.send('Got a POST request')
})

4.2 路由的匹配过程

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

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

4.3 模块化路由

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

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

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

// router.js文件
var express = require('express')
var 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

// 启动模块
const express = require('express')
const app = express()

// 调用 express.static() 方法，快速的对外提供静态资源
const router = require('./03.router')

// app.use()函数的作用，就是来注册全局中间件
// '/api'是访问前缀
app.use('/api', router)

app.listen(8080, () => {
    console.log('express server running at http://127.0.0.1:8080');
})

4.4 为路由模块添加前缀

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

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

5 中间件

5.1 中间件概念

什么是中间件

中间件就是一堆方法，
可以接收客户端发来的请求
可以对请求做出响应
也可以将请求继续交给下一个中间件继续处理。
alt text
中间件主要由两部分构成，中间件方法以及请求处理函数。
中间件方法由Express提供，负责拦截请求，请求处理函数由开发人员提供，负责处理请求。

app.get('请求路径','处理函数') // 接收并处理get请求
app.post('请求路径','处理函数') // 接收并处理post请求

中间件格式

alt text

可以针对同一个请求设置多个中间件，对同一个请求进行多次处理
原文链接：https://blog.csdn.net/weixin_46370867/article/details/112155745

5.2 最简单的中间件函数

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

5.3 全局生效的中间件

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

// 全局生效的中间件
app.use(mw)

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

5.4 中间件的作用

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

// 简化全局中间件
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)
})

5.5 定义多个全局中间件按顺序执行

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

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

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

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

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

5.6 局部生效的中间件

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

// 定义中间件函数 wm1
const wm1 = function(req,res,next){
    console.log('这是中间件函数')
}
app.get('/',wm1,function(req,res){
    res.send('Home page.')
})
app.get('/user',function(req,res){
    res.send('User page.')
})

5.7 定义多个局部中间件

可以在路由通过两种等价的方式，使用多个中间件

app.get('/',wm1,wm2,(req,res)=>{res.send('Home Page.')})
app.get('/',[wm1,wm2],(req,res)=>{res.send('Home Page.')})

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

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

5.9 中间件的分类

应用级别中间件在app的use

app.use(function(req,res,next){
    console.log('Hello')
    next()
})

路由级别中间件在router的use

router.use(function(req,res,next){
    console.log('Hello')
    next()
})

错误级别中间件 use的时候多带一个err的参数

app.get('/',function(req,res){
    throw new Error('服务器发生错误！')
    res.send('Home Page.')
})
app.use(function(err,req,res,next){
    console.log('发生了错误' + err.message)
    res.send('Error' + err.message)
})

内置的中间件

express.static快速托管静态资源的内置中间件，例如：HTML、图片、CSS样式等
express.json解析JSON格式的请求体数据

express.urlencoded解析URL-encoded格式的请求体数据

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

// 注意：除了错误级别中间件，其他中间件必须在路由之前配置
// 通过 express.json(),解析JSON格式的数据
app.use(express.json())
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(80, function () {
    console.log('http://127.0.0.1:80');
})

第三方的在中间件
常用body-parser这个第三方中间件，来解析请求体数据。

5.10 自定义中间件

自己创建一个中间件来解析 POST 提交到服务器的表单数据

步骤：

定义中间件

app.use(function(req,res,next){
    // 业务逻辑
})

监听req的data时间
在中间件中，需要监听req对象的data事件，来获取客户端发送服务器的数据。
如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以data事件可能会触发多次，每一次触发data事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。

app.use((req, res, next) => {
    // 定义中间件具体的业务逻辑
    // 1.定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
    let str = ''
    // 2.监听 req 的 data 事件
    req.on('data', (chunk) => {
        str += chunk
    })
})

监听req的end事件
当请求体数据接收完毕之后，会自动触发req的end事件。
因此，我们可以在req的end事件中，拿到并处理完整的请求体数据。
// 监听req对象的end事件
req.on('end'()=>{
console.log(str)
})
使用querystring模块解析请求体数据
Node.js内置了一个querystring模块，专门用来处理查询字符串,通过这个模块提供的parse()函数,可以把查询字符串，解析成对象的格式。
const qs = require('querystring')
const body = qs.parse(str)
将解析出来的数据对象挂载为req.body
上游的中间件和下游的中间件及路由之间，共享同一份req和res。因此，我们可以将解析出来的数据，挂载为req的自定义属性，命名为req.body，供下游使用。
req.on('end',()=>{
const body = qs.parse(str)
req.body = body
next()
})

将自定义中间件封装为模块
为了优化代码的结构，我们可以把自定义的中间件函数，封装为独立的模块

const qs = require('querystring')
function bodyParser(req,res,next){
    // 省略其他代码
}
module.exports = bodyParser
// --------------分割线--------------
// 1.导入模块,require是文件路径
const myBodyParser = require('./custom-body-parser')
// 2.注册自定义的中间件模块
app.use(myBodyParser)

6 写接口

6.1 创建 API 路由模块

const express = require('express')
const apiRouter = express.Router()
// 在这里挂载对应的路由
module.exports = apiRouter

// ------------------------------

// app.js 导入并注册路由模块
const apiRouter = require('./apiRouter.js')
app.use('/api',apiRouter)

6.2 编写 GET 接口

apiRouter.get('/get',(req,res)=>{
    // 1. 获取到客户端通过查询字符串，发送到服务器的数据
    const query = req.query
    // 2. 调用 res.send() 方法，把数据响应到客户端
    res.send({
        status: 0, // 状态，0 表示成功，1 表示失败
        msg: 'GET请求成功！' // 状态描述
        data: query // 需要响应给客户端的具体数据
    })
})

6.3 编写 POST 接口

对比上一步 GET 数据从 query 接收改为 body 接收，而且还要记得 URL-encoded 数据要中间件解析一下

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

// -----------------------------
apiRouter.get('/post',(req,res)=>{
    // 1. 获取到客户端通过请求体，发送到服务器的 URL-encoded 数据
    const body = req.body
    // 2. 调用 res.send() 方法，把数据响应到客户端
    res.send({
        status: 0, // 状态，0 表示成功，1 表示失败
        msg: 'POST请求成功！' // 状态描述
        data: body // 需要响应给客户端的具体数据
    })
})

6.4 CORS 跨域资源共享

上述两个写的接口存在一个严重问题：不支持跨域请求

跨域问题

跨域是因为协议不同导致的，比如本地我是file文件打开，接口是在http协议，就会产生跨域问题无法获取

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

CORS (主流的解决方案)
JSONP (只支持 GET 请求)

解决步骤:

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

6.5 什么是CORS

CORS(Cross-Origin Resource Sharing,跨域资源共享)由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源。
浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头，就可以解除浏览器端的跨域访问限制。

CORS 注意事项

CORS 主要在浏览器端进行配置，客户端浏览器无需做任何额外的配置，即可请求开启了 CORS 的接口。
CORS 在浏览器中有兼容性，只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口。

CORS 响应头

响应头部可以携带Access-Control-Allow-Origin字段，其语法如下：

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

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

下面字段值将只允许来自http://itcast.cn的请求:

res.setHeader('Access-Control-Allow-Origin','http://itcast.cn')

下面字段值将允许来自任何域的请求:
res.setHeader('Access-Control-Allow-Origin','*')

CORS 简单请求

满足条件，就属于简单请求:

请求方式：GET、POST、HEAD 三者之一

CORS 预检请求

满足如下条件

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

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

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