前言
本篇文章主要介绍的是SpringBoot项目进行全局异常的处理。
SpringBoot全局异常准备
说明:如果想直接获取工程那么可以直接跳到底部,通过链接下载工程代码。
开发准备
环境要求JDK:1.8SpringBoot:1.5.17.RELEASE
首先还是Maven的相关依赖:
UTF-81.81.81.8org.springframework.boot spring-boot-starter-parent 1.5.17.RELEASEorg.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test testcom.alibaba fastjson 1.2.41
配置文件这块基本不需要更改,全局异常的处理只需在代码中实现即可。
代码编写
SpringBoot的项目已经对有一定的异常处理了,但是对于我们开发者而言可能就不太合适了,因此我们需要对这些异常进行统一的捕获并处理。SpringBoot中有一个ControllerAdvice的注解,使用该注解表示开启了全局异常的捕获,我们只需在自定义一个方法使用ExceptionHandler注解然后定义捕获异常的类型即可对这些捕获的异常进行统一的处理。
我们根据下面的这个示例来看该注解是如何使用吧。
示例代码:
@ControllerAdvicepublic 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;}@Overridepublic String getResultCode() {return resultCode;}@Overridepublic String getResultMsg() {return resultMsg;}}
</