Bootstrap

前后端分离项目中通用模板一:响应类的设计

一、背景

目前Java的项目开发一般是前后端分离开发,作为后端开发人员,主要工作就是设计接口,返回前端想要的数据,一般来说不仅仅单是对数据的返回,还需要返回一些状态信息,就是前端发一个请求过来,后端得告诉前端,对这个请求的处理结果是什么,成功?失败?所以这里还涉及到状态信息的一个封装,本篇文章写的正是解决如何更好的规范的封装响应结果这个问题。

二、简要描述

其实就是一个响应类的设计,对于一个一般的类,就是设计类的三大要素,属性、方法、构造器。对于属性的选择,其实就是看实际需求是什么,那么在这里为了让前端能够很好的对响应结果进行逻辑选择,就需要给前端一个标识,这个标识代表成功,那个标识代表失败,而这个"标识"一般就用数字来表示了,也就是状态码(code)所以code属性是不可少的,然后为了给前端提示信息,就提供一个message属性,然后对于一些查询业务,最重要的就是响应数据了(data)。

三、分析

就是如何设计类
属性:code、message、data
构造方法:无参构造、相应属性的有参构造
实例方法:ok、error(代替构造器,提高可读性,还可进行链式调用)
静态方法:工厂模式,避免直接new响应对象,直接使用
其它:对枚举状态的一个直接使用
重点:
1.懂得使用ok()、error()方法来构造响应对象,其实就相当于构造器,但是构造器的可读性不强,构造器只提供参数,不知道是成功还是失败状态,而ok/error,不仅提供了参数,还一眼知道是响应的成功还是失败,比如:

return new ResponseResult().ok(code,message,data)

并且方法返回值是this,也就可以链式调用,还可以这样:

return new ResponseResult().ok().setData(data)
当然这里set方法也要返回this
2.简单静态工厂方法的使用,这里我们避免直接new对象,而是通过工厂类直接获取响应对象,比如:
 public static ResponseResult okResult(Integer code,String message){
        ResponseResult<Object> result = new ResponseResult<>();
        return result.ok(code,message);
    }
3.直接使用枚举类的信息,对参数进行扩展,比如:
 public static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums){
        return okResult(enums.getCode(),enums.getMsg());
    }

private static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums, String msg){
        return okResult(enums.getCode(),msg);
    }
4.泛型编程-泛型类的使用
public class ResponseResult<T> implements Serializable {
    private Integer code;
    private String msg;
    private T data;
    public ResponseResult<?> ok(Integer code, T data, String msg) {
     this.code = code;
     this.data = data;
     this.msg = msg;
     return this;
 }

对响应数据使用泛型,这样获取响应数据时,就不需要强转了

四、代码

@JsonInclude(JsonInclude.Include.NON_NULL)
public class ResponseResult<T> implements Serializable {
    private Integer code;
    private String msg;
    private T data;

    public ResponseResult() {
        this.code = AppHttpCodeEnum.SUCCESS.getCode();
        this.msg = AppHttpCodeEnum.SUCCESS.getMsg();
    }

    public ResponseResult(Integer code, T data) {
        this.code = code;
        this.data = data;
    }

    public ResponseResult(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public ResponseResult(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public static ResponseResult errorResult(int code, String msg) {
        ResponseResult result = new ResponseResult();
        return result.error(code, msg);
    }
    public static ResponseResult okResult() {
        ResponseResult result = new ResponseResult();
        return result;
    }
    public static ResponseResult okResult(int code, String msg) {
        ResponseResult result = new ResponseResult();
        return result.ok(code, null, msg);
    }

    public static ResponseResult okResult(Object data) {
        ResponseResult result = setAppHttpCodeEnum(AppHttpCodeEnum.SUCCESS);
        if(data!=null) {
            result.setData(data);
        }
        return result;
    }

    public static ResponseResult errorResult(AppHttpCodeEnum enums){
        return setAppHttpCodeEnum(enums);
    }

    public static ResponseResult errorResult(AppHttpCodeEnum enums, String msg){
        return setAppHttpCodeEnum(enums,msg);
    }

    public static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums){
        return okResult(enums.getCode(),enums.getMsg());
    }

    private static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums, String msg){
        return okResult(enums.getCode(),msg);
    }

    public ResponseResult<?> error(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
        return this;
    }

    public ResponseResult<?> ok(Integer code, T data) {
        this.code = code;
        this.data = data;
        return this;
    }

    public ResponseResult<?> ok(Integer code, T data, String msg) {
        this.code = code;
        this.data = data;
        this.msg = msg;
        return this;
    }

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

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

代码逻辑:
1.先有构造器
2.再有ok/error方法,“构造对象信息”
3.编写工厂静态方法,完成对象创建
(其中对错误响应方法,编写setAppHttpCodeEnum方法)

五、总结

总结其实就是就分析那里,其实啊,这里因为是模板,其实以后只需要会cv就行。

;