RESTful风格以及统一响应结果

常用的两个开发规范: RESTful风格 和 统一响应结果

1, REST风格

在前后端分离的开发模式中，前后端开发人员都需要根据提前定义好的接口文档，来进行前后端功能的开发。后端开发人员必须严格遵守提供的接口文档进行后端功能开发（保障开发的功能可以和前端对接）

而在前后端进行交互的时候，我们需要基于当前主流的REST风格的API接口进行交互。

什么是REST风格呢?

• REST（Representational State Transfer），表述性状态转换，它是一种软件架构风格。

传统URL风格如下：

http://localhost:8080/user/getById?id=1     GET：查询id为1的用户
http://localhost:8080/user/saveUser         POST：新增用户
http://localhost:8080/user/updateUser       POST：修改用户
http://localhost:8080/user/deleteUser?id=1  GET：删除id为1的用户

我们看到，原始的传统URL呢，定义比较复杂，而且将资源的访问行为对外暴露出来了。

基于REST风格URL如下：

http://localhost:8080/users/1  GET：查询id为1的用户
http://localhost:8080/users    POST：新增用户
http://localhost:8080/users    PUT：修改用户
http://localhost:8080/users/1  DELETE：删除id为1的用户

其中总结起来，就一句话：通过URL定位要操作的资源，通过HTTP动词(请求方式)来描述具体的操作。

在REST风格的URL中，通过四种请求方式，来操作数据的增删改查。 可以理解为这几种请求只接受对应的请求方式

• GET ： 查询
• POST ：新增
• PUT ：修改
• DELETE ：删除

我们看到如果是基于REST风格，定义URL，URL将会更加简洁、更加规范、更加优雅。

注意事项：

• REST是风格，是约定方式，约定不是规定，可以打破
• 描述模块的功能通常使用复数，也就是加s的格式来描述，表示此类资源，而非单个资源。如：users、emps、books…

2, 统一响应结果

对于之前我们响应的结果可以是String,可以是无返回值,可以是ModelAndview可以是自定义对象.

这种方式虽然可以通过不同的场景返回不同的类型,但是对于前端开发来说不是很友好, 更需要依赖接口文档来判断返回值类型. 也因为有这样的弊端,后来就统一了返回结果,都为自定的对象Result返回,这样对于前端来说十分的方便.

返回实体类对象如下:

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {
    private Integer code;//响应码，1 代表成功; 0 代表失败
    private String msg;  //响应信息 描述字符串
    private Object data; //返回的数据

    //增删改 成功响应
    public static Result success(){
        return new Result(1,"success",null);
    }
    //查询 成功响应
    public static Result success(Object data){
        return new Result(1,"success",data);
    }
    //失败响应
    public static Result error(String msg){
        return new Result(0,msg,null);
    }
}

使用上面的两个规范我们在开发的时候就可以这样来处理web层, 如下:

修改

    /**
     * 用于修改部门数据
     *
     * @return 
     */
    @PutMapping(("/depts"))
    public Result updateDeptById(@RequestBody Dept dept) {
        Integer integer = deptService.updateDeptById(dept);
        if (integer > 0) {
            return Result.success();
        }
        return Result.error("更新失败");
    }

查询:

    /**
     * 查询所有的部门信息
     *
     * @return
     */
    @GetMapping("/depts")
    public Result queryAllDept() {
        return Result.success(deptService.selectAllDept());
    }

删除:

    @DeleteMapping("/depts/{id}")
    public Result deleteDeptById(@PathVariable Integer id) {
        Integer integer = deptService.deleteDeptById(id);
        if (integer > 0) {
            return Result.success();
        }
        return Result.error("删除失败");
    }

添加:

    @PostMapping("/depts")
    public Result insertDpet(@RequestBody Dept dept) {
        Integer integer = deptService.insertDept(dept);
        if (integer > 0) {
            return Result.success();
        }
        return Result.error("添加失败");
    }

当请求路径中有同样的参数的时候可以提到类上使用原始的@RequestMapping注解

@RestController
@Slf4j
@RequestMapping("/depts")
public class DeptController { 
	...
}

简化后的方法请求路径注解如下:

添加->    @GetMapping
删除->    @DeleteMapping("/{id}")
新增->    @PostMapping
修改->    @PutMapping

---

附加一些知识，当统一了响应后，如果程序中出现了异常那么该怎么解决。因为一般不处理那么返回的就是系统中默认的信息如下：

{
	"timestamp":"2023-04-02T14:52:24.536+00:00",
	"status":500,
	"error":"Internal Server Error",
	"path":"/depts"
}

这显然不是我们想要的Result结果，所以我们就需要对全局的异常一同的来做一个处理。方法如下：

第一步：定义一个用于处理异常的处理类
第二步：在类上添加@RestControllerAdvice注解
第三步：定义处理异常的方法
第四步：在方法上通过@ExceptionHandler注解指定处理的异常
示例如下：

@RestControllerAdvice
@Slf4j
public class GlobalException {

    @ExceptionHandler(DataAccessException.class)
    public Result sqlException(DataAccessException e){
        log.info(e.getMessage());
//        说明这个时候系统中存在sql异常
        return Result.error("数据异常");
    }

    @ExceptionHandler(Exception.class)
    public Result othersException(){
        return Result.error("服务器异常,请联系管理员");
    }
}

这样就做到了程序中即使有异常，也做到了统一响应结果的目的，前端就可以通过返回值来进行对应的处理。