RESTful设计原则

最新推荐文章于 2024-04-07 08:49:00 发布

小A加小B

最新推荐文章于 2024-04-07 08:49:00 发布

阅读量498

点赞数

分类专栏： SSM框架文章标签： Spring MVC Url设计

本文链接：https://blog.csdn.net/qq_43673111/article/details/94554323

版权

SSM框架专栏收录该内容

5 篇文章 0 订阅

订阅专栏

RESTful概述

一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制
关键：不是新技术，是一种风格
核心思想
- RESTful架构中，每个网址代表一种资源(resource)

RESTful构成

API与用户的通信协议，最好使用Https协议（安全）
上线后，应该尽量将API部署在专用域名下
应该将API版本号放入URL或者Http请求头中，但前者较直观
路径即具体的API网址，在RESTful架构中，每个网址都表示资源，因此网址中不能有动词，只能有名词，而且都是名词的复数形式
动词
- 对于资源的具体操作类型，由Http动词表示
- 常用的五个动词
  - GET（SELECT）：从服务器取出资源（一项或多项）。
  - POST（CREATE）：在服务器新建一个资源
  - PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）
  - PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）
  - DELETE（DELETE）：从服务器删除资源

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的更新部分的信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

过滤信息
- 如果记录数很多，服务器按要求返回，API可以提供过滤参数
- 过滤参数可以是分页参数，排序参数，特定的筛选条件

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

状态码
- 服务器向用户返回的状态码和提示信息
- 状态码完整列表：https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可
返回结果
- 当GET, PUT和PATCH请求成功时，要返回对应的数据，及状态码200，即SUCCESS
- 当POST创建数据成功时，要返回创建的数据，及状态码201，即CREATED
- 当DELETE删除数据成功时，不返回数据，状态码要返回204，即NO CONTENT（没有body部分数据）
- 当GET 不到数据时，状态码要返回404，即NOT FOUND
- 任何时候，如果请求有问题，如校验请求数据时发现错误，要返回状态码 400，即BAD REQUEST
- 当API 请求需要用户认证时，如果request中的认证信息不正确，要返回状态码 401，即NOT AUTHORIZED
- 当API 请求需要验证用户权限时，如果当前用户无相应权限，要返回状态码 403，即FORBIDDEN

HiddenHttpMethodFilter过滤器

由于doFilterInternal方法只对method为post的表单进行过滤，所以在页面中必须如下设置

<form action="..." method="post">
        <input type="hidden" name="_method" value="put" />
        ......
</form>

在xml中配置过滤器

<filter>
      <filter-name>hiddenHttpMethodFilter</filter-name>
      <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
       <filter-name>hiddenHttpMethodFilter</filter-name>
       <url-pattern>/*</url-pattern>
</filter-mapping>