Express学习总结

一直很小白
123 阅读13分钟

Express基础

一 、 概念

Express是基于node.js平台，快速，开放，极简的web开发框架，开发者可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。

安装

```
npm i express@版本号
```

创建基本的web服务器

 基于nodejs的http模块

    ```
    // 引入
    const http = require('http')
    ​
    // 创建服务
    const  server =  http.createServer((req,res)=>{
        console.log('接收到客户端的请求');
        const url = req.url   // 客户端请求的url地址
        const method = req.method  //客户端请求的方法
        console.log(url,method);
        res.setHeader('Content-Type','text/html;charset=utf-8')   // 设置响应内容编码格式
        res.end('我返回了内容')  //res.end() :设置响应体，结束请求
     })
    ​
    // 启动服务  监听8001端口并启动web服务器等待客户端请求 
     server.listen('9091',()=>{
        console.log('http://localhost:9091/');
     })
    ​

express创建的web服务器

// 引入
const express = require('express')
//创建web服务器
const app = express()
​
// 监听GET请求
//参数1 客户端请求的地址
//参数2 请求对应的处理函数
app.get('请求URL',function(req,res){
    //处理函数
    //通过req.query对象获取客户端查询字符串
    //通过req.params对象，可以访问到URL中，通过:匹配的动态参数
})
​
​
//启动服务
app.listen(80,()=>{
    console.log('服务启动成功！！')
})
```

托管静态资源

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

express.static([.路由前缀],'指定的静态目录')
//如不添加路由前缀，则Express 在指定的静态目录中查找文件，并对外提供资源的访问路径。因此，存放静态文件的目录名不会出现在 URL 中。
​
app.use(express.static('public'))

0. 托管多个静态资源目录

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

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

二、路由的概念

生活中的路由

  • 在 Express 中，路由指的是客户端的请求与服务器处理函数之间的映射关系。
  • Express 中的路由分 3 部分组成，分别是请求的类型、请求的 URL 地址、处理函数，格式如下：
app.method(path,handler)
​
// 匹配get请求，且url为'/'
app.get('/',function(){
    res.send('响应内容')
})
​
// post 请求
app.post('/',function(){
    res.send('响应内容')
})

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

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

2.1路由的使用

// 在 Express 中使用路由最简单的方式，就是把路由挂载到 app 上，示例代码如下：
​
const express = require('express')
//创建web服务器
const app = express()
​
// 挂载路由
//参数1 客户端请求的地址
//参数2 请求对应的处理函数
app.get('请求URL',function(req,res){
    //处理函数
    //通过req.query对象获取客户端查询字符串
    //通过req.params对象，可以访问到URL中，通过:匹配的动态参数
})
app.post('请求URL',function(req,res){
    //处理函数
    //通过req.query对象获取客户端查询字符串
    //通过req.params对象，可以访问到URL中，通过:匹配的动态参数
})
​
//启动服务
app.listen(80,()=>{
    console.log('服务启动成功！！')
})

2.2 路由的模块化

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

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

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

1.创建路由模块对应的 /router/user.js 文件

const express = require('express')  //1. 引入express
const router = express.Router()    //2. 调用express.Router()函数创建路由对象
​
// 3.向路由对象上挂载具体的路由
router.get('user/list'，function(req,res){
    res.send('响应')
})
​
//4.使用module.exports 向外共享路由对象
module.export = router

2.注册路由模块

// 1.导入路由模块
const userRouter = require('./router/user.js')
​
// 2.使用app.use() 注册路由模块
app.user(userRouter)
​
// 如需要为路由模块添加前缀  类似于托管静态资源时，为静态资源统一挂载访问前缀一样，路由模块添加前缀的方式也非常简单：
app.use('/api',userRouter)
​

三、Express 中间件

3.1概念

中间件（Middleware ），特指业务流程的中间处理环节。

生活中的例子

在处理污水的时候，一般都要经过三个处理环节，从而保证处理过后的废水，达到排放标准。下图处理污水的这三个中间处理环节，就可以叫做中间件。

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

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

注意： 中间件函数的形参列表中，必须包含 next 参数。而路由处理函数中只包含 req 和 res。

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

3.2Express 中间件的初体验

3.2.1定义中间件函数
const mw = function (req,res，next){
    当前中间件业务
    next()
}
3.2.2全局生效的中间件

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

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

//app.use(mw)
或
app.use(function (req,res，next){
    当前中间件业务
    next()
})
3.2.3中间件的作用：

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

3.2.4定义多个全局中间
//可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后，会按照中间件定义的先后顺序依次进行调用，示例代码如下：
​
app.use(function (req,res，next){
    console.log(调用第一个)
    next()
})
​
app.use(function (req,res，next){
    console.log(调用第二个)
    next()
})
​
// 请求这个路由，会依次触发上述两个全局中间件
app.get('user',function (req,res){
    res.send('响应')  
  
})
​
3.2.5定义局部中间

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

// 定义中间件函数
const mw=function (req,res，next){
    console.log(调用第一个)
    next()
}
​
// mw 只在当前路由中生效
app.get('user',mw,function (req,res){
    res.send('响应')  
  
})
​
// mw 不会触发这个
app.get('user',function (req,res){
    res.send('响应')  
  
})
​
​
// 定义多个局部中间件
//可以在路由中，通过如下两种等价的方式，使用多个局部中间件：
app.get('user',mw1，mw2,function (req,res){
    res.send('响应')  
  
})
​
app.get('user',[mw1，mw2],function (req,res){
    res.send('响应')  
  
})

