RESTFUL接口风格

2018-08-01

RESTFUL(Representational state transfer)

对统一资源定位符(URL)的表现层状态转移

1.资源

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

2.表现层

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

3.状态转化

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

RESTFull优点

轻量，直接基于http，不在需要任何别的诸如消息协议。get/post/put/delete为CRUD操作
面向资源，一目了然，具有自解释性。
数据描述简单，一般以xml，json做数据交换。

注意

1.URL不能包含动词，要用名词表示资源所在位置

2.请求方法由4个方法来请求

3.请求路径尽量是用数据库表名定义

HTTP标准方法

方法	安全性	幂等性	用途
get	√	√	从服务器取出资源（一项或多项）
post	×	×	在服务器新建一个资源
put	×	√	在服务器更新资源（客户端提供改变后的完整资源）
delete	×	√	从服务器删除资源

URL用到的标识符

标识符	说明	例子
-或_	用来分隔单词	http://xyz.com/goods-center http://xyz.com/goods_center
/	资源的层级关系
?	过滤资源请求	http://xyz.com/goods-center/goods?pageNo=1&pageSize=10
,或;	表示同级资源关系	http://xyz.com/goods-center/goods/11,22,33

实际例子


@RequestMapping(value = "/property/manage")
public class PropertyController {
    //1.插入
    @PostMapping
    public CommonVO insertProperty(@RequestBody PropertyBO property)
    
    //2.删除
    @DeleteMapping("/{id}")
    public CommonVO deleteProperty(@PathVariable(value = "id", required = true) String id)
    
    //5.列表  必须在getMapping{id}前面否则被拦截
    @GetMapping   
    public CommonVO listProperty(@RequestParam(value = "name", required = false) String name,
        		@RequestParam(value = "pageNo", required = false) Integer pageNo,
        		@RequestParam(value = "pageSize", required = false) Integer pageSize)
    
    //3.详情
    @GetMapping("/{id}")
    public CommonVO getProperty(@PathVariable(value = "id", required = true) String id)
    
    //4.修改
    @PutMapping("/{id}")
    public CommonVO updateProperty(@PathVariable(value = "id", required = true) String id
                     ,@RequestBody PropertyBO property)
    
    
}