Spring Boot 异常处理

异常处理简介

SpringBoot默认的异常处理机制下,会向/error的url发送请求。在SpringBoot中提供了一个名为BasicErrorController来处理/error请求,然后跳转到默认显式异常的页面来展示异常信息。

SpringBoot 支持五种自定义异常处理,优先级排序如下:

  1. @ExceptionHandler
  2. @ControllerAdvice
  3. HandlerExceptionResolver
  4. SimpleMappingExceptionResolver
  5. templates/error

templates/error
功能:实现统一的错误处理
优点:简单、只需添加一个error.html页面
缺点:不支持各种异常分别处理,无法获取异常信息

@ExceptionHandler 注解
功能:定义局部异常处理或配合@ControllerAdvice定义全局异常处理的功能实现。
通过value熟悉可定义对哪些异常类进行处理,默认处理该控制器来的所有异常。多个异常分别处理时可定义多个注解方法。

@ControllerAdvice 注解
功能:可实现全局异常处理。对于不同异常可在其内部分别定义多个@ExceptionHandler分别处理,也可以不做细分统一处理。
优点:全局控制,粗细粒度的处理都支持,可获取异常信息。
缺点:不同异常分别处理时需定义多个处理方法。

SimpleMappingExceptionResolver
功能:可实现全局异常处理。不同的异常通过键值对的方式实现异常全名与页面的映射关系。
优点:全局控制,异常与页面映射简单,支持细粒度异常处理。
缺点:没有通用异常处理,每个异常都需要映射。无法获取异常信息对象。

HandlerExceptionResolver
功能:可实现全局异常处理。支持多个异常的统一处理和分别处理。
优点:全局控制,粗细粒度都支持,可获取异常信息。
缺点:暂无(相较其它几种,个人感觉此种方式最好也最灵活)。

1、templates/error

如果我们需要将所有异常统一跳转到自定义的错误页面,需要在src/main/resources/templates目录下创建error.html页面。
注意:页面名称必须保持一致。

2、@ExceptionHandler

通过@ExceptionHandler脚注指定异常处理函数,脚注内可通过value属性指定多个异常类过滤处理,默认处理该类内的所有异常。

@Controller
public class UserController {

    @RequestMapping("showInfo")
    public String showInfo() {
        String str = null;
        str.length();
        return "ok";
    }

    // @ExceptionHandler(value = NullPointerException.class)
    @ExceptionHandler()
    public ModelAndView handleException(Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.setViewName("exceptionHandler");
        mv.addObject("error", e.toString());
        return mv;
    }
}

exceptionHandler.html(名称任意)

<body>
    <h2>系统内部发生了错误</h2>
    <span th:text="${error}"></span>
</body>

3、@ControllerAdvice

  1. 全局异常处理控制器使用@ControllerAdvice注解
  2. 方法使用@ExceptionHandler(),且返回ModelAndView类型。

GlobalException.java(名称任意)

@ControllerAdvice
public class GlobalException {

    /**
     * 全局异常处理
     * 也可以通过@ExceptionHandler(value = xxxxException.clas)分别定义多个异常处理
     */
    @ExceptionHandler()
    public ModelAndView globalExceptionHandler(Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.setViewName("globalException");
        mv.addObject("error", e.toString());
        return mv;
    }
}

UserController.java

@Controller
public class UserController {
    // 本控制器内处理 UserController::handleException
    @RequestMapping("null")
    public String nullException() {
        String str = null;
        str.length();
        return "ok";
    }

    // 全局异常处理类处理 GlobalException::globalExceptionHandler
    @RequestMapping("div")
    public String divException() {
        int a = 10 / 0;
        return "ok";
    }

    @ExceptionHandler(value = NullPointerException.class)
    public ModelAndView handleException(Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.setViewName("exceptionHandler");
        mv.addObject("error", e.toString());
        return mv;
    }
}

globalException(名称任意)

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="UTF-8">
    <title>全局异常处理</title>
</head>
<body>
<h2>系统内部发生了错误</h2>
<span th:text="${error}"></span>
</body>
</html>

4、SimpleMappingExceptionResolver

通过配置类创建全局异常映射处理

@Configuration
public class GlobalSimpleMappingException {

    /**
     * 返回值必须是SimpleMappingExceptionResolver
     * 异常类与异常页面的映射
     */
    @Bean
    public SimpleMappingExceptionResolver getResolver() {
        SimpleMappingExceptionResolver resolver = new SimpleMappingExceptionResolver();
        Properties properties = new Properties();
        /**
         * 参数1:异常类型,并且是全名
         * 参数2:视图名称
         */
        properties.put("java.lang.NullPointerException", "nullPointerExcetpion");
        properties.put("java.lang.ArithmeticException", "arithmeticException");
        resolver.setExceptionMappings(properties);
        return resolver;
    }
}

5、HandlerExceptionResolver

@Configuration
public class GlobalException3 implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(
            HttpServletRequest httpServletRequest,
            HttpServletResponse httpServletResponse,
            Object o, Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.setViewName("default");
        mv.addObject("error", e.toString());

        // 判断不同异常类型,做不同视图的跳转
        if(e instanceof NullPointerException) {
            mv.setViewName("nullPointerExcetpion");
        }
        if(e instanceof ArithmeticException) {
            mv.setViewName("arithmeticException");
        }

        return mv;
    }
}

评论

暂无评论