WHAT - 不同 HTTP Methods 使用场景、使用方法和可能遇到的问题

于 2024-07-25 17:33:18 发布
阅读量900 收藏 18
点赞数 15
分类专栏： 前端网络学习专栏 文章标签： http 网络协议 网络
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_58540586/article/details/140695359
版权

目录

前言

HTTP Methods: Request methods define the type of action you are requesting to be performed.

  1. GET - Requests retrieve resource information
  2. POST - The server creates a new entry in a database
  3. PUT - Updates an existing resource
  4. PATCH - Very similar to PUT but makes a partial update on a resource
  5. DELETE - Deletes resource or related component
  6. HEAD - Retrieve response headers identical to those of a GET request, but without the response body.
  7. CONNECT - Establishes a tunnel to the server identified by the target resource
  8. OPTIONS - Describe the communication options for the target resource
  9. TRACE - Performs a message loop-back test along the path to the target resource
  10. <custom> - Some APIs use custom request methods such as LIST. Type in your custom methods.

基本介绍

MDN - HTTP Request Methods

HTTP 方法是用于指示请求的类型的动作的标准化方式。以下是常见的 HTTP 方法：

  1. GET: 从服务器检索资源。通常用于获取数据。
  2. POST: 向服务器发送数据以创建资源。常用于提交表单或上传文件。
  3. PUT: 向服务器发送数据以更新资源。通常用于更新现有资源的全部内容。
  4. PATCH: 向服务器发送部分数据以更新资源。通常用于部分更新资源。
  5. DELETE: 从服务器删除资源。
  6. HEAD: 检索资源的头部信息，类似于 GET 请求，但不返回资源的主体部分。
  7. OPTIONS: 返回服务器支持的所有 HTTP 方法。
  8. CONNECT: 建立一个到目标资源的隧道。主要用于代理服务器。
  9. TRACE: 执行一个消息环回测试，沿着路径到目标资源的请求的路由。

示例代码

这里是一个简单的使用 fetch 函数执行几种常见 HTTP 方法（get、post、put、patch、delete）的示例代码：

async function httpRequest(method: string, url: string, data?: any) {
  const options: RequestInit = {
    method: method,
    headers: {
      'Content-Type': 'application/json'
    },
    body: data ? JSON.stringify(data) : undefined
  };

  try {
    const response = await fetch(url, options);
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    const result = await response.json();
    return result;
  } catch (error) {
    console.error('Error:', error);
  }
}

// 示例用法
const apiUrl = 'https://jsonplaceholder.typicode.com/posts';

// GET 请求
httpRequest('GET', apiUrl).then(data => console.log(data));

// POST 请求
httpRequest('POST', apiUrl, { title: 'foo', body: 'bar', userId: 1 })
  .then(data => console.log(data));

// PUT 请求
httpRequest('PUT', `${apiUrl}/1`, { id: 1, title: 'foo', body: 'bar', userId: 1 })
  .then(data => console.log(data));

// PATCH 请求
httpRequest('PATCH', `${apiUrl}/1`, { title: 'foo' })
  .then(data => console.log(data));

// DELETE 请求
httpRequest('DELETE', `${apiUrl}/1`)
  .then(data => console.log(data));

说明

  1. httpRequest: 一个通用的 HTTP 请求函数，接受 HTTP 方法、URL 和可选的数据。
  2. RequestInit: 用于配置 fetch 请求的选项，包括方法、头部和主体。
  3. fetch: 执行 HTTP 请求的 JavaScript API。

这个示例演示了如何使用 fetch 函数执行各种 HTTP 方法的请求。你可以根据需要调整 url 和 data 参数以匹配你的具体 API。

具体介绍

前置知识：幂等和非幂等

幂等性（Idempotency）是计算机科学中的一个重要概念，用于描述操作的可重复性和稳定性。在 HTTP 请求中，幂等性表示多次执行相同的请求应当产生相同的结果。

幂等操作

定义: 幂等操作是指无论操作执行多少次，产生的效果都相同。

