到底什么是Restful

野性酷女 2022-08-29 06:15 322阅读 0赞

# 讲在前面 #

说实话写后端代码写了这么久，其实一直都没搞明白到底什么是Restful，总是处于迷迷糊糊的状态，总感觉自己会用但是别人也一问啥也讲不出，基于这个问题我赶紧去恶补了这一块，下面就根大家分享一下啦。[参考链接][Link 1]

# Restful起源 #

Rest（Representational State Transfer）即表述性状态改变。是基于HTTP,URI,XML,JSON等的标准和协议，支持轻量级的跨平台跨语言的是web服务的一种新的架构风格（一种思想）

# Restful架构的主要原则 #

*  对网络上的所有资源都有一个资源标识符
 *  对资源的操作不会改变标识符
 *  统一资源有多种表现形式如JSON、XML

# 基本介绍 #

Restful是一种常见的 Rest应用，是遵循REST风格的web的服务。 简单的说：RESTful是一种架构的规范与约束、原则，符合这种规范的架构就是RESTful架构。

# Restful资源的规范与约束 #

RESTful 架构的核心规范与约束：统一接口  
分为四个子约束：  
1.每个资源都拥有一个资源标识，每个资源的资源标识可以用来唯一地标明该资源  
2.消息的自描述性  
3.资源的自描述性。  
4.HATEOAS Hypermedia As The Engine Of Application State(超媒体作为应用状态引擎)  
即客户只可以通过服务端所返回各结果中所包含的信息来得到下一步操作所需要的信息，如到底是向哪个URL发送请求等。也就是说，一个典型的REST服务不需要额外的文档标示通过哪些URL访问特定类型的资源，而是通过服务端返回的响应来标示到底能在该资源上执行什么样的操作

目的：实现客户端无需借助任何文档即能调用到所有的服务器资源

# 对REST资源的基本操作 #

<table> 
 <thead> 
  <tr> 
   <th>http方法</th> 
   <th>资源操作</th> 
   <th>幂等</th> 
   <th>安全</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>GET</td> 
   <td>SELECT</td> 
   <td>是</td> 
   <td>是</td> 
  </tr> 
  <tr> 
   <td>POST</td> 
   <td>INSERT</td> 
   <td>否</td> 
   <td>否</td> 
  </tr> 
  <tr> 
   <td>PUT</td> 
   <td>UPDATE</td> 
   <td>是</td> 
   <td>否</td> 
  </tr> 
  <tr> 
   <td>DELETE</td> 
   <td>DELETE</td> 
   <td>是</td> 
   <td>否</td> 
  </tr> 
 </tbody> 
</table>

RESTFUL根据操作的资源不同，使用不同的http方法，其传输的媒介一般使用JSON

# RESTFUL设计准则 #

**宾语必须是名词**  
宾语就是API的URL,是HTTP动作的对象。她应该是名词，例如，`/books`这个URL就是正确的，而下面的URL不是名次所以都是错误的

/getAllCars
     /createNewCar
     /deleteAllRedCars

**复数URL**  
既然 URL 是名词，那么应该使用复数，还是单数？  
这没有统一的规定，但是常见的操作是读取一个集合，比如GET /books  
（读取所有书籍，这里明显应该是复数。  
为了统一起见，建议都使用复数 URL

**避免多级URL**

常见的情况是，资源需要多级分类，因此很容易写出多级的 URL，比如获取某个商品大类的某一类小商品。

GET /categories/12/products/2

这种 URL 不利于扩展，语义也不明确，往往要想一会，才能明白含义。  
更好的做法是，除了第一级，其他级别都用查询字符串表达。

正确做法

GET /authors/12?categories=2

下面是另一个例子，查询已出版的书籍。你可能会设计成下面的 URL。

GET /articles/published

查询字符串的写法明显更好。

GET /articles?published=true

# 接口示例 #

**传统URL:**

