什么是HATEOAS？

__Black_Opium__

于 2024-09-17 18:00:20 发布

阅读量1k

点赞数 20

文章标签：笔记后端

本文链接：https://blog.csdn.net/2404_87410060/article/details/142316955

版权

HATEOAS 是 Hypermedia as the Engine of Application State 的缩写，是 REST（Representational State Transfer） 架构风格中的一项约束条件。它的核心思想是，客户端 与 服务器 之间的交互不仅仅依赖预定义的 API 规则，而是通过超媒体（如链接、表单等）动态引导客户端操作下一步要执行的操作。

1. HATEOAS 的基本概念

在典型的 REST API 中，客户端通过请求 URL 来获取资源。HATEOAS 扩展了这种交互方式，使得服务器不仅返回资源数据，还返回与该资源相关的操作链接，客户端可以通过这些链接进行下一步操作。

超媒体 在 HATEOAS 中的作用是类似于 Web 浏览中的超链接，通过这些链接，客户端可以发现可以执行的操作，而不需要在一开始就硬编码所有 API 的交互方式。

2. HATEOAS 的基本结构

在 HATEOAS 的约束下，服务器返回的数据通常包含以下内容：

资源的当前状态：即客户端请求的资源本身。
可执行操作的链接：与该资源相关的可能操作（如查看、修改、删除、导航到关联资源等）的 URL。

假设你有一个 RESTful API，用于处理用户资源。一个用户的 GET 请求可能会返回以下 JSON 响应：

{
  "id": 123,
  "name": "John Doe",
  "email": "johndoe@example.com",
  "_links": {
    "self": { "href": "/users/123" },
    "edit": { "href": "/users/123/edit" },
    "friends": { "href": "/users/123/friends" },
    "delete": { "href": "/users/123", "method": "DELETE" }
  }
}

在这个例子中：

id、name 和 email 是返回的用户资源本身的数据。
_links 提供了一组与该用户相关的超媒体链接：
- self：链接到当前用户的详细信息，指向 /users/123。
- edit：提供修改用户信息的链接，指向 /users/123/edit。
- friends：提供查看用户朋友的链接，指向 /users/123/friends。
- delete：提供删除用户的链接，指向 /users/123，并且指定了请求方法为 DELETE。

客户端只需要解析这个响应并根据超媒体链接来知道接下来可以执行的操作，而不需要事先了解整个 API 结构。

3. HATEOAS 的优势

自发现能力：
- 客户端不需要提前知道所有 API 的路径和操作，只需根据服务器提供的链接进行操作。这种方式使得客户端能够根据当前状态动态发现下一步要做的事情。
灵活性：
- API 可以随着时间的推移进行扩展或更改，而不会破坏现有客户端的功能。客户端只需要遵循服务器返回的链接即可，而不是依赖硬编码的 API 路径。
松耦合：
- 客户端和服务器之间的耦合度降低。客户端无需了解 API 的具体实现，服务器负责提供必要的链接来引导客户端操作。
状态驱动：
- 通过链接和超媒体，客户端可以在应用程序的不同状态之间进行导航。每个资源的操作都由其状态来决定，确保了数据的上下文完整性。

4. HATEOAS 在 RESTful API 中的应用

HATEOAS 是 REST 架构风格的一个重要约束条件。虽然很多 REST API 都自称为 RESTful，但并没有完全实现 HATEOAS。实现 HATEOAS 的 REST API 能够根据资源状态动态提供可以进行的操作链接，从而让 API 更具自发现性和动态适应性。

典型的 HATEOAS 流程：

初始请求：客户端请求一个根资源，比如 /api.
```
{
  "_links": {
    "self": { "href": "/api" },
    "users": { "href": "/users" },
    "posts": { "href": "/posts" }
  }
}
```
服务器返回了根资源的可操作链接，告诉客户端可以访问用户列表或帖子列表。

获取用户列表：客户端接下来访问 /users，获取用户列表。

{
  "_embedded": {
    "users": [
      {
        "id": 123,
        "name": "John Doe",
        "_links": {
          "self": { "href": "/users/123" },
          "edit": { "href": "/users/123/edit" },
          "delete": { "href": "/users/123", "method": "DELETE" }
        }
      }
    ]
  }
}

服务器返回用户列表，同时提供了每个用户可执行的操作链接。

查看某个用户的详细信息：客户端通过链接 /users/123 访问某个用户的详细信息。
修改或删除用户：根据服务器返回的操作链接，客户端可以决定是否进行修改或删除等操作。

5. HATEOAS 与传统 REST API 的区别

传统 REST API：客户端必须提前知道所有的 API 路径和操作，所有的 URL 和操作方式通常是硬编码在客户端代码中的。API 更新时，客户端需要同步更新。
HATEOAS REST API：客户端通过解析服务器返回的超媒体链接来进行操作，而不需要硬编码所有路径。API 可以灵活地扩展和变更，客户端也可以动态适应这些变化。