Java开发中RESTful学习使用

一.REST和RESTful基本概念

REST(【Resource】Representational State Transfer):表现层状态转化
REST指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful

综合上面的解释，我们总结一下什么是RESTful架构：
（1）每一个URI代表一种资源；
（2）客户端和服务器之间，传递这种资源的某种表现层；
（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层（使用HTTP动词去促使服务器端资源的）状态转化"。

(1).Resource(资源)
所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。

(2).Representation(表现层)
“资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层"（Representation）。
比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。
URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的”.html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

(3).State Transfer(状态转换)
访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。
互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。
它们分别对应四种基本操作：
GET用来获取资源，
POST用来新建资源（也可以用于更新资源），
PUT用来更新资源，
DELETE用来删除资源。
用表现层去改变（服务器端）资源的状态

(4).uniform interface
任何REST服务必须提供的统一接口是其设计的基础。
包含4个方面：
uri作为统一资源标识符
客户端具有操控服务端数据的能力，通过接口
通过headers可以携带对消息的完整信息的描述
接口建立在 hypermedia 之上： http request & http reponse

二.RESTful设计

(1).资源设计------(路径)
路径又称"终点"（endpoint），表示API的具体网址。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。
例如:
https://api.example.com/v1/zoos：动物园资源
https://api.example.com/v1/animals：动物资源
https://api.example.com/v1/employees：饲养员资源

(2).动作设计

HTTP动作
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性【补丁】）。
DELETE（DELETE）：从服务器删除资源。
HEAD：获得一个资源的元数据，比如一个资源的hash值或者最后修改日期；
OPTIONS：获得客户针对一个资源能够实施的操作；

动作示例
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：删除某个指定动物园的指定动物

(3).返回结果

1.返回值类型
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

2.Content Type
①，一个API可以允许返回JSON，Xml甚至HTML等文档格式；建议使用json；
②，可以通过URL来规定获取得格式类型，比如https://api.example.com/v1/employee/1.json等；但是更建议使用Accept type这个请求头；

3.常见状态码

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted ：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - []：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - []：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - []：服务器发生错误，用户将无法判断发出的请求是否成功。

三.RESTful服务开发

(1).URL处理
@RequestMapping

1,使用RequestMapping的参数化；
@RequestMapping(value="/blog/{id}",method=RequestMethod.DELETE)
public　ModelAndView　delete(@PathVariable　Long　id,HttpServletRequest　request,HttpServletResponse　response)　{
	blogManager.removeById(id);
	return new ModelAndView(LIST_ACTION);
}

2，开发中可以使用@RequestMapping的继承
@Controller
@RequestMapping("/jobs")
public class JobController{
 
	@RequestMapping(method=RequestMethod.GET)
	public String list(){}

	@RequestMapping(value="/{id}",method=RequestMethod.GET}
	public String get(@PathVariable Long id){}

	@RequestMapping(method=RequestMethod.POST)
   public String save(Job job){}

	@RequestMapping(value="/{id}",method=RequestMethod.PUT}
	public String update(@PathVariable Long id,Job job){}

	@RequestMapping(value="/{id}",method=RequestMethod.DELETE}
	public String delete(@PathVariable Long id){}
}

@PathVariable

@RequestMapping(value="/blog/{blogId}/message/{msgId}",method=RequestMethod.DELETE)
public　ModelAndView　delete(@PathVariable("blogId") Long blogId,@PathVariable("msgId") Long msgId,HttpServletRequest request,HttpServletResponse response) {
}

(2).请求处理
在浏览器或者表单中，只支持GET和POST两种方式，所以需要额外处理一下请求方法；

Ajax

使用Ajax来发送各种请求方法的请求；
$.ajax({
	url:"/job/id",
    type:"DELETE",
	dataType:"json",
	success:function(){}
})

过滤器

可以使用过滤器对请求方法进行修改：
1，在请求中使用_method=DELETE来提交请求方法；
2，使用SpringMVC提供的org.springframework.web.filter.HiddenHttpMethodFilter转化
<!--　浏览器不支持put,delete等method,由该filter将/blog?_method=delete转换为标准的http　delete方法　-->
<filter>
	<filter-name>HiddenHttpMethodFilter</filter-name>
	<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
	<!--配置参数名称，默认是_method-->
	<init-param>
		<param-name>methodParam</param-name>
		<param-value>_httpmethod</param-value>
	</init-param>
</filter>

<filter-mapping>
	<filter-name>HiddenHttpMethodFilter</filter-name>
	<servlet-name>springmvc</servlet-name>
</filter-mapping>

四.最佳实践

(1).版本
1，项目的结构一定会随着时间和需求发生变化；
2，在提供新的版本的时候，要保证老版本的路径同样可以访问；
3，在版本更新的时候，要有明确的提示给老版本用户新版本发布的消息；
4，监控老版本路径，如果确定没人使用了，再取消；
5，如果只是增加了新的API，不需要更新版本号；
6，可以通过请求头添加版本号，也可以通过URL添加版本号，URL的方式更简单；

(2).Hypermedia API
RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

(3).根路径
1，根路径对于API的设计非常重要；
2，一般根路径会单独提供一个二级域名，
比如：https://example.org/api/v1/* 针对大型API；
或者：https://api.example.com/v1/* 如果API变化不大，或者规模较小；
3，在根路径上放置好API文档是一个最佳实践；
4，把API放在HTTPS下是一个最佳实践；

(4).数据过滤
1，让查询返回的数据有数量的限制（比如列表查询，一定需要做返回条数的限制）
2，常见的过滤设计：
?limit=10：限制只查询10条；
?offset=10：从第11条查询；
?animal_type_id=1：条件过滤；
?sortby=name&order=asc：排序；
3，在代码中为可以过滤或排序的列做好安全限制；

(5).访问授权
1，一些情况下，我们可以让API作为公开的资源访问，但是在大多数情况下，我们需要监控每一个请求是由谁发出的；
2，采用OAuth2.0来完成认证是一个最佳实践；

springboot集成Swagger.请参考下面的文章
Springboot集成Swagger2