使用SpringMVC 创建REST API

喜欢ヅ旅行 2022-07-14 06:20 127阅读 0赞

**REST 基础知识**

REST是一种面向资源，强调描述应用程序的事物和名称。REST （Representational State Transfer）

1.  表述性(Representational):REST资源实际上可以用各种形式来进行表述，包括XML、JSON、甚至HTML，最适合资源使用者的任意形式；
2.  状态(State):当使用REST的时候，我们更关注资源的状态而不是对资源采取的行为；
3.  转移(Transfer): REST涉及到转移资源数据，它以某种表述性形式从一个应用转移到另一个应用.

更简洁的讲，REST就是将资源的状态以最适合客户端或服务端的形式从服务器转移到客户端(或者反过来)。  
在REST中，资源通过URL进行识别和定位。至于RESTful URL的结构并没有严格的规则，但是URL应该能够识别资源，而不是简单的发一条命令到服务器上。

REST中会有行为，它们是通过HTTP方法定义的。具体来讲，也就是GET、POST、PUT、DELETE、PATCH以及其他的HTTP方法构成了REST中的动作。这些HTTP方法通常会匹配为如下的CRUD动作：

Create:POST  
Read:GET  
Update:PUT或PATCH  
Delete: DELETE

**Spring是如何支持REST的**

Spring支持一下方式来创建REST资源:

1.  控制器可以处理所有的HTTP方法，包含四个主要的REST方法：GET\\PUT\\DELETE\\POST\\PATCH
2.  借助@PathVariable注解，控制器能够处理参数化的URL(将变量输入作为URL的一部分)
3.  借助Spring的视图和视图解析器，资源能够以多种方式进行表述，包括将模型数据渲染为XML、JSON、Atom以及RSS的View实现
4.  可以使用ContentNegotiationgViewResolver来选择最适合客户端的表述
5.  借助@ResponseBody注解和各种HttpMethodConverter实现，能够替换基于视图的渲染方式
6.  类似地，@RequestBody注解以及HttpMethodConverter实现可以将传入的HTTP数据转化为传入控制器处理方法的Java对象。
7.  借助RestTemplate，Spring应用能够方便的使用REST资源

**创建一个REST端点**

表述是REST中很重要的一个方面，它是关于客户端和服务器端针对，某一资源是如何通信的。任何给定的资源都几乎可以用任意的形式来进行表述。如果资源的使用者愿意使用JSON，那么资源就可以用JSON格式来表述。如果使用者喜欢XML，那么相同的资源可以用XML来进行表述。

需要了解的是控制器本身通常并不关心资源如何表述。控制器以java对象的方式来处理资源。控制器完成了它的工作之后，资源才会被转化成最适合客户端的形式。

Spring提供了两种方法将资源的java表述形式转换为发送给客户端的表述形式：

1.  内容协商（Content negotiation）：选择一个视图，它能够将模型渲染为呈现给客户端的表述形式；
2.  消息转换器(Message conversion)：通过一个消息转换器将控制器所返回的对象转换为呈现给客户端的表述形式。

**使用HTTP消息转换器**

消息转换(message conversion)提供了一种更为直接的方式，它能够将控制器产生的数据转换为服务于客户端的表述形式。

**在响应体中返回资源状态**

如果使用了消息转换功能的话，**@ResponseBody**注解会告知Spring,将返回的对象作为资源发送给客户端，并将其转换为客户端可接受的表述形式。

**在请求体中接收资源状态**

如果要让控制器将客户端发送的JSON和XML转换为它所使用的Java对象，使用**@RequestBody**能够告知Spring查找某个消息转换器，将来自客户端的资源表述转换为对象。