RESTful

---

---

1 认识RESTful

1.1 REST的概念

REST（Representational State Transfer）是软件架构的规范体系结构，他将资源的状态以合适客户端的形式从服务端发送到客户端（或相反方向）。在REST中，通过URL进行资源定位，用HTTP动作（GET、POST、DELETE、PUT等）描述操作，完成功能。

1.2 REST的特征

• 客户-服务器（client-server）：提供服务的服务器和使用服务的客户端需要被分开对待
• 无状态（stateless）：服务器端不存储客户端的请求中的信息，客户的每一个请求必须包含服务器处理该请求所需的所有信息。所有的资源都可以通过URI定位
• 可缓存（cachable）：服务器必须让客户知道请求是否可以被缓存
• 分层系统（layered System）：客户和服务器之间的通信必须被标准化
• 统一接口（uniform interface）：客户和服务器之间通信的方法必须统一
  • RESTful风格的数据元操作CRUD（create、read、update、delete）
  • HTTP的方法（POST、GET、PUT、DELETE）
• HTTP状态码

2 认识HTTP方法与CRUD动作映射

RESTful风格使用同一个URL，通过约定不同的HTTP方法来实施不同的业务。

动作	RESTful的URL	HTTP方法
查询	Article/{id}	GET
添加	Article	POST
修改	Article	PUT或PATCH
删除	Article/{id}	DELETE

3 实现RESTful风格的数据增加、删除、修改和查询

在SpringBoot中，要返回JSON数据，则只需在控制器中用@RestController注解。
为了不重复编码，可在类上使用@RequestMapping("")指定上一级URI。

（1）获取列表采用GET方式，返回List。

@GetMapping("/list")
public Result getArticleList() {
	List<Article> list = new ArrayList<Article>(articleRepository.findAll());
	return ResultFactory.buildSuccessResult(list);
}

（2）添加文章，采用post方式

@PostMapping("/")
public Result add(Article article) {
	articleRepository.save(article);
	return ResultFactory.buildSuccessResult("添加成功");
}

（3）删除文章，采用delete方式

@DeleteMapping("/{id}")
public Result delete(@PathVariable("id") long id) {
	articleRepository.deleteById(id);
	return ResultFactory.buildSuccessResult("删除成功");
}

（4）修改文章，采用put方式

@PutMapping("/")
public Result update(Article article) {
	articleRepository.save(article);
	return ResultFactory.buildSuccessResult("修改成功");
}

（5）查询文章，采用Get方式

@GetMapping("/{id}")
public Result findArticle(@PathVariable("id") long id) {
	Article article = articleRepository.findById(id);
	if (article != null) {
		return ResultFactory.buildSuccessResult(article);
	} else {
		return ResultFactory.buildFailResult("查找失败");
	}
}

4 HTTP的返回状态

• 200：成功
• 400：错误请求
• 404：没找到资源
• 403：禁止
• 406：不能使用请求内容特性来响应请求资源。比如请求的是HTML文件，但是消费者的HTTP头包含了JSON要求。
• 500：服务器内部错误

5 设计统一的数据格式

1. 结果封装类

@Data
public class Result {

    //  响应码
    private int code;
    // 响应信息
    private String message;
    // 响应数据
    private Object result;

    public Result(int code, String message, Object data) {
        this.code = code;
        this.message = message;
        this.result = data;
    }
}

2. 状态码枚举类

public enum ResultCode {
    SUCCESS(200),
    FAIL(400),
    UNAUTHORIZED(401),
    NOT_FOUND(404),
    INTERNAL_SERVER_ERROR(500);

    public int code;

    ResultCode(int code) {
        this.code = code;
    }
}

3. 封装结果

public class ResultFactory {

    public static Result buildSuccessResult(Object data) {
        return buildResult(ResultCode.SUCCESS, "成功", data);
    }

    public static  Result buildFailResult(String message) {
        return buildResult(ResultCode.FAIL, message, null);
    }

    public static  Result buildResult(ResultCode resultCode, String message, Object data) {
        return buildResult(resultCode.code, message, data);
    }

    private static Result buildResult(int resultCode, String message, Object data) {
        return new Result(resultCode, message, data);
    }
}