SpringMVC返回结果的封装

我们在写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(漫无边际的优化)简直想吐,前两天买了一堆配件组了台主机,然而打游戏也打不动了!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,743评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,296评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,285评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,485评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,581评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,821评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,960评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,719评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,186评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,516评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,650评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,329评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,936评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,757评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,991评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,370评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,527评论 2 349

推荐阅读更多精彩内容

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