springboot 统一返回数据格式和异常处理

背景:为了减少在控制层重复代码的编写,如异常处理的代码块和返回数据的格式(成功返回什么数据和失败该返回什么数据)

出现异常返回的数据

image

正常返回的数据

image

统一返回数据格式

/**
 * 封装服务端响应到客户端的数据
 */
public class JsonResult {
    /**
     * 响应状态码
     */
    private Integer state=1;
    /**
     * 状态码对应的信息
     */
    private String message;
    /**
     * 响应的数据
     * 这里也可以使用泛型 private T data 在类上也加上
     */
    private Object data;

    public void setState(Integer state) {
        this.state = state;
    }

    public void setMessage(String message) {
        this.message = message;
    }

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

    }
//要么用set方法来封装数据要么用构造方法
    public JsonResult(String message) {
        this.message=message;
    }

    public JsonResult(Object data) {
        this.data = data;
    }

    public JsonResult(Throwable e) {
        this.state=0;
        this.message=e.getMessage();
    }
}

统一的异常处理全局异常捕获

用@RestControllerAdvice加@ExceptionHandler注解来实现

@ExceptionHandler也可以直接放在某个controller里面表示处理这个controller中的这个类型的异常,如果全局和某个controller里都实现同一个异常的处理会优先使用controller里面的

创建一个统一处理异常的类

//拦截全局的异常
@RestControllerAdvice
public class GlobalExceptionHandler {
    //用来处理日志的
    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    //用来处理该类型的异常
    @ExceptionHandler(ArithmeticException.class)
    public JsonResult doHandlerArithmeticException(ArithmeticException e) {
        e.printStackTrace();
        log.info("exception {}",e.getMessage());
        return new JsonResult(e);//封装异常结果
    }

}

注意:@RestControllerAdvice只能拦截controller层的异常不会拦截Interceptor的异常

优点:把异常统一处理,减少代码的重复编写,提高了可维护性

缺点:只能处理controller层的异常,对于Interceptor层的异常,spring内部的异常无能为力

使用:

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