SpringBoot:Web项目中如何优雅的同时处理Json和Html请求的异常

在一个web项目开发中,通常都会涉及到Html和Json请求。当出现异常的时候,我们需要根据请求类型返回不同的信息。如果是Json请求,那么就返回String或者ReponseEntity类型;如果是html请求,就要返回ModelAndView的错误页面。

我们当然可以对Controller的每个接口方法抛出的异常单独处理。但这样做会导致大量的重复工作。Spring MVC为我们提供了@ControllerAdvice和@ExceptionHandler`两个注解来实现全局的异常处理。关于这两个注解的用法可以参考这里

这解决了大部分的问题,但是如果同一个Controller中既有html又有json接口方法怎么办呢?我们当然可以拆分成两个Controller,一个包含html接口,另一个包含json接口。但是这样做不够灵活,而且我更习惯根据业务逻辑来归类接口。有没有更好的方法呢?

其实在写异常处理方法时,我们可以将请求信息作为参数传入,并根据请求类型来返回不同的数据。

public class BaseController{
    private Boolean isJson(HttpServletRequest request){
        String header = request.getHeader("content-type");
        return header != null && header.contains("json");
    }

    @Override
    @ExceptionHandler(BaseException.class)
    public Object handleBaseException(HttpServletRequest request, baseException e) {
        if(isJson(request)) {
            return ResponseUtils.restResponse(
                    e.getCode(),
                    e.getMessage(),
                    e.getStatus()
            );
        } else {
            ModelAndView modelAndView = initModelAndView();
            if (e.getCode().equalsIgnoreCase("login_first")) {
                modelAndView.setViewName("redirect:/list");
            }
            if (e.getCode().equalsIgnoreCase("real_name_not_set")) {
                modelAndView.setViewName("redirect:/account");
            }else{
                modelAndView.setViewName("/404");
            }
            modelAndView.addObject("exception", e);
            return modelAndView;
        }
    }
}

这里我们写了一个BaseController,并在Controller中实现了异常捕获的逻辑。isJson()通过判断请求的Content-Type是否包含json字符串来判断该请求类型。当然,更好更合适的方式是通过包头中的Accept中的信息类判断。需要注意的是handleBaseException()方法返回了Object类型,这样我们就可以根据需要返回不同类型的数据了。以后只要Contrller继承BaseController就不用再考虑异常的问题了。

但是,如果异常是在进入接口方法之前被抛出的呢。比如404,406错误,根本不会执行接口方法,因此也无法被ExceptionHandler捕获。这部分异常如何处理呢?

Spring Boot提供了一个统一的/error地址用于所有未被捕获的异常抛出。默认设置下显示的是一个whitelabel error page

通过实现ErrorController,我们可以定制这个错误页面。

@Controller
public class MpErrorController extends BaseController implements ErrorController {
    private static final String PATH = "/error";

    @RequestMapping(value = PATH)
    public Object error() throws Exception {
        throw new BaseException();
    }

    @Override
    public String getErrorPath() {
        return PATH;
    }
}

我们希望这个error页面也根据请求的类型做出不同的逻辑处理。因此,可以直接在error()抛出BaseException异常,并且让这个Controller继承于BaseController。这样,被抛出的异常也会被handleBaseException()捕获了。

至此,我们比较优雅的实现了全局的异常处理。所有的BaseException异常处理逻辑都集中在handleBaseException()方法中。

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

推荐阅读更多精彩内容

  • PS: 本文讲得比较细,所以篇幅较长。 阅读时间:30m~1h。请认真读完,希望你一小时后能对统一异常处理有一个清...
    sprainkle阅读 19,278评论 21 157
  • 前端一直是距离用户最近的一层,随着产品的日益完善,我们会更加注重用户体验,而前端异常却如鲠在喉,甚是烦人。 一、为...
    勿忘巛心安阅读 456评论 0 0
  • 在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的。因此,肯定需要在...
    Java大生阅读 527评论 0 0
  • 最近不太平,流感病毒来不停。每天带着口罩上班,预防感染和被感染。 我是一个超弱体质的人,感冒是家常便饭,加上过敏性...
    明天阳光阅读 382评论 0 3
  • 下班回家,见孩子脸色难看,刚一问眼泪就扑簌的往下掉。甭说,又闹小情绪啦! 赶忙坐下来问了问情况,原来还是昨天那件事...
    禅猫痴语阅读 196评论 0 0