SpringBoot @ControllerAdvice 拦截异常并统一处理

2023-07-16 16:38:03 165

在spring3.2中，新增了@ControllerAdvice注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。参考：@ControllerAdvice文档

一、介绍

创建MyControllerAdvice，并添加@ControllerAdvice注解。

packagecom.sam.demo.controller;

importorg.springframework.ui.Model;
importorg.springframework.web.bind.WebDataBinder;
importorg.springframework.web.bind.annotation.*;
importjava.util.HashMap;
importjava.util.Map;

/**
*controller增强器
*@authorsam
*@since2017/7/17
*/
@ControllerAdvice
publicclassMyControllerAdvice{

/**
*应用到所有@RequestMapping注解方法，在其执行之前初始化数据绑定器
*@parambinder
*/
@InitBinder
publicvoidinitBinder(WebDataBinderbinder){}

/**
*把值绑定到Model中，使全局@RequestMapping可以获取到该值
*@parammodel
*/
@ModelAttribute
publicvoidaddAttributes(Modelmodel){
model.addAttribute("author","MagicalSam");
}

/**
*全局异常捕捉处理
*@paramex
*@return
*/
@ResponseBody
@ExceptionHandler(value=Exception.class)
publicMaperrorHandler(Exceptionex){
Mapmap=newHashMap();
map.put("code",100);
map.put("msg",ex.getMessage());
returnmap;
}

}

启动应用后，被@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法，都会作用在被@RequestMapping注解的方法上。

@ModelAttribute：在Model上设置的值，对于所有被@RequestMapping注解的方法中，都可以通过ModelMap获取，如下：

@RequestMapping("/home")
publicStringhome(ModelMapmodelMap){
System.out.println(modelMap.get("author"));
}

//或者通过@ModelAttribute获取

@RequestMapping("/home")
publicStringhome(@ModelAttribute("author")Stringauthor){
System.out.println(author);
}

@ExceptionHandler拦截了异常，我们可以通过该注解实现自定义异常处理。其中，@ExceptionHandler配置的value指定需要拦截的异常类型，上面拦截了Exception.class这种异常。

二、自定义异常处理（全局异常处理）

springboot默认情况下会映射到/error进行异常处理，但是提示并不十分友好，下面自定义异常处理，提供友好展示。

1、编写自定义异常类：

packagecom.sam.demo.custom;

/**
*@authorsam
*@since2017/7/17
*/
publicclassMyExceptionextendsRuntimeException{

publicMyException(Stringcode,Stringmsg){
this.code=code;
this.msg=msg;
}

privateStringcode;
privateStringmsg;

//getter&setter
}

注：spring对于RuntimeException异常才会进行事务回滚。

2、编写全局异常处理类

创建MyControllerAdvice.java，如下：

packagecom.sam.demo.controller;

importorg.springframework.ui.Model;
importorg.springframework.web.bind.WebDataBinder;
importorg.springframework.web.bind.annotation.*;

importjava.util.HashMap;
importjava.util.Map;

/**
*controller增强器
*
*@authorsam
*@since2017/7/17
*/
@ControllerAdvice
publicclassMyControllerAdvice{

/**
*全局异常捕捉处理
*@paramex
*@return
*/
@ResponseBody
@ExceptionHandler(value=Exception.class)
publicMaperrorHandler(Exceptionex){
Mapmap=newHashMap();
map.put("code",100);
map.put("msg",ex.getMessage());
returnmap;
}

/**
*拦截捕捉自定义异常MyException.class
*@paramex
*@return
*/
@ResponseBody
@ExceptionHandler(value=MyException.class)
publicMapmyErrorHandler(MyExceptionex){
Mapmap=newHashMap();
map.put("code",ex.getCode());
map.put("msg",ex.getMsg());
returnmap;
}

}

3、controller中抛出异常进行测试。

@RequestMapping("/home")
publicStringhome()throwsException{

//thrownewException("Sam错误");
thrownewMyException("101","Sam错误");

}

启动应用，访问：http://localhost:8080/home，正常显示以下json内容，证明自定义异常已经成功被拦截。

{"msg":"Sam错误","code":"101"}

*如果不需要返回json数据，而要渲染某个页面模板返回给浏览器，那么MyControllerAdvice中可以这么实现：

@ExceptionHandler(value=MyException.class)
publicModelAndViewmyErrorHandler(MyExceptionex){
ModelAndViewmodelAndView=newModelAndView();
modelAndView.setViewName("error");
modelAndView.addObject("code",ex.getCode());
modelAndView.addObject("msg",ex.getMsg());
returnmodelAndView;
}

在templates目录下，添加error.ftl（这里使用freemarker）进行渲染：





错误页面


$[code]
${msg}

重启应用，http://localhost:8080/home显示自定的错误页面内容。

补充：如果全部异常处理返回json，那么可以使用@RestControllerAdvice代替@ControllerAdvice，这样在方法上就可以不需要添加@ResponseBody。

到此这篇关于SpringBoot@ControllerAdvice拦截异常并统一处理的文章就介绍到这了,更多相关SpringBoot@ControllerAdvice拦截异常内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

SpringBoot @ControllerAdvice 拦截异常并统一处理

$[code]

${msg}

热门推荐

随机推荐