Spring 全局异常处理与定制ResponseBody

1.介绍ExceptionHandler与ControllerAdvice

@ExceptionHandler
注解到方法上,出现异常时会执行该方法。
@ControllerAdvice
使一个Contoller成为全局的异常处理类,类中用@ExceptionHandler方法注解的方法可以处理所有Controller发生的异常。

1.处理局部异常(Controller内)

    @ExceptionHandler
    public ModelAndView exceptionHandler(Exception ex){
        ModelAndView mv = new ModelAndView("error");
        mv.addObject("exception", ex);
        return mv;
    }

2.处理全局异常(所有Controller)

@ControllerAdvice
public class testControllerAdvice {
    @ExceptionHandler
    public ModelAndView exceptionHandler(Exception ex){
        ModelAndView mv = new ModelAndView("error");
        mv.addObject("exception", ex);
        return mv;
    }
}

2.定义统一的返回体

现在基本都是前后端分离,后端只需要提供json接口。需要定制个通用返回体。

{
        "msg": "操作成功",
        "success": true,
        "result":{
          },
        "code": 1
}

真正需要返回的数据在result里面。普通Controller返回的内容会被放在result里面。这样业务中不需要去考虑response,只需要返回数据,和抛出异常就行了。

@ControllerAdvice(basePackages = "com.xiong")
public class ResultResponseBodyAdvice implements ResponseBodyAdvice<Object>{

    private final static int successCode=1;//成功编码
    private final static int errorCode=0;//验证错误 (定义一个验证异常,验证失败抛异常,比如参数错误,主要验证前端参数)
    private final static int sysErrorCode=-1;//系统错误
    private final static String DefaultMsg="网络不给力,请稍后再试";


    @Override
    /**
     * 过滤是否是json的数据
     */

    public boolean supports(MethodParameter methodParameter, Class aClass) {

        Boolean isRest = AnnotationUtils.isAnnotationDeclaredLocally(
                RestController.class, methodParameter.getContainingClass());
        ResponseBody responseBody = AnnotationUtils.findAnnotation(
                methodParameter.getMethod(), ResponseBody.class); //得到方法上的注解
        if (isRest || responseBody != null) {
            return true;
        } else {
            return false;
        }

    }

    /**
     * 修改返回的数据
     */
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        if (o instanceof Result) {
            return o;
        }
        Result result = Result.getInstance();
        o = o==null?"":o;
        result.setResult(o);
        return result;

    }



    /**
     * 全局异常的处理
     * @param request
     * @param ex
     * @return
     */
    @ExceptionHandler(value = {Exception.class})
    @ResponseBody
    public Result handleAllException(HttpServletRequest request, Exception ex) {

        ex.printStackTrace();
        String msg = DefaultMsg;
        Integer code = errorCode;
        if (ex instanceof ValidationException) {
            ValidationException validationException = (ValidationException)ex;
            if (validationException.getCode() != null) {
                code = validationException.getCode();
            }
            if (!StringUtils.isNullOrEmpty(validationException.getMessage())) {
                msg = validationException.getMessage();
            }
        }
        Result response = new Result();
        response.setSuccess(false);
        response.setResult("");
        response.setCode(code);
        response.setMsg(msg);
        return response;

    }


    public static class Result {
        private String msg;
        private Boolean success;
        private Object result;
        private Integer code;

        public String getMsg() {
            return msg;
        }

        public Boolean getSuccess() {
            return success;
        }

        public Object getResult() {
            return result;
        }

        public Integer getCode() {
            return code;
        }

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

        public void setSuccess(Boolean success) {
            this.success = success;
        }

        public void setResult(Object result) {
            this.result = result;
        }

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

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

推荐阅读更多精彩内容