[Java知识库]【Spring】Spring全局异常处理（一）

Spring全局异常处理

在开发的过程我们总是遇到各种各样的异常，有默认定义好的，有自己定义的；有在开发的时候抛出来的，也有在数据库抛出来的；有时候不同的方法会抛出同一个异常，或者几个类都会抛出同样的异常。如果我们要分别处理异常，这简直让程序员抓狂。如果有一种统一处理异常的方式，那代码就会简化很多，程序员也少敲很多重复代码。

目前我们可以有这几种方法，

第一种：spring3.2之前可以用HandlerExceptionResolver和@ExceptionHandler

第二章：spring3.2版本之后可以用搭配组合@ControllerAdvice和@ExceptionHandler

第三种：spring5以后可以用ResponseStatusException

@ExceptionHandler

/**
 * Annotation for handling exceptions in specific handler classes and/or
 * handler methods.
 
  * <p>The following return types are supported for handler methods:
 * <ul>
 * <li>A {@code ModelAndView} object  .......
 * <li>A {@link org.springframework.ui.Model} object .......
 * <li>A {@link java.util.Map} object  ......
 * <li>A {@link org.springframework.web.servlet.View} object.
 * <li>A {@link String} value which is interpreted as view name.
 * <li>{@link ResponseBody @ResponseBody}  ......
 * <li>An {@link org.springframework.http.HttpEntity } or {@link org.springframework.http.ResponseEntity }  ......
 * <li>{@code void}  ......
 * </ul>
 ......
  * <p>You may combine the {@code ExceptionHandler} annotation with
 * {@link ResponseStatus @ResponseStatus} for a specific HTTP error status.
 ......
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler {

	/**
	 * Exceptions handled by the annotated method. If empty, will default to any
	 * exceptions listed in the method argument list.
	 */
	Class<? extends Throwable>[] value() default {};

}

上面是源码的部分，先看看这个注解的定义，从定义中我们可以看出这个注解可以用在类或者方法上，它可以和@ResponseStatus配合使用，只有一个参数，默认情况下所有异常都会被捕获。

接下来我们实战体验一下

为了简单起见一切从简

@RestController
public class ExceptionHandlerController {
    
    @GetMapping("handleException")
    public String handleException() throws Exception {
        throw new ClassNotFoundException("--------handleException----------");
    }

    @ExceptionHandler(value = { ClassNotFoundException.class })
    public String handleClassNotFoundException(HttpServletRequest request, HttpServletResponse response, Exception ex) {
        return "ClassNotFoundException!!!!!!!!!!!";
    }
}

我们定义了一个ExceptionHandlerController，有一个Get请求，在这个请求里面我们直接抛出一个ClassNotFoundException异常，然后在ExceptionHandlerController定义一个异常捕获器，没有任何处理，我们现在先简单返回一个String。在Postman工具里直接访问APIhttp://localhost:8080/handleException看看结果

因为我们没有做任何处理，所以这个时候返回的状态是200，body直接打印了我们方法里返回的字符串，在项目开发中我们肯定不会这样直接返回200的状态，毕竟都出异常怎么还能正常返回？。从上面贴的源代码中我们看到它说可以结合@ResponseStatus使用，可以利用它修改状态码。我们修改下代码

@RestController
public class ExceptionHandlerController {
    
    @GetMapping("handleException")
    public String handleException() throws Exception {
        throw new ClassNotFoundException("--------handleException----------");
    }

    @ExceptionHandler(value = { ClassNotFoundException.class })
    @ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "Class is not found.")
    public String handleClassNotFoundException(HttpServletRequest request, HttpServletResponse response, Exception ex) {
        return "ClassNotFoundException!!!!!!!!!!!";
    }
}

再访问API看看结果

状态码变成了我们定义的NOT_FOUND，信息也变成了Class is not found.。这样的结果才是我们想要的。如果想要返回的body显示函数中返回的信息，那么可以将@ResponseStatus中的reason去掉。
从源码中我们看到异常处理函数可以有多种返回体，我们分别体验下都是什么样的效果

Map

代码

@RestController
public class ExceptionHandlerController {
    
    @GetMapping("handleException")
    public String handleException() throws Exception {
        throw new ClassNotFoundException("--------handleException----------");
    }
    
    @ExceptionHandler(value = { ClassNotFoundException.class })
    @ResponseStatus(value = HttpStatus.NOT_FOUND)
    public Map handleClassNotFoundException2(HttpServletRequest request, HttpServletResponse response, Exception ex) {
        Map<String, Object> resultMap = new HashMap<>();
        resultMap.put("ex", ex.getMessage());
        resultMap.put("ex type", ex.getClass().getName());
        return resultMap;
    }
}

结果：

ResponseEntity

代码

@RestController
public class ExceptionHandlerController {
    
    @GetMapping("handleException")
    public String handleException() throws Exception {
        throw new ClassNotFoundException("--------handleException----------");
    }
    
    @ExceptionHandler(value = { ClassNotFoundException.class })
    public ResponseEntity<ResponseObj> handleClassNotFoundException3(HttpServletRequest request, HttpServletResponse response, Exception ex) {
        ResponseObj obj = new ResponseObj(ex.getMessage());
        return new ResponseEntity(obj, HttpStatus.NOT_FOUND);
    }
    
    @Data
    @AllArgsConstructor
    class ResponseObj {
        String message;
    }
}

结果

使用ResponseEntity的好处是你可以不需要@ResponseStatus修改状态码，因为ResponseEntity的构造函数中就可以实现状态码的定义。此外也可以使用我们自定义的body体，如代码中的ResponseObj

ModelAndView

如果是一个页面程序，默认情况下如果在浏览器直接访问http://localhost:8080/handleException会给我们报一个错误页面

这样的页面既不美观、客户也看不懂，这时候我们一般就要定制自己的报错页面，ModelAndView返回体就可以实现。本例为了简便依旧使用默认error视图，但是我们做一下内容的修改。代码如下

@RestController
public class ExceptionHandlerController {
    
    @GetMapping("handleException")
    public String handleException() throws Exception {
        throw new ClassNotFoundException("--------handleException----------");
    }
    
    @ExceptionHandler(value = { ClassNotFoundException.class })
    public ModelAndView handleClassNotFoundException3(HttpServletRequest request, HttpServletResponse response, Exception ex) {
        ModelAndView mView = new ModelAndView("error");
        // 设置状态码
        mView.setStatus(HttpStatus.NOT_FOUND);
        // 修改status
        mView.addObject("status", "404");
        // 修改error信息
        mView.addObject("error", "ClassNotFoundException");
        // 显示时间
        mView.addObject("timestamp", new Date());
        return mView;
    }
}

浏览器刷新界面就可以看到不一样的视图了

其他的返回结构就不一一看了，有兴趣的可以自己去尝试下。

使用@ExceptionHandler会有一些缺陷，那就是它只能作用于当前的controller，可实际情况中会有n多个controller，如果每写一个controller就要重写一遍，那也很痛苦。当然，你可以把它写到父类，让其他controller类继承它，这样的话它就占用了继承的名额，java的世界里一个孩子类只能有一个父类。那我把它写到interface去可以吗？类可以实现多个接口，然而这样的代码优雅吗？即便不嫌弃它丑，这都是需要人为主动去加它，那万一哪天忘了或者新人不认识，这可咋整？所以我们就要考虑全局异常处理了。

未完待续

蜗牛速度般的学习，慢牛般的成长^-

更多文章欢迎关注“三横兰”