SpringBoot全局异常处理

SpringBoot全局异常处理
前言
本篇文章主要介绍的是SpringBoot项目进行全局异常的处理。

SpringBoot全局异常准备
说明：如果想直接获取工程那么可以直接跳到底部，通过链接下载工程代码。

开发准备
环境要求
JDK：1.8
SpringBoot：1.5.17.RELEASE

首先还是Maven的相关依赖:

配置文件这块基本不需要更改，全局异常的处理只需在代码中实现即可。

代码编写
SpringBoot的项目已经对有一定的异常处理了，但是对于我们开发者而言可能就不太合适了，因此我们需要对这些异常进行统一的捕获并处理。SpringBoot中有一个ControllerAdvice的注解，使用该注解表示开启了全局异常的捕获，我们只需在自定义一个方法使用ExceptionHandler注解然后定义捕获异常的类型即可对这些捕获的异常进行统一的处理。

我们根据下面的这个示例来看该注解是如何使用吧。

示例代码:

@ControllerAdvice
public class MyExceptionHandler {

@ExceptionHandler(value =Exception.class)
public String exceptionHandler(Exception e){
	System.out.println("未知异常！原因是:"+e);
   	return e.getMessage();
}

}

上述的示例中，我们对捕获的异常进行简单的二次处理，返回异常的信息，虽然这种能够让我们知道异常的原因，但是在很多的情况下来说，可能还是不够人性化，不符合我们的要求。
那么我们这里可以通过自定义的异常类以及枚举类来实现我们想要的那种数据吧。

自定义基础接口类

首先定义一个基础的接口类，自定义的错误描述枚举类需实现该接口。
代码如下:

public interface BaseErrorInfoInterface {
/** 错误码*/
String getResultCode();

/** 错误描述*/
 String getResultMsg();

}

自定义枚举类

然后我们这里在自定义一个枚举类，并实现该接口。
代码如下:

public enum CommonEnum implements BaseErrorInfoInterface {
// 数据操作错误定义
SUCCESS(“200”, “成功!”),
BODY_NOT_MATCH(“400”,“请求的数据格式不符!”),
SIGNATURE_NOT_MATCH(“401”,“请求的数字签名不匹配!”),
NOT_FOUND(“404”, “未找到该资源!”),
INTERNAL_SERVER_ERROR(“500”, “服务器内部错误!”),
SERVER_BUSY(“503”,“服务器正忙，请稍后再试!”)
;

/** 错误码 */
private String resultCode;

/** 错误描述 */
private String resultMsg;

CommonEnum(String resultCode, String resultMsg) {
	this.resultCode = resultCode;
	this.resultMsg = resultMsg;
}

@Override
public String getResultCode() {
	return resultCode;
}

@Override
public String getResultMsg() {
	return resultMsg;
}

}

自定义异常类

然后我们在来自定义一个异常类，用于处理我们发生的业务异常。
代码如下:

public class BizException extends RuntimeException {

private static final long serialVersionUID = 1L;

/**
 * 错误码
 */
protected String errorCode;
/**
 * 错误信息
 */
protected String errorMsg;

public BizException() {
	super();
}

public BizException(BaseErrorInfoInterface errorInfoInterface) {
	super(errorInfoInterface.getResultCode());
	this.errorCode = errorInfoInterface.getResultCode();
	this.errorMsg = errorInfoInterface.getResultMsg();
}

public BizException(BaseErrorInfoInterface errorInfoInterface, Throwable cause) {
	super(errorInfoInterface.getResultCode(), cause);
	this.errorCode = errorInfoInterface.getResultCode();
	this.errorMsg = errorInfoInterface.getResultMsg();
}

public BizException(String errorMsg) {
	super(errorMsg);
	this.errorMsg = errorMsg;
}

public BizException(String errorCode, String errorMsg) {
	super(errorCode);
	this.errorCode = errorCode;
	this.errorMsg = errorMsg;
}

public BizException(String errorCode, String errorMsg, Throwable cause) {
	super(errorCode, cause);
	this.errorCode = errorCode;
	this.errorMsg = errorMsg;
}


public String getErrorCode() {
	return errorCode;
}

public void setErrorCode(String errorCode) {
	this.errorCode = errorCode;
}

public String getErrorMsg() {
	return errorMsg;
}

public void setErrorMsg(String errorMsg) {
	this.errorMsg = errorMsg;
}

public String getMessage() {
	return errorMsg;
}

@Override
public Throwable fillInStackTrace() {
	return this;
}

}