HTTP 方法的幂等性:

  • GET: 幂等。多次执行 GET 请求会返回相同的资源数据，不会改变服务器状态。
  • PUT: 幂等。多次执行 PUT 请求将资源替换为相同内容，因此效果相同。
  • DELETE: 幂等。多次执行 DELETE 请求会删除资源，且删除不存在的资源不会再有变化。
  • HEAD: 幂等。多次执行 HEAD 请求会返回相同的头部信息，不会改变服务器状态。
  • OPTIONS: 幂等。多次执行 OPTIONS 请求会返回相同的支持方法列表，不会改变服务器状态。
  • TRACE: 幂等。多次执行 TRACE 请求会返回相同的路径信息，不会改变服务器状态。

非幂等操作

定义: 非幂等操作是指操作执行多次会产生不同的效果。

HTTP 方法的非幂等性:

  • POST: 非幂等。多次执行 POST 请求会创建多个资源，产生不同的结果。
  • PATCH: 通常非幂等。多次执行 PATCH 请求可能会导致资源的部分更新，产生不同的结果。尽管有时可以设计成幂等，但一般认为是非幂等的。

幂等性和非幂等性的应用场景

幂等性应用场景:

  • 数据读取: 使用 GET 方法读取数据，无论请求多少次，数据不会改变。
  • 资源替换: 使用 PUT 方法完全替换资源，多次请求结果相同。
  • 资源删除: 使用 DELETE 方法删除资源，多次请求结果一致。

非幂等性应用场景:

  • 数据创建: 使用 POST 方法创建新资源，每次请求都会产生新的资源。
  • 部分更新: 使用 PATCH 方法更新资源的部分内容，每次请求可能产生不同的结果。

总结

理解幂等性和非幂等性对于设计和实现可靠的 HTTP API 非常重要。幂等操作可以提高系统的稳定性和可预测性，而非幂等操作适合用于创建或部分更新资源。在实际开发中，选择合适的 HTTP 方法来满足业务需求，同时考虑幂等性，确保系统的健壮性和一致性。

1. GET

使用场景:

  • 用于从服务器获取资源数据，如网页、图片、JSON 数据等。
  • 适合只读取数据而不改变服务器状态的请求。

使用方法:

fetch('https://example.com/data')
  .then(response => response.json())
  .then(data => console.log(data));

可能遇到的问题:

  • 缓存问题：浏览器可能缓存 GET 请求的响应，导致获取的不是最新数据。可以通过设置请求头或在 URL 中添加时间戳来避免。
  • URL 长度限制：有些浏览器对 URL 长度有限制，GET 请求参数太多时可能会出问题。

2. POST

使用场景:

  • 用于向服务器发送数据以创建新资源，例如提交表单、上传文件等。
  • 适合需要将数据发送到服务器进行处理的请求。

使用方法:

fetch('https://example.com/api', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ name: 'John', age: 30 })
})
  .then(response => response.json())
  .then(data => console.log(data));

可能遇到的问题:

  • 重复提交：用户可能会多次点击提交按钮，导致重复提交。可以通过禁用按钮或其他方式避免。
  • CSRF 攻击：需要防范跨站请求伪造攻击，通常通过使用 CSRF 令牌来防御。

3. PUT

使用场景:

  • 用于更新服务器上的现有资源的全部内容。
  • 适合需要完全替换资源的请求。

使用方法:

fetch('https://example.com/api/resource/1', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ id: 1, name: 'John', age: 31 })
})
  .then(response => response.json())
  .then(data => console.log(data));

可能遇到的问题:

  • 幂等性：PUT 请求应当是幂等的，多次执行相同的 PUT 请求应当产生相同的结果。
  • 数据完整性：需要确保发送的数据是完整的，因为 PUT 是替换整个资源。

4. PATCH

使用场景:

  • 用于更新服务器上的资源的部分内容。
  • 适合需要部分更新资源的请求。

使用方法:

fetch('https://example.com/api/resource/1', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ age: 31 })
})
  .then(response => response.json())
  .then(data => console.log(data));

可能遇到的问题:

  • 部分更新：确保只发送需要更新的字段，避免影响其他字段。
  • 幂等性：虽然 PATCH 可以是非幂等的，但尽量使其幂等，即多次相同的 PATCH 请求应当产生相同的结果。

延伸：

