SpringMVC返回结果的封装

字数 478阅读 1234

我们在写Restful Api时,经常需要返回这种结构的数据:

{
  "code": 0,
  "data": {},
  "msg": "",
  "error": ""
}

​ 其中code方便我们判断操作是否成功,复杂一点可以作为操作码,封装错误类型,比如401为登录过期,当然这不是本文的重点,不做过多描述。data为我们实际需要的数据,msg和error都是附带的信息,其实可以只要一个,这里完全看个人喜好,我是把错误信息都放到error里面,操作成功需要附带信息的话,放到msg里面。

​ 需要说明的是,SpringMVC里面ResponseEntity已经实现了这个功能,而且还更加强大,比可以设置header之类的。而大部分情况我们只需要这一简单功能,所以我封装了一个工具类,并且在前两个项目中都用得比较满意。先贴上主要代码:

/**
 * Created by wolf on 2017/9/16.
 */
public class  Res<T> {

    private int code = 0;
    private T data;
    private String msg = "";
    private String error = "";

    public static Res ok = new Res();
    public static Res fail = new Res().code(-1);

    public static Res build() {
        return new Res();
    }

    public static <T> Res build(T data){
        return new Res().data(data);
    }

    public Res code(int code) {
        this.code = code;
        return this;
    }

    public Res data(T data) {
        this.data = data;
        return this;
    }

    public Res msg(String msg) {
        this.msg = msg;
        return this;
    }

    public Res error(String error) {
        this.error = error;
        return this;
    }
    //省略getter
}

​ data为泛型,可以是各种你想要的类型。然后对于setter,直接返回this来实现链式调用。提供两个build方法,这里作用并不大,仅仅是不想去写new。在开发过程中,其实我们大部分情况下只需要知道操作是否成功,所以这里就单独定义了两个静态实例,ok的code为0,表示操作成功,fail为操作失败。这段代码比较基础,也没啥好说的。下面再简单的列几个使用的代码吧。

@RestController
@RequestMapping("/xxx")
public class XxxController{
    
    @GetMapping
    public Res<Xxx> getXxx(){
        Xxx xxx = new Xxx();
        return Res.build(xxx);
        // return Res.ok.data(xxx).msg("获取成功");
        // return Res.fail.error("获取失败!");
        // return Res.fail.code(401).error("登录过期!");
    }
}

​ 然后,没有然后了,就是这么简单。最近太无聊,改bug(漫无边际的优化)简直想吐,前两天买了一堆配件组了台主机,然而打游戏也打不动了!

推荐阅读更多精彩内容

  • error code(错误代码)=0是操作成功完成。error code(错误代码)=1是功能错误。error c...
  • error code(错误代码)=2000是无效的像素格式。error code(错误代码)=2001是指定的驱动...
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
  • 海报清新脱俗,两个女孩笑得那样甜。但其实看过电影才知道她们经历过了什么? 《鬼乡》是根据日本军慰安妇受害者姜日出老...