自定义数据格式

顺便这里我们定义一下数据的传输格式。
代码如下:

public class ResultBody {
/**
* 响应代码
*/
private String code;

/**
 * 响应消息
 */
private String message;

/**
 * 响应结果
 */
private Object result;

public ResultBody() {
}

public ResultBody(BaseErrorInfoInterface errorInfo) {
	this.code = errorInfo.getResultCode();
	this.message = errorInfo.getResultMsg();
}

public String getCode() {
	return code;
}

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

public String getMessage() {
	return message;
}

public void setMessage(String message) {
	this.message = message;
}

public Object getResult() {
	return result;
}

public void setResult(Object result) {
	this.result = result;
}

/**
 * 成功
 * 
 * @return
 */
public static ResultBody success() {
	return success(null);
}

/**
 * 成功
 * @param data
 * @return
 */
public static ResultBody success(Object data) {
	ResultBody rb = new ResultBody();
	rb.setCode(CommonEnum.SUCCESS.getResultCode());
	rb.setMessage(CommonEnum.SUCCESS.getResultMsg());
	rb.setResult(data);
	return rb;
}

/**
 * 失败
 */
public static ResultBody error(BaseErrorInfoInterface errorInfo) {
	ResultBody rb = new ResultBody();
	rb.setCode(errorInfo.getResultCode());
	rb.setMessage(errorInfo.getResultMsg());
	rb.setResult(null);
	return rb;
}

/**
 * 失败
 */
public static ResultBody error(String code, String message) {
	ResultBody rb = new ResultBody();
	rb.setCode(code);
	rb.setMessage(message);
	rb.setResult(null);
	return rb;
}

/**
 * 失败
 */
public static ResultBody error( String message) {
	ResultBody rb = new ResultBody();
	rb.setCode("-1");
	rb.setMessage(message);
	rb.setResult(null);
	return rb;
}

@Override
public String toString() {
	return JSONObject.toJSONString(this);
}

}

自定义全局异常处理类

最后我们在来编写一个自定义全局异常处理的类。
代码如下:

@ControllerAdvice
public class GlobalExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

/**
 * 处理自定义的业务异常
 * @param req
 * @param e
 * @return
 */
@ExceptionHandler(value = BizException.class)  
@ResponseBody  
public  ResultBody bizExceptionHandler(HttpServletRequest req, BizException e){
	logger.error("发生业务异常！原因是：{}",e.getErrorMsg());
	return ResultBody.error(e.getErrorCode(),e.getErrorMsg());
}

/**
 * 处理空指针的异常
 * @param req
 * @param e
 * @return
 */
@ExceptionHandler(value =NullPointerException.class)
@ResponseBody
public ResultBody exceptionHandler(HttpServletRequest req, NullPointerException e){
	logger.error("发生空指针异常！原因是:",e);
	return ResultBody.error(CommonEnum.BODY_NOT_MATCH);
}


/**
    * 处理其他异常
 * @param req
 * @param e
 * @return
 */
@ExceptionHandler(value =Exception.class)
@ResponseBody
public ResultBody exceptionHandler(HttpServletRequest req, Exception e){
	logger.error("未知异常！原因是:",e);
   	return ResultBody.error(CommonEnum.INTERNAL_SERVER_ERROR);
}

}

因为这里我们只是用于做全局异常处理的功能实现以及测试

完成，去测试吧