【接口设计】前后端的通信方式 REST

G皮T

已于 2024-07-20 23:31:32 修改

阅读量1k

点赞数 27

分类专栏： # Spring Boot 文章标签： restful 前端后端 API REST 接口设计接口

于 2024-07-09 20:33:49 首次发布

本文链接：https://blog.csdn.net/Be_racle/article/details/140250478

版权

Spring Boot 专栏收录该内容

29 篇文章 3 订阅

订阅专栏

《接口设计》系列，共包含以下 5 篇文章：

😊 如果您觉得这篇文章有用 ✔️ 的话，请给博主一个一键三连 🚀🚀🚀 吧（点赞 🧡、关注 💛、收藏 💚）！！！您的支持 💖💖💖 将激励 🔥 博主输出更多优质内容！！！

1.初识 REST

1.1 什么是 REST

REST 是软件架构的规范体系结构，它将 资源的状态 以适合客户端的形式从服务器端发送到客户端（或相反方向）。在 REST 中，通过 URL 进行资源定位，用 HTTP 动作（GET、POST、DELETE、PUSH 等）描述操作，完成功能。

🚀 REST 即 表述性状态传递（Representational State Transfer，简称 REST）是 Roy Fielding 博士在 2000 年他的博士论文中提出来的一种 软件架构风格（Software Architecture Style）。它是一种针对网络应用的设计和开发方式，可以降低开发的复杂性，提高系统的可伸缩性。

🚀 REST 密切相关的两个名词：资源和状态。可以说，资源是 REST 系统的核心概念。所有的设计都会以资源为中心，包括如何对资源进行添加，更新，查找以及修改等。而资源本身则拥有一系列状态。在每次对资源进行添加，删除或修改的时候，资源就将从一个状态转移到另外一个状态。

遵循 RESTful 风格，可以使开发的接口通用。以便调用者理解接口的作用。基于 REST 构建的 API 就是 RESTful（REST 风格）API。

各大机构提供的 API 基本都是 RESTful 风格的，这样可以统一规范，减少沟通、学习和开发的成本。

1.2 REST 的特征

客户 — 服务器（client-server）：提供服务的服务器和使用服务的客户端需要被隔离对待。
无状态（stateless)：服务器端不存储客户的请求中的信息，客户的每一个请求必须包含服务器处理该请求所需的所有信息，所有的资源都可以通过 URI 定位，而且这个定位与其他资源无关，也不会因为其他资源的变化而变化。

Restful 是典型的基于 HTTP 的协议。HTTP 连接最显著的特点是：客户端发送的每次请求都需要服务器回送响应；在请求结束后，主动释放连接。从建立连接到关闭连接的过程称为 “一次连接”，前后的请求没有必然的联系，所以是无状态的。

可缓存（cachable）：服务器必须让客户知道请求是否可以被缓存。
分层系统（layered System）：服务器和客户之间的通信必须被标准化。
统一接口（uniform interface）：客户和服务器之间通信的方法必须统一，RESTful 风格的数据元操作 CRUD（create、read、update、delete）分别对应 HTTP 方法：GET 用来 获取资源，POST 用来 新建资源，PUT 用来 更新资源，DELETE 用来 删除资源，这样就统一了数据操作的接口。
HTTP 状态码：状态码在 REST 中都有特定的意义：200、201、202、204、400、401、403、500。比如，401 表示用户身份认证失败；403 表示验证身份通过了，但资源没有权限进行操作。
支持按需代码（Code-On-Demand，可选）：服务器可以提供一些代码或脚本，并在客户的运行环境中执行。

2.HTTP 方法与 CRUD 动作映射

RESTful 风格使用同一个 URL，通过约定不同的 HTTP 方法来实施不同的业务。

普通网页的 CRUD 和 RESTful 风格的 CRUD 的区别，见表：

动作	普通 CRUD 的 URL	普通 CRUD 的 HTTP 方法	Restful 的 URL	Restful 的 CRUD 的 HTTP 方法
查询	`Article/id=1`	GET	`Article/{id}`	GET
添加	`Article?title=xxx&body=xxx`	GET / POST	`Article`	POST
修改	`Article/update?id=xxx`	GET	`Article/{id}`	PUT 或 PATCH
删除	`Article/delete?id=xxx`	GET	`Article/{id}`	DELETE

可以看出，RESTful 风格的 CRUD 比传统的 CRUD 简单明了，它通过 HTTP 方法来区分增加、修改、删除和查询。

3.实现 REST 风格的 CRUD

在 Spring Boot 中，如果要返回 JSON 数据，则只需要在控制器中用 @RestController 注解。如果提交 HTTP 方法，则使用注解 @RequestMapping 来实现，它有以下两个属性：

Value：用来制定 URI。
Method：用来制定 HTTP 请求方法。

（1）获取列表采用的是 GET 方式，返回 List。例如，下面代码返回 Article 的 List。

@RequestMapping(value = "/", method = RequestMethod.GET)
public List<Article> getArticleList() {
　　List<Article> list = new ArrayList<Article>(articleRepository.findAll());
　　return list;
}

（2）增加内容（提交内容）采用的是 POST 方式，一般返回 String 类型或 int 类型的数据，见以下代码：

@RequestMapping(value = "/", method = RequestMethod.POST)
public String add(Article article) {
　　articleRepository.save(article);
　　return "success";
}

（3）删除内容，必须采用 DEIETE 方法。一般都是根据 id 主键进行删除的。

@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
public String delete(@PathVariable("id") long id) {
　　articleRepository.deleteByld(id);
　　return "success";
}

（4）修改内容，则用 PUT 方法。

@RequestMapping(value = "/{id}", method = RequestMethod.PUT)
public String update(Article model) {
　　articleRepository.save(model);
　　return "success";
}

（5）查询内容，和上面获取列表的方法一样，也是采用 GET 方法。

@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public Article findArticle(@PathVariable("id") Integer id) {
　　Article article = articleRepository.findByld(id);
　　return article;
}

对于 RESTful 风格的增加、删除、修改和查询，可以编写测试单元，也可以用 Postman 测试，分别用 GET、POST、PUT、DELETE 方法提交测试。虽然这样实现了 RESTful 风格，但还有一个问题 —— 返回的数据并不统一，在实际生产环境中还需要进行改进，所以需要设计统一的 RESTful 风格的数据接口。