Spring MVC 中的异常处理 (handling exceptions)

在任何应用开发中都需要对异常情况做处理，web应用也是如此。但是在Spring MVC中，所有的Request都是由Servlet处理的，返回的结果都是Response。也就是说，无论请求过程中出现什么异常，返回的都是一个Response，所有异常信息都要转换成Response。

当然，Spring提供了多种异常信息到Response信息的转换方式：

1. 一些特定的Spring异常已经被自动映射特定的http status code
2. 我们可以通过@ResponseStatus注解将一个异常，将其映射到特定的http status code
3. 我们可以通过@ExceptionHandler注解一个方法，由这个方法处理异常

一、将异常映射到http 状态码

上面讲过，Spring已经将一些特定异常映射成了http 状态码：

上面列表中的异常一般都是Spring的DispatchServlet在处理请求中经常遇到的异常，比如当DispatchServlet在处理请求过程中找不到controller对应的方法时，便会抛出NoSunchRequestHandlingMethodException，这个异常便会被自动映射成404 错误码。

自动映射的异常是有限的，无法覆盖应用中遇到的各种异常，幸好Spring提供了@ResponseStatus注解，可以将任何一个异常映射成http状态码，下面举个例子。

比如我们在写一个注册业务时，可能会遇到用户名已存在的问题，此时我们抛出一个用户已存在异常：

@RequestMapping(value = "/register", method = RequestMethod.POST)
public String processRegistration(User user) {
    if (registerService.isUserExist(user)) {
        throw new UserExistException();
    }
    registerService.register(user);
    return "profile";
}

此时我们希望在我们的业务抛出UserExistException异常时，DispatchServlet能将其映射成400状态码，这时我们可以通过@ResponseStatus对UserExistException异常进行配置：

@ResponseStatus(value = HttpStatus.BAD_REQUEST,reason="user has exist!")
public class UserExistException extends RuntimeException{

}

@ResponseStatus有两个属性，第一个属性是异常映射的http状态码，我们指定其值为400(bad-request)，第二个属性是原因描述。

我们启动应用，当我们的业务方法抛出UserExistException时，client端会收到异常指定的错误码和原因描述：

二、写异常处理方法

将异常映射成http 状态码可以满足大部分情形，但是有时候我们不希望异常出现时仅仅返回一个状态码，我们还希望能对出现的异常做特殊的处理。还是上面那个例子，当出现UserExistException时我们不返回状态码，而是将其重定向到一个错误页面，我们可以这么处理：

@RequestMapping(value = "/register", method = RequestMethod.POST)
public String processRegistration(User user) {
   try{
       registerService.register(user);
       return "profile";
   }catch(UserExistException e){
       return "error";
   }
}

上面是一种很普通的处理方式，不过上面这种方式还是稍显复杂，每个业务方法除了关心正常的业务逻辑之外还得处理异常业务逻辑。我们很容易想到，可不可让一个方法去单独处理异常？答案当然是可以的，我们可以使用Spring提供的@ExceptionHandler注解，上面例子就可以改造成这样：

@RequestMapping(value = "/register", method = RequestMethod.POST)
public String processRegistration(User user) {
    registerService.register(user);
    return "profile";
}

//异常处理方法
@ExceptionHandler(UserExistException.class)
public String handleUserExist() {
    return "error";
}

通过@ExceptionHandler注解的使用，业务逻辑只需要处理自己的正常逻辑，异常统统交给异常处理方法进行处理。另外，@ExceptionHandler注解可以捕获当前controller抛出的任何异常，所以同一个controller中的任何一个业务方法抛出异常，都可以交由一个异常处理方法统一处理。

既然@ExceptionHandler注解可以处理当前controller抛出的任何异常，那么还有没有一种方式可以让它捕获所有controller抛出的异常呢？答案也是可以的，这就需要用到@ControllerAdvice注解

三、捕获应用中所有controller异常

@ControllerAdvice注解可以是一个普通的controller变成一个controller advice，即切面controller。在切面controller里面可以定义三种类型的方法：

1. @ExceptionHandler注解的方法
2. @InitBinder注解的方法
3. @ModelAttribute注解的方法

切面controller里面的这些方法可以全局应用到所有controller的所有业务方法。有了这个特性，我们就可以利用一个切面controller集中处理应用中的所有异常了。还有，@ControllerAdvice本身已经被@controller注解，所以被@ControllerAdvice注解的类可以被自动扫描到，无需再注解@controller了。下面举例说明一下。

通过@ControllerAdvice注解定义一个可以处理所有controller异常的切面controller：

@ControllerAdvice
public class AppWideExceptionHandler {
    @ExceptionHandler(UserExistException.class)
    public String handleUserExist() {
        return "error";
    }
}

当应用中的任何一个controller抛出UserExistException异常时，都会被AppWideExceptionHandler中的handleUserExist()方法捕获处理，这就是我们最期待的。