Node.js-使用Express写接口

qq_52822043

已于 2022-06-22 22:50:09 修改

阅读量798

点赞数

CC 4.0 BY-SA版权

文章标签：服务器 vue.js javascript

于 2022-05-18 14:39:21 首次发布

本文链接：https://blog.csdn.net/qq_52822043/article/details/124828333

本文详细介绍了如何使用Node.js创建基本的服务器，设置API路由，编写GET和POST接口，并解决了跨域资源访问的问题。通过引入CORS中间件解决接口的跨域问题，讲解了CORS的原理、注意事项和相关响应头部。同时，还探讨了JSONP的概念、特点以及如何在服务器端实现和在网页中发起JSONP请求。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

5）CORS响应头部 - Access-Control-Allow-Origin

6）CORS响应头部 - Access-Control-Allow-Header

7）CORS响应头部 - Access-Control-Allow-Methods

5）在网页中使用jQuery发起JSONP请求

1. 创建基本的服务器

// 1.导入express
const express = require('express')
// 2.创建web服务器
const app = express()

...

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

2. 创建API路由模块

apiRouter.js

const express = require('express')
const router = express.Router()

module.exports = router

api.js

// 导入express
const express = require('express')
// 创建服务器口实例
const app = express()
// 导入路由模块
const router = require('./apiRouter.js')

// 把注册模块挂载到app实例上
app.use('/api', router)

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

3. 编写GET接口

const express = require('express')
const router = express.Router()

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

module.exports = router

结果：

4. 编写POST接口

const express = require('express')
const router = express.Router()

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

module.exports = router

结果：

5. CORS跨域资源

1）接口的跨域问题

刚才编写的GET和POST接口，存在一个很严重的问题：不支持跨域请求。

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

CORS（主流的解决方案，推荐使用）
JSONP（有缺陷的解决方案：只支持GET请求）

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
    <script src="https://cdn.staticfile.org/jquery/1.10.0/jquery.min.js"></script>
  </head>
  <body>
    <button id="btnGET">GET</button>
    <button id="btnPOST">POST</button>

    <script>
      $(function () {
        // 1.测试GET接口
        $('#btnGet').on('click', function () {
          $.ajax({
            type: 'GET',
            url: 'http://127.0.0.1/api/get',
            data: {name: 'zs', age: 20},
            success: function (res) {
              console.log(res)
            },
          })
        })
        // 2.测试POST接口
        $('#btnPOST').on('click', function () {
          $.ajax({
            type: 'POST',
            url: 'http://127.0.0.1/api/post',
            data: {bookname: '水浒传', author: '施耐庵'},
            success: function (res) {
              console.log(res)
            },
          })
        })
      })
    </script>
  </body>
</html>

结果：

2）使用cors中间件解决跨域问题

cors是Express的一个第三方中间件。通过安装和配置cors中间件，可以很方便的解决跨域问题。使用步骤分为如下3步：

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

// 导入express
const express = require('express')
// 创建服务器口实例
const app = express()

// 导入路由模块
const router = require('./11-apiRouter.js')

// 导入cors中间件
const cors = require('cors')
// 在路由之前调用配置这个中间件
app.use(cors())

// 配置解析表单数据的中间件
app.use(express.urlencoded({extended: false}))
// 把注册模块挂载到app实例上
app.use('/api', router)

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

结果：

3）什么是CORS

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

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

4）CORS的注意事项

CORS主要在服务器端进行配置，客户端浏览器无须做任何额外的配置，即可请求开启了CORS的接口
CORS在浏览器中有兼容性。只有支持XMLHttpRequest Level2的浏览器，才能正常访问开启了CORS的服务器接口（例如：IE 10+、Chrome4+、FireFox3.5+）

5）CORS响应头部 - Access-Control-Allow-Origin

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

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

origin参数的值指定了允许访问该资源的外域URL。例如，下面的字段值将只允许来自 http://itcast.cn 的请求：

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

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

res.setHeader('Access-Control-Allow-Origin', '*')

6）CORS响应头部 - Access-Control-Allow-Header

默认情况下，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')

7）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', '*')

8）CORS请求的分类

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

简单请求
预检请求

9）简单请求

同时满足以下两大条件的请求，就属于简单请求：

请求方式：GET、POST、HEAD三者之一
HTTP头部信息不超过以下几种字段：无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type（值仅限于text/plain、multipart/form-data、application/x-www-form-urlencoded三者之一）

10）预检请求

只要符合以下任何一个条件的请求，都需要进行预检请求：

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

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

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

简单请求的特点：客户端与服务器之间只会发生一次请求。

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

// apiRouter.js
router.delete('/delete', (req, res) => {
  res.send({
    statue: 0,
    msg: 'DELETE请求成功',
  })
})

// html
        $('#btnDELETE').on('click', function () {
          $.ajax({
            type: 'DELETE',
            url: 'http://127.0.0.1/api/delete',
            success: function (res) {
              console.log(res)
            },
          })
        })
      })

结果：

6. JSONP接口

1）JSONP的概念与特点

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

特点：

JSONP不属于真正的Ajax请求，因为它没有使用XMLHttpRequest这个对象
JSONP仅支持GET请求，不支持POST、PUT、DELETE等请求。

2）创建JSONP接口的注意事项

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

// 优先创建 JSONP 接口，这个接口不会被处理成CORS接口
app.get('/api/jsonp', (req, res) => {})
// 再配置CORS中间件，后续所有的接口都会被处理成CORS接口
// 导入cors中间件
const cors = require('cors')
// 在路由之前调用配置这个中间件
app.use(cors())

3）实现JSONP接口的步骤

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

4）实现JSONP接口的具体代码

// 优先创建 JSONP 接口，这个接口不会被处理成CORS接口
app.get('/api/jsonp', (req, res) => {
  // 1.获取客户端发送过来的回调函数的名字
  const funcName = req.query.callback
  // 2.得到要通过JSONP形式发送给客户端的数据
  const data = {name: 'zs', age: 20}
  // 3、根据前两步得到的数据，拼接处一个函数调用的字符串
  const scriptStr = `${funcName}(${JSON.stringify(data)})`
  // 4.把上一步拼接得到的字符串，响应给客户端的<script>标签进行解析执行
  res.send(scriptStr)
})

5）在网页中使用jQuery发起JSONP请求

调用$.ajsx()函数，提供JSONP的配置选项，从而发起JSONP请求。

<button id="btnJSONP">JSONP</button>

$('#btnJSONP').on('click', function () {
          $.ajax({
            type: 'GET',
            url: 'http://127.0.0.1/api/jsonp',
            dataType: 'jsonp',
            success: function (res) {
              console.log(res)
            },
          })
        })

结果：