RESTful风格(千峰逆战)

一、说明

REST表示 Representational State Transfer（表示性状态转换）. 它是可以用来设计web services的框架，可以被不同的客户端调用。 REST是一种架构风格，其核心是面向资源，REST专门针对网络应用设计和开发方式，以降低开发的复杂性，提高系统的可伸缩性。

二、REST提出设计概念和准则

1.网络上的所有事物都可以被抽象为资源(resource) 2.每一个资源都有唯一的资源标识(resource identifier)，对资源的操作不会改变这些标识 3.所有的操作都是无状态的 使用简单的HTTP协议来实现调用，而不是CORBA, RPC 或者 SOAP等负责的机制。

三、RESTful API 设计指南

1、概述

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。 因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。 1.协议 API与用户的通信协议，总是使用HTTPs协议。 2.域名 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。 https://example.org/api/ 3.版本（Versioning） 应该将API的版本号放入URL。 https://api.example.com/v1/ 另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。 4.路径（Endpoint） 路径又称"终点"（endpoint），表示API的具体网址。 在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词， 而且所用的名词往往与数据库的表格名对应。 一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。 5.HTTP动词 对于资源的具体操作类型，由HTTP动词表示。 常用的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：删除某个指定动物园的指定动物 6.过滤信息（Filtering） 如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。 常见的参数 ?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的开始位置。 ?page=2&per_page=100：指定第几页，以及每页的记录数。 ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。 ?animal_type_id=1：指定筛选条件 参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。 比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。 7.状态码（Status Codes） 服务器向用户返回的状态码和提示信息 常见的状态码 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。 8.错误处理（Error handling） 如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。 eg: { error: "Invalid API key" } 9.返回结果 针对不同操作，服务器向用户返回的结果应该符合以下规范。 GET /collection：返回资源对象的列表（数组） GET /collection/resource：返回单个资源对象 POST /collection：返回新生成的资源对象 PUT /collection/resource：返回完整的资源对象 PATCH /collection/resource：返回完整的资源对象 DELETE /collection/resource：返回一个空文档 10.Hypermedia API RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。 11.其他 （1）API的身份认证应该使用OAuth 2.0框架。 （2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

2、返回数据类型

尽管没有限制必须返回的类型，但是一般基于Web services的Rest返回JSON或者XML作为响应。 客户端可以指定（使用HTTP Accept header）他们想要的资源类型吗，服务器返回需要的资源。 指明资源的Content-Type。

3、REST API

GET 方式请求 /api/user/ 返回用户列表 GET 方式请求 /api/user/1返回id为1的用户 POST 方式请求 /api/user/ 通过user对象的JSON 参数创建新的user对象 PUT 方式请求 /api/user/3 更新id为3的发送json格式的用户对象 DELETE 方式请求/api/user/4删除 ID为 4的user对象 DELETE 方式请求/api/user/删除所有user

4、Spring4 Rest 注解

@RestController 此注解避免了每个方法都要加上@ResponseBody注解。也就是说@RestController 自己戴上了 @ResponseBody注解,看以看作是 @Controller 和 @ResponseBody的结合体。 @RestController,表明该类的每个方法返回对象而不是视图。 它实际就是@Controller和@ResponseBody混合使用的简写方法。 @RequestBody 如果方法参数被 @RequestBody注解，Spring将绑定HTTP请求体到那个参数上。 如果那样做，Spring将根据请求中的ACCEPT或者 Content-Type header（私下）使用 HTTP Message converters 来将http请求体转化为domain对象。 @ResponseBody 如果方法加上了@ResponseBody注解，Spring返回值到响应体。如果这样做的话，Spring将根据请求中的 Content-Type header（私下）使用 HTTP Message converters 来将domain对象转换为响应体。 @ResponseBody的作用是将返回的对象放入响应消息体中 ResponseEntity 是一个真实数据.它代表了整个 HTTP 响应（response）. 它的好处是你可以控制任何对象放到它内部。 可以指定状态码、头信息和响应体。它包含你想要构建HTTP Response 的信息。 @PathVariable 此注解意味着一个方法参数应该绑定到一个url模板变量[在'{}'里的一个]中 MediaType 带着 @RequestMapping 注解,通过特殊的控制器方法你可以额外指定,MediaType来生产或者消耗。

5、REST测试

POSTMAN测试 使用RestTemplate编写测试用例 HTTP GET : getForObject, getForEntity HTTP PUT : put(String url, Object request, String…urlVariables) HTTP DELETE : delete HTTP POST : postForLocation(String url, Object request, String… urlVariables), postForObject(String url, Object request, ClassresponseType, String… uriVariables) HTTP HEAD : headForHeaders(String url, String… urlVariables) HTTP OPTIONS : optionsForAllow(String url, String… urlVariables) HTTP PATCH and others : exchange execute

6、others

REST的优势 由于REST强制所有的操作都必须是stateless的，这就没有上下文的约束，如果做分布式，集群都不需要考虑上下文和会话保持的问题。极大的提高系统的可伸缩性 Webservice选择 SOAP偏向于面向活动，有严格的规范和标准，包括安全，事务等各个方面的内容， 同时SOAP强调操作方法和操作对象的分离，有WSDL文件规范和XSD文件分别对其定义。 REST强调面向资源 只要我们要操作的对象可以抽象为资源即可以使用REST架构风格。 REST ful 应用问题 是否使用REST就需要考虑资源本身的抽象和识别是否困难，如果本身就是简单的类似增删改查的业务操作，那么抽象资源就比较容易，而对于复杂的业务活动抽象资源并不是一个简单的事情。比如校验用户等级，转账，事务处理等，这些往往并不容易简单的抽象为资源。 其次如果有严格的规范和标准定义要求，而且前期规范标准需要指导多个业务系统集成和开发的时候，SOAP风格由于有清晰的规范标准定义是明显有优势的。我们可以在开始和实现之前就严格定义相关的接口方法和接口传输数据。

四、示例

package com.qianfeng.controller;

import com.qianfeng.bean.User;
import com.qianfeng.service.IUserSevice;
import com.qianfeng.service.impl.UserServiceImpl;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
public class UserController {
    private IUserSevice userSevice = new UserServiceImpl();
    @GetMapping("/users")
    public List getAllUsers(){
        return userSevice.getAllUsers();
    }
    @GetMapping("/users/{uid}")
    public User getUserById(@PathVariable int uid){
        return userSevice.getUserById(uid);
    }

    @DeleteMapping("/users/{uid}")
    public boolean deleteUserById(@PathVariable int uid){
        return userSevice.deleteUser(uid);
    }

    @PostMapping("/users")
    public boolean addUser(User user){
        return userSevice.addUser(user);
    }

    @PutMapping("/users")
    public boolean updateUserById(User user){
        return userSevice.updateUser(user);
    }
}