要确保 PATCH 请求是幂等的，可以采取以下几种策略：

1. 确保操作是幂等的

在服务器端处理 PATCH 请求时，确保每次相同的请求对资源产生相同的修改效果。这通常涉及在更新资源时使用幂等的方法。

示例: 更新用户的某个属性

// PATCH 请求体
{
  "age": 31
}

服务器接收到这个请求时，只更新 age 属性，不改变其他属性。

2. 使用版本控制或条件更新

通过检查资源的版本或条件来确保更新操作的幂等性。例如，可以使用乐观锁定或 If-Match 头来进行条件更新。

示例:

PATCH /resource/1 HTTP/1.1
Host: example.com
Content-Type: application/json
If-Match: "abc123"

{
  "age": 31
}

服务器只有在资源的版本匹配 If-Match 头中提供的版本时才会进行更新，这样可以确保幂等性。

3. 全量更新部分属性

尽量在 PATCH 请求中提供所有需要更新的字段，即使某些字段的值没有变化。这确保了每次请求都是对特定字段的完整更新，而不是依赖于资源的当前状态。

示例:

// PATCH 请求体
{
  "name": "John",
  "age": 31,
  "email": "john@example.com"
}

4. 使用特定操作指令

在 PATCH 请求体中明确指定操作类型，如 replace、add、remove 等。这些操作可以使用 JSON Patch 格式来表示。

JSON Patch 示例:

[
  { "op": "replace", "path": "/age", "value": 31 }
]

服务器根据操作指令执行相应的更新，从而确保幂等性。

5. 幂等标识符

使用幂等标识符来确保每个请求只被处理一次。客户端生成一个唯一的幂等标识符，并在请求中发送给服务器。服务器在处理请求时检查这个标识符，确保每个标识符只处理一次。

示例:

PATCH /resource/1 HTTP/1.1
Host: example.com
Content-Type: application/json
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000

{
  "age": 31
}

示例代码

以下是一个简单的 Node.js 服务器示例，展示如何实现幂等的 PATCH 请求：

const express = require('express');
const app = express();
app.use(express.json());

let resource = { id: 1, name: 'John', age: 30, email: 'john@example.com' };
let processedRequests = {};

app.patch('/resource/:id', (req, res) => {
  const idempotencyKey = req.headers['idempotency-key'];

  if (idempotencyKey && processedRequests[idempotencyKey]) {
    return res.status(200).send(processedRequests[idempotencyKey]);
  }

  const update = req.body;

  // Update resource in an idempotent way
  if (update.name !== undefined) resource.name = update.name;
  if (update.age !== undefined) resource.age = update.age;
  if (update.email !== undefined) resource.email = update.email;

  const response = { message: 'Resource updated', resource };

  if (idempotencyKey) {
    processedRequests[idempotencyKey] = response;
  }

  res.status(200).send(response);
});

app.listen(3000, () => {
  console.log('Server running on port 3000');
});

总结

确保 PATCH 请求幂等性的方法包括：

  1. 确保操作是幂等的：每次相同的请求应产生相同的结果。
  2. 使用版本控制或条件更新：如 If-Match 头。
  3. 全量更新部分属性：确保所有需要更新的字段都包含在请求中。
  4. 使用特定操作指令：如 JSON Patch 格式。
  5. 使用幂等标识符：确保每个请求只处理一次。

通过这些方法，可以确保 PATCH 请求的幂等性，从而提高系统的可靠性和一致性。

5. DELETE

使用场景:

  • 用于从服务器删除资源。
  • 适合需要删除资源的请求。

使用方法:

fetch('https://example.com/api/resource/1', {
  method: 'DELETE'
})
  .then(response => {
    if (response.ok) {
      console.log('Resource deleted');
    }
  });

可能遇到的问题:

  • 幂等性：DELETE 请求应当是幂等的，多次执行相同的 DELETE 请求应当产生相同的结果。
  • 资源不存在：需要处理删除不存在的资源的情况，通常返回 404 状态码。

6. HEAD

使用场景:

  • 用于检索资源的元数据，而不获取资源的主体部分。
  • 适合需要检查资源是否存在或获取资源的头部信息（如大小、类型）的请求。

使用方法:

