使用@ControllerAdvice和@ExceptionHandler注解统一处理异常

程序中存在很多通过throw的抛出的Exception。

统一处理的优点是，我们可以给不同的异常给出对应的code和描述，并且可以结合日志，将异常记录下来，用于排查错误。

统一异常处理需要使用@ControllerAdvice和@ExceptionHandler注解

@ControllerAdvice，是Spring3.2提供的新注解,它是一个Controller增强器,可对controller中被 @RequestMapping注解的方法加一些逻辑处理。最常用的就是异常处理。需要配合@ExceptionHandler使用。当将异常抛到controller时,可以对异常进行统一处理,规定返回的json格式或是跳转到一个错误页面。

package com.liujx.handle;

import com.liujx.domain.Result;
import com.liujx.exception.GirlException;
import com.liujx.utils.ResultUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
public class ExceptionHandle {

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

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Result handle(Exception e) {
        if (e instanceof GirlException) {
            GirlException girlException = (GirlException) e;
            return ResultUtil.error(girlException.getCode(), girlException.getMessage());
        }else{
            logger.error("【系统异常】{}", e);
            return ResultUtil.error(-1, "未知错误");
        }
    }
}

自定义项目中的Exception，默认的exception类只接受msg，这里新增了code，来区分各种不同的异常。

package com.liujx.exception;

import com.liujx.enums.ResultEnum;

public class GirlException extends RuntimeException {
    private Integer code;

    public GirlException(ResultEnum resultEnum) {
        super(resultEnum.getMsg());
        this.code = resultEnum.getCode();
    }

    public Integer getCode() {
        return code;
    }

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

注意：RuntimeException的异常spring才会进行事务回滚。