3.3Express 中间件的分类

Express 官方把常见的中间件用法，分成了 5 大类，分别是：

  1. 应用级别的中间件

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

    // 应用级别（全局中间件）
app.use(function (req,res，next){
    console.log(调用第一个)
    next()
})
​
​
// 应用级别（局部中间件）
app.get('user',mw,function (req,res){
    res.send('响应')  
  
})

  2. 路由级别的中间件

    const express = require('express')  //1. 引入express
const router = express.Router()    //2. 调用express.Router()函数创建路由对象
​
// 3.向路由对象上挂载具体的路由
router.use(function(req,res,next){
    next()
})
​
app.use('/',router)

  3. 错误级别的中间件

    • 错误级别中间件的作用：专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题。
    • 格式：错误级别中间件的 function 处理函数中，必须有 4 个形参，形参顺序从前到后，分别是 (err, req, res, next)。
    • 注意： 错误级别的中间件，必须注册在所有路由之后！
    // 应用级别（局部中间件）
app.get('/',function (req,res){
    throw new Error('服务器内部发生了错误')
    res.send('响应')  
  
})
​
app.use(function (err,req,res,next){
    console.log(err)
    res.send('Error' + err.message)
})

  4. Express 内置的中间件

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

    • express.static 快速托管静态资源的内置中间件，例如： HTML 文件、图片、CSS 样式等（无兼容性）
    • express.json 解析 JSON 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
    • express.urlencoded 解析 URL-encoded 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）

  5. 第三方的中间件

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

例如：在 express@4.16.0 之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。使用步骤如下：

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

四、使用Express 写接口

4.1 创建基本的接口服务

1.创建路由模块apiRouter.js文件：

// 引入
const express = require('express')
​
// 调用路由方法
const apiRouter = express.Router()
​
// 挂载的路由
apiRouter.get('/user',(req,res)=>{
    const query = req.query
    res.send({
        status：0，
        msg:'请求成功'
    })
})
​
// 导出
module export = router

2.引入路由模块并注册

// 引入
const express = require('express')
const apiRouer =  require('./apiRouer')
// 创建服务
const server = express()
​
// 注册路由
server.use('/api'，apiRouer)
​
// 启动服务
server.listen(80,()=>{
    console.log('服务启动成功')
})

4.2、CORS 跨域资源共享

刚才编写的 GET 和 POST接口，存在一个很严重的问题：不支持跨域请求。 解决接口跨域问题的方案主要有两种：

  • CORS（主流的解决方案，推荐使用）
  • JSONP（有缺陷的解决方案：只支持 GET 请求）
1.什么是cors？

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

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

2.cors的注意事项
  • CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口。
  • CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）。
3.使用cors中间件解决跨域问题

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

使用步骤分为如下 3 步：

  1. 运行 npm install cors 安装中间件
  2. 使用 const cors = require('cors') 导入中间件
  3. 在路由之前调用 app.use(cors()) 配置中间件
4.设置CORS响应头部 - Access-Control-Allow-Origin

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

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

默认情况下，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 三者之一）

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

// 允许客户端额外向服务器发送 Content-Type 请求头 和 X-Custom-Header 请求头
// 注意：多个请求头之间使用英文逗号进行分割
res.setHeader('Access-Control-Allow-Headers','Content-Type ,X-Custom-Header')
6.Access-Control-Allow-Methods

默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求。

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

示例代码如下：

//只允许post 、 get 、 delete 、 head
res.setHeader('Access-Control-Allow-Methods','PSOT,GET,DELETE,HEAD')
​
//允许所有的http请求方法
res.setHeader('Access-Control-Allow-Methods','*')

7.CORS请求的分类

客户端在请求 CORS 接口时，根据请求方式和请求头的不同，可以将 CORS 的请求分为两大类，分别是：

  • 简单请求

    • 请求方式：GET、POST、HEAD 三者之一
    • 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）

  • 预检请求

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

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

二者的区别：

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

4.2、JSONP接口

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

特点：

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

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

// 优先创建 JSONP 接口 【这个接口不会被处理成cors接口】
app.get('/api/jsonp'，(req,res)=>{})
​
// 再配置cors中间件【后续的所有接口，都会被处理成cors接口】
app.use(cors)
​
// 开启一个cors接口
app.get('/api/get',(req，res)=>{})
2.JSONP实现步骤
  • 获取客户端发送过来的回调函数的名字
  • 得到要通过 JSONP 形式发送给客户端的数据
  • 根据前两步得到的数据，拼接出一个函数调用的字符串
  • 把上一步拼接得到的字符串，响应给客户端的 
// 服务端接口
app.get('/api/jsonp'，(req,res)=>{})
​
// 1.获取客户端发送过来的回调函数的名字
const funcName = req.query.callback
​
// 2.得到要通过jsonp形式发送给客户端的数据
const data= {name:'ls',age：22}
 
// 3.根据前两步得到的数据，拼接出一个函数调用的字符串
const scritptStr= `${funcName}(${JSON.stringify(data)})`
​
// 4.把上一步拼接得到字符串，响应给客户端的<script> 标签解析执行
res.send(scritptStr)

客户端：

 const btn = document.querySelector('button');
    
    function handleFn(params) {
        console.log('jsonp请求响应',params)
    }

    // JSONP 请求 
    btn.addEventListener('click',()=>{
        const script = document.createElement('script')
        script.src='http://127.0.0.1:80/jsonp?callback= handleFn'
        document.body.append(script)

    })
avatar
文章
阅读
粉丝