SSM框架整合笔记（五）统一异常处理

前言

在Java项目中，在控制器、业务层、数据库操作的过程中，总是会遇到各种可控和不可控的异常需要处理，如果我们在每一个异常可能出现的地方都手动使用try{}catch{}单独处理异常的话，会产生的最大的问题就是：异常处理过程中的返回错误信息、日志打印都可能不统一，导致代码冗余和不可维护。因此我们使用统一的方式处理异常：

本文内容

一、SpringMVC处理异常方式：

使用@ExceptionHandler注解：弊端：进行异常处理的方法必须与出错的方法在同一个Controller里面；
实现HandlerExceptionResolver接口：可以进行全局的异常控制。
使用@ControllerAdvice注解：使用了该注解之后，需要进行异常处理的方法与出错的方法就不必须在同一个Controller中了。@ControllerAdvice + @ExceptionHandler也可以实现全局的异常捕捉。

二、为控制器添加通知

如果要在多个控制器中处理异常，使用@ExceptionHandler注解是很有用的，但是如果多个控制器类中都会抛出异常，那么所有的控制器中都有重复相同的@ExceptionHandler方法。因此，需要创建一个基础的控制器类，所有的控制器要扩展这个类，从而继承通用的@ExceptionHandler方法。

Spring3.2引入了一个新的解决方案：控制器通知。控制器通知是所有带有@ControllerAdvice注解的类，这个类会包含一个或多个如下类型的方法：

@ExceptionHandler注解标注的方法；
@InitBinder注解标注的方法；
@ModelAttribute注解标注的方法；

@ControllerAdvice可以将所有的@ExceptionHandler方法收集到一个类中，把所有的控制器异常进行一致的处理。

添加ControllerAdviceHandler.java代码并添加扫描：

package com.weyoung.framework.config;

import com.weyoung.framework.exception.BusinessException;
import com.weyoung.framework.web.Message;
import com.weyoung.platform.pojo.UserInfo;
import org.apache.log4j.Logger;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

import static com.weyoung.framework.common.Constants.SESSION_DEFAULT;
import static com.weyoung.framework.common.ErrorConstants.EXCEPTION_SYSTEM_MSG;

/**
 * @作者 weyoung
 * @功能描述 给控制器请求添加默认常用参数，统一处理异常
 * @日期 2019/3/4
 */
@ControllerAdvice
public class ControllerAdviceHandler {

    private static final Logger logger = Logger.getLogger(ControllerAdviceHandler.class);

    /**
     * @Description // 添加用户信息，可以在Controller中获取
     **/
    @ModelAttribute("BasUser")
    public UserInfo basUser(HttpServletRequest request) {
        HttpSession session = request.getSession(true);
        UserInfo user = (UserInfo) session.getAttribute(SESSION_DEFAULT);
        return user;
    }

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Message exceptionHandler(Exception ex) {
        // 处理业务异常
        if (ex instanceof BusinessException) {
            logger.error("BusinessException", ex);
            // 返回业务异常code和message;
            return Message.failed(((BusinessException) ex).getCode(), ex.getMessage());
        } else {
            logger.error("Exception", ex);
            return Message.failed(Message.FAILED_CODE, EXCEPTION_SYSTEM_MSG);
        }
    }
}

三、处理业务异常

BusinessException.java

package com.weyoung.framework.exception;

import com.weyoung.framework.web.Message;

/**
 * @作者 weyoung
 * @功能描述 业务异常处理
 * @日期 2019/3/4
 */
public class BusinessException extends RuntimeException {

    private int code;

    public BusinessException(String message) {
        super(message);
        this.code = Message.FAILED_CODE;
    }

    public BusinessException(int code, String message) {
        super(message);
        this.code = code;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }
}

测试，在Controller中throw一个Exception，发现可以进入该通知了，配置成功。

在业务处理类中遇到可预知或不可预知的错误，直接由程序拦截处理，我们开发时只管throw Exception即可，控制器通知可以帮助我们处理和返回异常信息。

个人认为使用消息实体比如本文的Message类来统一规范地处理异常，不同的业务异常最好定义单独的error code，产生异常的信息和具体原因整理成文档，这样可以在上线之后不至于把敏感的错误信息返回到前端，又便于运维、实施同事能够快速地定位异常。

源码下载

该项目持续更新中，会在代码以及该文档里面详细注释和介绍。项目托管在码云开源平台上，持续更新项目源码链接：
https://gitee.com/nelucifer/ssm-note，点击克隆/下载获取该项目。