SpringBoot从零搭建一个项目（五）定义返回格式-蒲公英云

SpringBoot从零搭建一个项目（五）定义返回格式

矫情吗；* 2023-03-06 05:02 63阅读 0赞

如果我们直接返回对象的json格式，对于客户端来说，使用体验不是很好，一般还要返回code和错误信息，所以这里我们做一次封装。
先定义返回的格式如下：

{
    data: {}
    code: 100
    msg：“正常”
}

封装返回的类：

public class JsonResult {
    public static String CODE_SUCCESS = "100";
    public static String CODE_FAIL = "101";
    private Object data;
    private String code;
    private String msg;
    public JsonResult(Object data, String code, String msg) {
        this.data = data;
        this.code = code;
        this.msg = msg;
    }
    /**
     * 成功
     * @param data
     * @return
     */
    public static JsonResult buildData(Object data) {
        return new JsonResult(data, CODE_SUCCESS, "");
    }
    /**
     * 失败
     * @return
     */
    public static JsonResult buildFail() {
        return new JsonResult("", CODE_FAIL, "异常");
    }
}

定义一个控制层基础类，方便在控制层中直接返回格式

public class BaseController {
    /**
     * 成功-带参数
     * @param t
     * @return
     */
    public String success(Object t) {
        JsonResult jsonResult = JsonResult.buildData(t);
        String resultString = JSONObject.fromObject(jsonResult).toString();
        return resultString;
    }
    /**
     * 失败-通用
     * @return
     */
    public String fail() {
        JsonResult jsonResult = JsonResult.buildFail();
        String resultString = JSONObject.fromObject(jsonResult).toString();
        return resultString;
    }
}

在控制层中使用：

@RestController
@RequestMapping("/user")
public class UserController extends BaseController {
    @RequestMapping("/login")
    public String registerAndLogin(
            @RequestParam("code") String code,
            @RequestParam("nickName") String nickName,
            @RequestParam("avatarUrl") String avatarUrl) {
         // .......
        return success(user);
    }
}

返回的结果：

{
    code: "100"
    data: {avatarUrl: "https://wx.qlogo.cn/mmopen/vi_32/DYAIOgq83eo4kicic…MvuIu6doOsvxelA87fzvuAL5rnx3JwCDRXice2HtnzUwQ/132", createDate: "2020-08-04 16:10:40.0", nickName: "WongWoo", openid: "oW_rF5DQwwRl7Ek2ApqrXJryYVMM", unionid: "", …}
    msg: ""
}