http://127.0.0.1/user/query/1 GET 根据用户id查询用户数据
    
    http://127.0.0.1/user/save POST 新增用户
    
    http://127.0.0.1/user/update POST 修改用户信息
    
    http://127.0.0.1/user/delete GET/POST 删除用户信息

Restful风格URL

http://127.0.0.1/user/{
        id} GET 根据用户id查询用户数据
    
    http://127.0.0.1/user POST 新增用户
    
    http://127.0.0.1/user PUT 修改用户信息
    
    http://127.0.0.1/user DELETE 删除用户信息  OR http://127.0.0.1/user/{
        id} DELETE 删除用户信息

对应Restful的最佳实践  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70 3]

# RESTFUL状态码 #

GET
    安全且幂等
    获取表示
    变更时获取表示（缓存）
    200（OK） - 表示已在响应中发出
    204（无内容） - 资源有空表示
    301（Moved Permanently） - 资源的URI已被更新
    303（See Other） - 其他（如，负载均衡）
    304（not modified）- 资源未更改（缓存）
    400 （bad request）- 指代坏请求（如，参数错误）
    404 （not found）- 资源不存在
    406 （not acceptable）- 服务端不支持所需表示
    500 （internal server error）- 通用错误响应
    503 （Service Unavailable）- 服务端当前无法处理请求
    
    POST
    不安全且不幂等
    使用服务端管理的（自动产生）的实例号创建资源
    创建子资源
    部分更新资源
    如果没有被修改，则不过更新资源（乐观锁）
    200（OK）- 如果现有资源已被更改
    201（created）- 如果新资源被创建
    202（accepted）- 已接受处理请求但尚未完成（异步处理）
    301（Moved Permanently）- 资源的URI被更新
    303（See Other）- 其他（如，负载均衡）
    400（bad request）- 指代坏请求
    404 （not found）- 资源不存在
    406 （not acceptable）- 服务端不支持所需表示
    409 （conflict）- 通用冲突
    412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
    415 （unsupported media type）- 接受到的表示不受支持
    500 （internal server error）- 通用错误响应
    503 （Service Unavailable）- 服务当前无法处理请求
    
    
    PUT
    不安全但幂等
    用客户端管理的实例号创建一个资源
    通过替换的方式更新资源
    如果未被修改，则更新资源（乐观锁）
    200 （OK）- 如果已存在资源被更改
    201 （created）- 如果新资源被创建
    301（Moved Permanently）- 资源的URI已更改
    303 （See Other）- 其他（如，负载均衡）
    400 （bad request）- 指代坏请求
    404 （not found）- 资源不存在
    406 （not acceptable）- 服务端不支持所需表示
    409 （conflict）- 通用冲突
    412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
    415 （unsupported media type）- 接受到的表示不受支持
    500 （internal server error）- 通用错误响应
    503 （Service Unavailable）- 服务当前无法处理请求
    
    
    DELETE
    不安全但幂等
    删除资源
    200 （OK）- 资源已被删除
    301 （Moved Permanently）- 资源的URI已更改
    303 （See Other）- 其他，如负载均衡
    400 （bad request）- 指代坏请求
    404 （not found）- 资源不存在
    409 （conflict）- 通用冲突
    500 （internal server error）- 通用错误响应
    503 （Service Unavailable）- 服务端当前无法处理请求

至此，RESTful的介绍和使用已经完成，RESTful已在各互联网公司接口定义中，成为主流的范式，RESTful减少了传统请求的拆装箱操作，结构清晰，在接口定义中受到前后端开发者的青睐。

[Link 1]: https://www.cnblogs.com/zhangruifeng/p/13257731.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70]: /images/20220829/e2c8d0a3de454138bae519c56d61a8af.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70 1]: /images/20220829/6b7b9d096b8644cbb254e2289b2bde78.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70 2]: /images/20220829/5dca7609498d45638ed4445712fb762d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NTVV9oamg_size_16_color_FFFFFF_t_70 3]: /images/20220829/df3bdfe08bb04c8bbd38308890848c69.png