fetch('https://example.com/data', {
  method: 'HEAD'
})
  .then(response => {
    if (response.ok) {
      console.log('Resource exists');
    }
  });

可能遇到的问题:

  • 信息有限：HEAD 请求只返回头部信息，不返回实际数据主体，需根据返回的头部信息判断资源状态。

7. OPTIONS

使用场景:

  • 用于查询服务器支持的请求方法。
  • 适合在跨域请求前检查服务器是否允许特定方法的请求。

使用方法:

fetch('https://example.com/api', {
  method: 'OPTIONS'
})
  .then(response => {
    if (response.ok) {
      console.log('Options:', response.headers.get('Allow'));
    }
  });

可能遇到的问题:

8. CONNECT

使用场景:

  • 用于建立到目标资源的隧道，主要用于代理服务器。
  • 适合在需要通过代理进行安全连接（如 HTTPS）的请求。

使用方法:
CONNECT 方法通常由浏览器或其他客户端自动处理，用户不直接使用。

可能遇到的问题:

  • 代理配置：确保代理服务器正确配置，以支持 CONNECT 方法。

9. TRACE

使用场景:

  • 用于执行消息环回测试，诊断路径问题。
  • 适合在开发和调试时检查请求的路径和中间代理的修改。

使用方法:
TRACE 方法通常由开发工具或诊断工具使用，用户不直接使用。

可能遇到的问题:

  • 安全问题：TRACE 方法可能被滥用进行跨站脚本攻击（XSS），许多服务器默认禁用 TRACE 方法。

总结

每个 HTTP 方法都有其特定的使用场景和可能遇到的问题。根据需求选择合适的方法，并注意相应的安全性和幂等性，确保请求的正确性和可靠性。

@PHARAOH
关注
  • 15
    点赞
  • 踩
  • 18
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
HTTP协议漫谈 - HTTP协议请求方法
ccpat的专栏
03-19 4925
前言 在上一篇文章《HTTP协议漫谈 - HTTP协议历史和报文结构》中介绍了HTTP协议的历史和版本变化，以及HTTP协议报文的总体结构。 按照HTTP/1.1 RFC文档中的定义，HTTP报文包括起始行，头域和消息体三个部分。其中起始行又分为请求行和状态行，请求行是HTTP请求中的起始行，它又包含了三个部分：请求方法，请求URI和HTTP协议版本。本文就来介绍HTTP请求中的请求方法。 ...
what-anime-cli：using使用终端通过图像查找动漫场景
02-04
什么动漫CLI :question_mark: :framed_picture: >此应用程序基本上是 :candy: 周围的包装器预习用法 :desktop_computer:通过图像文件获取动漫 :card_file_box: what-anime file anime.jpg 通过图像链接获取动漫 :...
WHAT - 富文本编辑器系列（二）- 表情包面板
最新发布
weixin_58540586的博客
06-07 876
在一个富文本编辑器中实现表情包面板和选择功能需要以下几个步骤：1. **添加表情包按钮**：在编辑器的工具栏中添加一个按钮，点击该按钮可以打开表情包面板。2. **创建表情包面板**：设计一个表情包面板，包含多个表情图片，用户可以点击选择表情。3. **插入表情到编辑器**：用户选择表情后，将表情插入到编辑器的内容中。
HTTP协议中GET和POST方法的区别
王海虎的博客
05-28 711
HTTP协议中GET和POST方法的区别Published: February 09, 2017 by 杨光Categories: uncategorized 3Tags: HTTP 2HTTP协议中GET和POST方法的区别已经是老生常谈了，也是面试热门问题，我之前对此只有一个粗浅的印象，这里来认真探讨一下。通常的理解w3schools关于这个问题的解答：HTTP 方法：GET 对比 POST ...
《机器学习实战》学习笔记（四）：基于概率论的分类方法 - 朴素贝叶斯
种树最好的时间是10年前，其次是现在！！！
08-28 9607
【机器学习】《机器学习实战》读书笔记及代码 总目录 https://blog.csdn.net/TeFuirnever/article/details/99701256 —————————————————————————————————————————————————————— 目录本章内容 本章内容 使用概率分布进行分类 学习朴素贝叶斯分类器 解析RSS源数据 使用朴素贝叶斯来分析不同地区...
Mockito使用-----常用demo
u011624267的博客
06-20 761
mockito介绍 mockito常用方法 mockito使用demo
HTTP中GET和POST的区别
qq_19525389的博客
09-02 385
       我们通常在讨论 GET vs POST 的时候，实际上讨论的是 specification，而不是 implementation。什么是 specification？说白了就是相关的 RFC。implementation 则是所有实现了 specification 中描述的代码/库/产品，比如 curl，Python 的 requests 库，或者 Chrome。POST 请求怎么发...
