当前位置：首页 > article >正文

【2024软考架构案例题】你知道什么是 RESTful 风格吗？

article 2024/12/25 2:01:35

👉博主介绍：博主从事应用安全和大数据领域，有8年研发经验，5年面试官经验，Java技术专家，WEB架构师，阿里云专家博主，华为云云享专家，51CTO 专家博主

⛪️ 个人社区：个人社区
💞 个人主页：个人主页
🙉 专栏地址： ✅ Java 中级
🙉八股文专题：剑指大厂，手撕 Java 八股文

在这里插入图片描述

文章目录

- - 1. 什么是 RESTful 风格？
  - 2. RESTful 风格应用场景
  - 3. 在实际项目中如何实践 RESTful 风格
  - - 1. 资源命名
    - 2. HTTP 方法
    - 3. 状态码
    - 4. 请求和响应格式
    - 5. 错误处理
    - 6. 认证和授权
    - 7. 版本控制
    - 8. 分页和过滤
    - 9. HATEOAS

1. 什么是 RESTful 风格？

RESTful（Representational State Transfer）风格是一种软件架构风格，用于设计网络应用程序，特别是基于 HTTP 协议的 Web 服务。RESTful 风格强调使用标准的 HTTP 方法（如 GET、POST、PUT、DELETE 等）来操作资源，使接口更加直观和易用。

主要原则：

无状态：每个请求必须包含理解请求所需的所有信息，服务器不应保存任何会话状态。
统一接口：使用标准的 HTTP 方法来操作资源，资源通过 URI（Uniform Resource Identifier）进行标识。
客户端-服务器分离：客户端和服务器可以独立发展，互不影响。
可缓存：响应可以被标记为可缓存，以提高性能。
分层系统：系统可以由多个层次组成，每一层都有特定的职责。
按需代码（可选）：服务器可以扩展客户端的功能，例如通过下载新的代码。

2. RESTful 风格应用场景

RESTful 风格广泛应用于各种需要通过网络进行数据交换的场景，特别是在现代 Web 开发中。以下是一些常见的应用场景：

Web API：提供数据和服务的接口，供前端应用或其他后端服务调用。
微服务架构：微服务之间通过 RESTful API 进行通信，实现松耦合和高可扩展性。
移动应用：移动应用通过 RESTful API 与后端服务器进行数据交互。
物联网（IoT）：IoT 设备通过 RESTful API 与云平台进行数据交换。
企业级应用：企业内部系统通过 RESTful API 实现不同系统之间的集成和数据共享。

3. 在实际项目中如何实践 RESTful 风格

在实际项目中，实践 RESTful 风格通常涉及以下几个方面：

1. 资源命名

使用名词：资源名应使用名词，表示实体，如 /users、/orders。
复数形式：资源名一般使用复数形式，表示一组资源。
层级关系：通过路径表示资源的层级关系，如 /users/{userId}/orders。

2. HTTP 方法

GET：用于获取资源，不应产生副作用。
POST：用于创建资源或提交数据。
PUT：用于更新资源，通常替换整个资源。
PATCH：用于部分更新资源。
DELETE：用于删除资源。
HEAD：用于获取资源的头部信息，不返回资源本身。
OPTIONS：用于获取资源支持的 HTTP 方法。

3. 状态码

200 OK：请求成功。
201 Created：资源已成功创建。
204 No Content：请求成功，但没有返回内容。
400 Bad Request：请求无效或格式错误。
401 Unauthorized：请求需要用户认证。
403 Forbidden：服务器理解请求，但拒绝执行。
404 Not Found：请求的资源不存在。
405 Method Not Allowed：请求方法不被允许。
500 Internal Server Error：服务器内部错误。

4. 请求和响应格式

JSON：使用 JSON 格式进行数据交换，易于解析和生成。
XML：在某些场景下使用 XML 格式。
Content-Type：通过 Content-Type 头部指定请求和响应的内容类型。

5. 错误处理

详细的错误信息：返回详细的错误信息，帮助客户端定位问题。

一致的错误格式：使用统一的错误格式，如：

{
  "error": "Not Found",
  "message": "The requested resource was not found."
}

6. 认证和授权

API 密钥：通过 API 密钥进行认证。
OAuth：使用 OAuth 2.0 进行认证和授权。
JWT：使用 JSON Web Tokens 进行认证和授权。

7. 版本控制

URL 版本控制：通过 URL 路径指定版本，如 /v1/users。
Header 版本控制：通过请求头 Accept 指定版本，如 application/vnd.company.app-v1+json。

8. 分页和过滤

分页：通过查询参数 page 和 size 控制分页，如 /users?page=1&size=10。
过滤：通过查询参数 filter 控制过滤条件，如 /users?filter=active。

9. HATEOAS

HATEOAS（Hypermedia As The Engine Of Application State）：在响应中包含链接，指导客户端如何进行下一步操作，如：

{
  "id": 1,
  "name": "John Doe",
  "links": [
    { "rel": "self", "href": "/users/1" },
    { "rel": "orders", "href": "/users/1/orders" }
  ]
}

示例

以下是一个简单的 RESTful API 设计示例：

用户管理 API

获取所有用户：

GET /api/v1/users

[
  { "id": 1, "name": "John Doe", "email": "john@example.com" },
  { "id": 2, "name": "Jane Smith", "email": "jane@example.com" }
]

获取单个用户：

GET /api/v1/users/1

{ "id": 1, "name": "John Doe", "email": "john@example.com" }

创建用户：

POST /api/v1/users
Content-Type: application/json

{
  "name": "Alice Johnson",
  "email": "alice@example.com"
}

201 Created
Location: /api/v1/users/3

更新用户：

PUT /api/v1/users/1
Content-Type: application/json

{
  "name": "John Doe Jr.",
  "email": "johnjr@example.com"
}

200 OK

删除用户：
```
DELETE /api/v1/users/1
```
```
204 No Content
```

RESTful 风格是一种设计网络应用程序的架构风格，强调使用标准的 HTTP 方法和资源标识符来操作资源。在实际项目中，通过合理的资源命名、HTTP 方法选择、状态码使用、请求和响应格式、错误处理、认证和授权、版本控制、分页和过滤以及 HATEOAS，可以设计出高效、易用且可扩展的 RESTful API。