Spring MVC 处理异常的3种方式

妖狐艹你老母 2022-06-16 03:45 192阅读 0赞

使用Spring MVC开发的博客网站时，遇到了如何处理业务层抛出的异常的问题，查阅到了spring官方博客-[spring MVC中异常的处理][spring MVC]，以下将会以登录模块为示例。

# 愚蠢的处理方式 #

处理异常遵循**“早抛出，晚捕获"**的原则，在`controller`中统一处理异常，调用业务逻辑`service`时使用`try-catch`包围。

然而这样需要每个`controller`方法中会编写模版代码，自然Spring MVC的设计者也会想到这个问题！于是去查阅资料。

# 优雅的解决方案 #

Spring MVC提供的3类处理方式，实现在控制层`controller`的外围处理异常，大概示意图如下：

*  基于异常类（自定义），即针对某类异常;
 *  基于控制器（`controller`），即针对某个控制器;
 *  全局异常处理；

# Spring MVC异常处理 #

*`LoginController`控制器中处理登录的方法`login`，代码如下：*

/**
     * 登录
     * @param username
     * @param password
     * @param session
     * @return
     */
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    @ResponseBody
    public LuoblogResult<Author> login(String username, String password, HttpSession session) {
        // 登录的业务逻辑
        // 当用户名或密码错误将抛出异常
        Author author = authorService.login(username, password);
        return new LuoblogResult<Author>(true, author);
    }

为了和Spring异常处理产生对比，这里不使用任何异常处理，浏览器中输入不存在的用户，执行结果如下：

注：作者名不存在，业务层会抛出BusinessException异常；

## 1.基于自定异常类处理 ##

是时候让我们尝尝Spring异常处理这个香饽饽，[只需要使用@ResponseState注解对自定义异常类进行标注][ResponseState]，Spring在处理异常的时候会利用反射对该注解标记的异常特殊处理（个人推测）：

/**
     * 业务异常
     * Created by luokaiqiongmou on 2016/12/6.
     */
    @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "业务异常，伪装为错误请求")
    public class BusinessException extends RuntimeException{
        // 一些内容
    }

现在再来登录一次，输入不存在的用户名，执行结果如下：

巧妙的将原本的500错误，修改为400错误，那这有什么用了，这样你就可以控制对应异常发生时转化为其他的状态码，便于前端处理。

## 2.基于控制器，处理异常 ##

现在我们可以针对某个控制器处理异常，只需要在控制器中增加一个异常处理方法，并使用`@ExceptionHandler`标注：

@ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "业务异常，针对控制器处理")
        @ExceptionHandler(BusinessException.class)
        public void conflict() {
            // 不做任何事或者可以做任何事
        }

同样登录一次，结果如下：

注：`@ExceptionHandler`标注的方法，方法签名灵活、多变。[被@ResponseStatus注解的方法将会修改相应状态码][ResponseStatus]，而使用`@ResponseBody`可以返回json格式的数据，再供前端处理。参考：[示例][Link 1]

## 3. 全局的异常处理 ##

针对某个控制器处理异常的方式会造成代码入侵

### 方式一：使用注解 ###

现在创建一个专门处理异常的类，并添加`@ControllerAdvice`注解，如下：

/**
     * 异常处理
     * Created by luokaiqiongmou on 2016/12/17.
     */
    @ControllerAdvice
    public class GlobalExceptionHandler {
    
        private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    
        @ExceptionHandler(BusinessException.class)
        @ResponseBody
        public LuoblogResult<Object> handle(BusinessException e) {
            logger.warn("GloabalExceptionHandler handing a Exception: " + e.getMessage());
            // 业务失败返回
            return new LuoblogResult<Object>(false, e.getDescription());
        }
    
    }

再次登录，效果如下：

### 方式二：实现HandlerExceptionResolver，并注入到spring容器中 ###

创建一个类实现HandlerExceptionResolver，并在配置文件中注入bean，参考：[自定义异常处理器][Link 2]，以下方式未做测试

Spring已经为我们预定义了一个处理异常的解析类SimpleMappingExceptionResolve，添加如下配置文件即可：

# 总结 #

三种异常处理方式，主要涉及3个注解和1个接口，`@ExceptionHandler`标注的方法被定义为处理指定类型异常；`@ResponseStatus`标注的方法执行，会修改响应头中的状态码；Spring会把`@ControllerAdvice`[的类内部使用@ExceptionHandler方法应用到所有的][ExceptionHandler] @RequestMapping注解的方法上。

*  基于异常的处理方式，第一种无法实现json数据返回
 *  基于控制器的方式
 *  全局的方式!

[spring MVC]: https://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc
[ResponseState]: http://www.cnblogs.com/jcook/p/mailto:%E5%8F%AA%E9%9C%80%E8%A6%81%E4%BD%BF%E7%94%A8@responsestate%E6%B3%A8%E8%A7%A3%E5%AF%B9%E8%87%AA%E5%AE%9A%E4%B9%89%E5%BC%82%E5%B8%B8%E7%B1%BB%E8%BF%9B%E8%A1%8C%E6%A0%87%E6%B3%A8
[ResponseStatus]: http://www.cnblogs.com/jcook/p/mailto:%E8%A2%AB@responsestatus%E6%B3%A8%E8%A7%A3%E7%9A%84%E6%96%B9%E6%B3%95%E5%B0%86%E4%BC%9A%E4%BF%AE%E6%94%B9%E7%9B%B8%E5%BA%94%E7%8A%B6%E6%80%81%E7%A0%81
[Link 1]: http://snowolf.iteye.com/blog/1636050
[Link 2]: http://www.cnblogs.com/andy-zhou/p/5317820.html
[ExceptionHandler]: http://www.cnblogs.com/jcook/p/mailto:%E7%9A%84%E7%B1%BB%E5%86%85%E9%83%A8%E4%BD%BF%E7%94%A8@exceptionhandler%E6%96%B9%E6%B3%95%E5%BA%94%E7%94%A8%E5%88%B0%E6%89%80%E6%9C%89%E7%9A%84