如何使用Angular 1.5的Component方法
culiu9261的博客
07-19 442
Web Components are a set of features that allow the creation of reusable widgets in web documents and web applications. Web组件是允许在Web文档和Web应用程序中创建可重用窗口小部件的一组功能。 The components model in Angular 1.5.x...
如何在返回String的Spring MVC @ResponseBody方法中响应HTTP 400错误？
asdfgh0077的博客
06-08 557
I'm using Spring MVC for a simple JSON API, with @ResponseBody based approach like the following. 我
2021-10-22 学习笔记：FastAPI基础使用指南
baby_hua的专栏
10-22 2111
2021-10-22 学习笔记：FastAPI基础使用指南 已经第三针疫苗了，祝所有人平安！ 简单使用 路径参数 查询参数 请求体 查询参数和字符串校验 路径参数和数值校验 请求体参数 请求体 —— 多个参数 请求体 —— 字段 请求体 —— 嵌套模型 模式额外信息 数据类型 Cookie参数 Header参数 响应模型 其他模型 响应状态码 常用的http状态码 表单数据 上传文件 处理错误 覆盖默认异常处理器 路径参数配置 jsonable_encoder Pydantic 的
Linux whatis命令的使用方法
01-09
`whatis`命令是Linux操作系统中的一个实用工具，它允许用户快速查找系统命令的简短描述。这个命令从预构建的数据库中检索...结合`man`命令（提供更详细的命令文档），`whatis`能帮助用户更好地理解和使用Linux系统。
Linux whatis与whatis database使用及查询方法
01-09
在学习man命令时候，估计很多朋友都发现有man –f ，man –k 参数，可以查出很多数据。这些有的与man手册页相同，有些不是属于手册页的。它们数据怎么收集来的... 　#whatis – search the whatis database for comple
Powershell错误处理之what-if
09-21
总的来说，`What-If`和`Confirm`是PowerShell中强大的错误处理和安全性工具，它们帮助用户在执行命令或脚本时保持谨慎和控制，尤其在自动化环境中，这些功能能够显著减少因误操作可能导致的问题。通过熟练掌握这些...
What-App-Automation：这是使用Python和Selenium发送消息和图像视频的What-App-Automation。
01-31
什么是应用程序自动化 这是使用Python和Selenium发送消息和图像/视频的Whats-App-Automation视频：依存关系： Seleniumpip install selenium还要根据您的Chrome版本从此处下载Chrome驱动程序：-所有者： 贡献者： ...
Sco-Unix调试工具dbx使用方法
11-25
本文将详细介绍Sco-Unix调试工具dbx的各种使用方法及其应用场景。 #### 二、dbx的基本用法 ##### 1. 启动dbx - **命令**: `dbx 可执行文件名` - 示例: 如果可执行文件名为`test`，则命令为`dbx test`。 - **注意**...
linux whatis与whatis database 使用及查询方法(man使用实例)
09-15
Linux中的`whatis`命令和`whatis`数据库是系统管理员和开发者在寻找命令或工具简要信息时的重要工具。`whatis`数据库是一个包含了系统中所有可执行文件、命令和程序简短描述的文本文件，它使得用户可以通过关键词...
VueJS事件处理器v-on的使用方法
10-19
在方法内部，可以访问到原始的DOM事件对象`event`，可以使用它来操作事件，比如`event.preventDefault()`阻止默认行为或`event.stopPropagation()`阻止事件冒泡。 7. **事件修饰符与原生事件**： 当需要同时处理...
What-makes-it-page
11-20
What-makes-it-page资源分享
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值