使用express框架编写接口教程

weixin_63443072

已于 2023-02-05 17:39:46 修改

阅读量213

点赞数 1

分类专栏： node.js 文章标签： express 服务器运维

于 2023-02-05 17:36:04 首次发布

本文链接：https://blog.csdn.net/weixin_63443072/article/details/128891230

版权

node.js 专栏收录该内容

14 篇文章 2 订阅

订阅专栏

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

6.CORS 响应头部 - Access-Control-Allow-Headers

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

(4)使用jQuery 发起JSONP 请求

一、创建基本服务器

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

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

// 必须要在配置cors中间件之前，配置JSONP的接口
app.get('/api/jsonp',(req,res)=>{
    // 1.得到函数的名称
    const funcName = req.query.callback
    // 2.定义要发送到客户端的数据对象
    const data = {name:'zs',age:22}
    // 3.拼接出一个函数的调用
    const scriptStr = `${funcName}(${JSON.stringify(data)})`
    // 4.把拼接的字符串，响应给客户端
    res.send(scriptStr)
})

// 一定要在路由之前，配置cors这个中间件，从而解决接口跨域问题
const cors = require('cors')
app.use(cors())

// 导入路由模块
const router = require('./16.apiRouter')
app.use('api',router)

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

二、创建API路由模块

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

router.post('/post',(req,res)=>{
    const body = req.body
    req.send({
        status:0,
        msg:'POST请求成功！',
        data:body
    })
})

router.delete('/delete',(req,res)=>{
    req.send({
        status:0,
        msg:'DELETE请求成功！'
    })
})
module.exports=router

补充知识点:

1.接口的跨域问题

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

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

CORS(主流的解决方案，推荐使用)
JSONP (有缺陷的解决方案: 只支持 GET 请求)

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

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

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

3.什么是CORS

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

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

4.CORS的注意事项

CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口。
CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了CORS 的服务端接口 (例如: IE10+、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-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')

7.CORS 响应头部 - 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 '，'POST，GET，DELETE，HEAD')
// 允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Allow-Methods','*')

8.CORS请求的分类

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

简单请求
预约请求

(1)简单请求

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

请求方式: GET、POST、HEAD 三者之一
HTTP 头部信息不超过以下几种字段: 无自定义头部字段、Accept、Accept-Language、 Content-Language、DPR、Downlink、Save-DataViewport-Width、 Width 、Content-Type(只有三个值application/x-www-form-urlencoded、multipart/form-data text/plain)

(2)预检请求

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

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

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

(3)区别

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

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

9.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接口
app.use(cors())

// 这是一个开启了 CORS 的接口
app.get('api/get',(req,res)=>{})

(3)实现JSONP接口的步骤

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

(4)使用jQuery 发起JSONP 请求

<!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.3/jquery.min.js"></script>
</head>
<body>
    <button id="btnGET">GET</button>
    <button id="btnPOST">POST</button>
    <button id="btnDELETE">DELETE</button>
    <script>
        $(function(){
            $('#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);
                    }
                })
            })
            $('#btnPOST').on('click',function(){
                $.ajax({
                    type:'POST',
                    url:'http://127.0.0.1/api/post',
                    data:{bookname:'水浒传',author:'哈哈哈'},
                    success:function(res){
                        console.log(res);
                    }
                })
            })
            $('#btnDELETE').on('click',function(){
                $.ajax({
                    type:'DELETE',
                    url:'http://127.0.0.1/api/delete',
                    success:function(res){
                        console.log(res);
                    }
                })
            })
        })
    </script>
</body>
</html>

weixin_63443072

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
使用express框架编写接口教程

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

扫一扫

专栏目录