Spingboot 接口的统一格式返回

前言

在后半年在学长领导下，使用 MVC 模式做了自己的第一个项目，由于对这种模式是第一次接触，写下来的代码如今看来很不如人意，尤其是最近在使用这部分后台代码给微信小程序使用的时候更是如此，后台代码的健壮性和返回值的不统一给使用带来了很大的麻烦。

注释：我在使用时，代码结构主要是 Controller、Service、Dao、Entity以及 Util，其中 Entity 为实体类，并不是定义 BO VO 等多个实体类，应该不算是严格意义的 MVC。

最近在学习一些专栏的时候，对接口的意识提升。希望写出的接口可以更加规范，避免前端调用 500 然后去修改后台代码的情况。

代码

首先定义一个 ResultCode 枚举类，在这里最好使用 getCode 方法而不是暴露 code 参数。

对于一个类而言，外部调用者并不应该获得太多的类内具体信息，一方面不符合设计原则，另一方面，这种做法并不安全。

public enum ResultCode {
    SUCCESS(200),

    FAIL(400);
    //  在本文中未使用到，所以注释掉
    // INTERNAL_SERVER_ERROR(500);

    private int code;

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

    public int getCode() {
        return code;
    }
}

接着定义一个 ResponseResult 类，作为后边 Response 类的返回形式

code 参数表述状态码
msg 参数表述具体的成功或者失败信息
data 参数用来接受成功之后的具体数据

public class ResponseResult<T> {
    public int code;

    private String msg;

    private T data;

    public ResponseResult<T> setCode(ResultCode resultCode){
        this.code = resultCode.getCode();
        return this;
    }

    public int getCode(){
        return code;
    }

    public ResponseResult<T> setCode(int code){
        this.code = code;
        return this;
    }

    public String getMsg(){
        return msg;
    }

    public ResponseResult<T> setMsg(String msg){
        this.msg = msg;
        return this;
    }

    public T getData(){
        return data;
    }

    public ResponseResult<T> setData(T data){
        this.data = data;
        return this;
    }
}

最后定义一个 Response 实体类，定义对应关系以及具体使用方法。

public class Response {
    private final static String SUCCESS = "success";
    private final static String FAIL = "fail";

    public static <T> ResponseResult<T> makeOkRsp(){
        return new ResponseResult<T>().setCode(ResultCode.SUCCESS).setMsg(SUCCESS);
    }

    public static <T> ResponseResult<T> makeOkRsp(String message){
        return new ResponseResult<T>().setCode(ResultCode.SUCCESS).setMsg(message);
    }

    public static <T> ResponseResult<T> makeOkRsp(T data){
        return new ResponseResult<T>().setCode(ResultCode.SUCCESS).setMsg(SUCCESS).setData(data);
    }

    public static <T> ResponseResult<T> makeErrorRsp(){
        return new ResponseResult<T>().setCode(ResultCode.FAIL).setMsg(FAIL);
    }

    public static <T> ResponseResult<T> makeErrorRsp(String message){
        return new ResponseResult<T>().setCode(ResultCode.FAIL).setMsg(message);
    }

    public static <T> ResponseResult<T> makeErrorRsp(T data){
        return new ResponseResult<T>().setCode(ResultCode.FAIL).setMsg(FAIL).setData(data);
    }
}

效果

在这部分，就是将前边东西应用在自己所要实现的功能中。首先是在「删除歌手」功能代码中使用。

// Controller 部分代码
@ApiOperation("删除歌手信息")
    @RequestMapping("/deleteSinger")
    @ResponseBody
    public Object deleteSingerInfo(@NotNull HttpServletRequest request){
        logger.info("正在删除歌手信息...");
        String singerName = request.getParameter("singerName");

        if(singerName == null){
            return Response.makeErrorRsp("参数缺失");
        }

        if(!singerManageService.deleteSingerInfo(singerName)){
            return Response.makeErrorRsp("要删除的歌手不存在");
        }
        return Response.makeOkRsp();
    }
   // ServiceImpl 部分代码
   // 这部分我返回了 boolean 形式，实际上可能使用 int 形式更为合适，更能够表示跟多元的情况
   @Override
    public boolean deleteSingerInfo(String singerName) {
        try{
            int singerId = singerManageMapper.getSingerIdByName(singerName);
            singerManageMapper.deleteSingerInfo(singerId);
            return true;
        }catch(Exception e){
            // e.printStackTrace();
            return false;
        }

    }

第一个测试是不带参数

第二个测试是输入一个不存在的歌手姓名

第三个是删除成功的效果
获取所有歌手信息，用来展示 data 的格式

	@RequestMapping("/getAllSinger")
    @ResponseBody
    public Object getAllSinger(@NotNull HttpServletRequest request){
        logger.info("正在获取所有歌手信息...");
        List<Singer> singerList = singerManageService.getAllSinger();
        return Response.makeOkRsp().setData(singerList);
    }

后记

具体代码的实现思路引用了Java设计RestfulApi接口，实现统一格式返回 ，我对此的贡献并不大，主要是学习这种接口写法，培养自己的代码规范。