十使用Express写接口

Posted 上善若水

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了十使用Express写接口相关的知识，希望对你有一定的参考价值。

一、使用 Express写接口

1.1、创建基本的服务器

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

// write your code here ...

// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(80, () => 
    console.log('Express server running at http://127.0.0.1')
)

1.2、创建 API 路由模块

// apiRouter.js [路由模块]
const express = require('express')
const router = express.Router()

// bind your router here ...

module.exports = router

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

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

1.3、编写 GET 接口

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

1.4、编写 POST 接口

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

注意：如果获取 URL-encoded 格式的请求体数据，必须配置中间件 app.use(express.urlencoded(extended: false))

二、CORS 跨域资源共享

2.1、接口的跨域问题

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

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

https://staticfile.org/
案例：

<!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/3.6.1/jquery.min.js"></script>
</head>
<body>
    <button id="btnGet">GET</button>
    <button id="btnPost">POST</button>
</body>
<script>
    $(function()
        // 测试 GET 接口
        $('#btnGet').on('click', function()
            $.ajax(
                type: 'GET',
                url: 'http://127.0.0.1/api/get',
                data: name: 'zs', age: 18,
                success: function(res) 
                    console.log(res)
                
            )
        )

        // 测试 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>
</html>

2.2、使用 cors中间件解决跨域问题

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

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

2.3、什么是 CORS

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

2.4、CORS 的注意事项

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

2.5、CORS 响应头部 Access-Control-Allow-Origin

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

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

其中，origin 参数的值指定了允许访问该资源的外域 URL。
例如，下面的字段值将只允许来自 https://blog.csdn.net/btt2013 的请求

res.setHeader('Access-Control-Allow-Origin','https://blog.csdn.net/btt2013')

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

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

2.6、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')

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

2.8、CORS 请求的分类

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

  1. 简单请求
  2. 预检请求

2.8.1、简单请求

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

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

2.8.2、预检请求

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

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

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

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

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

案例：

三、JSONP 接口

3.1、 JSONP 的概念与特点

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

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

3.2、创建 JSONP 接口的注意事项

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

// 优先创建 JSONP 接口 【这个接口不会被处理成 CORS 接口】
app.get('/api/jsonp', (req, res) =>  )
// 再配置 CORS 中间件 【后续的所有接口，都会被处理成 CORS 接口】
app.use(cors())
// 这是一个开启了 CORS 的接口
app.get('/api/get', (req, res) =>  )

3.3、实现 JSONP 接口的步骤

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

3.4、实现 JSONP 接口的具体代码

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

3.5、在网页中使用 jQuery 发起 JSONP 请求

调用 $.ajax()函数，提供 JSONP 的配置选项，从而发起 JSONP 请求，示例代码如下：

$('btnJSONP').on('click', function()
	$.ajax(
		method: 'GET',
		url: 'http://127.0.0.1/api/jsonp',
		dataType: 'jsonp', // 表示要发起 JSONP 的请求
		success: function (res) 
			console.log(res)
		
	)
)

案例：

以上是关于十使用Express写接口的主要内容，如果未能解决你的问题，请参考以下文章

使用 Express 写接口丨Node.js-初识 Express

Node.js---使用Express写接口

基于 Express 写接口

网易免费邮箱开放搜索引擎外域登录

node+pm2+express+mysql+sequelize来搭建网站和写接口

第二十五天接口多态