1. 为什么使用全局异常处理
我们知道,系统中异常包括:编译时异常和运行时异常RuntimeException,前者通过捕获异常从而获取异常信息,后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。在开发中,不管是dao层、service层还是controller层,都有可能抛出异常,在springmvc中,能将所有类型的异常处理从各处理过程解耦出来,既保证了相关处理过程的功能较单一,也实现了异常信息的统一处理和维护。
2. 异常处理流程
系统的dao、service、controller出现异常都通过throws Exception向上抛出,最后由springmvc前端控制器交由异常处理器进行异常处理。springmvc提供全局异常处理器(一个系统只有一个异常处理器)进行统一异常处理。
3. 使用示例
3.1SpringMVC中自带了一个异常处理器叫SimpleMappingExceptionResolver,该处理器实现了HandlerExceptionResolver 接口,全局异常处理器都需要实现该接口
1.在spring-mvc.xml 中加入如下配置
<!-- springmvc提供的简单异常处理器 -->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
<!-- 定义默认的异常处理页面 ,需要在WEB-INF/jsp 下定义error.jsp 错误页面 -->
<property name="defaultErrorView" value="error"/>
<!-- 定义异常处理页面用来获取异常信息的变量名,也可不定义,默认名为exception -->
<property name="exceptionAttribute" value="ex"/>
<!-- 定义需要特殊处理的异常,这是重要点 -->
<property name="exceptionMappings">
<props>
<prop key="java.lang.RuntimeException">error</prop>
</props>
<!-- 还可以定义其他的自定义异常 -->
</property>
</bean>
2.配置错误页面
在WEB-INF/jsp 目录下,创建error.jsp, 与上面的spring-mvc.xml中的配置相对应
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h1>系统异常,请与管理员联系</h1>
</body>
</html>
可以在body里加入 ${ex.message} 将错误信息 打印到页面上
3。可以在Controller中直接抛出一个异常进行测试。
@Controller
public class TestController {
@GetMapping("test")
public String hello(String name){
throw new RuntimeException("测试异常抛出...");
//return "redirect:/hello";
}
}
运行效果
3.2 通过接口实现全局异常
通过实现异常处理处理接口HandlerExceptionResovler处理全局异常。
1.实现接口
@Component
public class GlobalException implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("error");
if(ex instanceof RuntimeException){
modelAndView.addObject("msg", ex.getMessage());
}
return modelAndView;
}
}
注意: 使用这种方式,请将spring-mvc.xml中配置的全局异常删除。注释也行
测试方法一样 但是打印异常结果的方法改为 ${msg} 注意要加@Component 不然会跳不到报错打印界面!
3.3 使用注解方式定义全局异常
定义全局异常处理器:
@ControllerAdvice
public class HandlerGlobalException {
@ExceptionHandler
public ModelAndView handler(Exception ex) {
ModelAndView mv = new ModelAndView();
if(ex instanceof RuntimeException) {
mv.addObject("msg", ex.getMessage());
}
mv.setViewName("error");
//如果系统直接返回JSON格式的错误数据,可以如下操作
//mv.setView(new MappingJackson2JsonView());
return mv;
}
}
3.4 RestController异常处理
处理上面的mv.setView(new MappingJackson2JsonView());这种方式,来将错误信息使用JSON方式返回外,还可以使用如下方式:
@RestControllerAdvice = @ControllerAdvice + @ResponseBody
@RestControllerAdvice
public class HandlerRestGlobalException {
@ExceptionHandler
public Map<String,Object> handler(Exception e) {
Map<String,Object> map = new HashMap<>();
if(e instanceof RuntimeException) {
map.put("cod", -1);
map.put("msg", e.getMessage());
}
return map;
}
}
注意:返回JSON格式的数据,需要Jackson的支持,在pom.xml中加入jackson的依赖
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.13.3</version>
</dependency>
总结:注意组件的注释添加。与配置文件中的注释与删除。