在现在的前后端交互中，通常都规范了接口返回方式，如返回的接口状态（成功|失败）以及要返回的数据在那个字段取，或者说失败了以后提示信息从接口哪里返回，因此，如果想做全局异常，并且异常发生后能准确的返回给前端解析，那么需要异常发生时返回给前端的格式与正常失败场景的格式一致。
项目建立
利用idea 工具，很容易的搭建一个SpringBoot项目，要引入的maven依赖如下：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
很简单，除了加入web功能还加入了我们需要用到的JSR-303校验框架。
定义成功失败 返回码
public class Code {
/**
* 成功
*/
public static intSUCCESSED = 1;
/**
* 失败
*/
public static intFAILED = -1;
}
定义接口返回响应实体
public class Response<T> implements Serializable{
/**
*
*/
private static final longserialVersionUID = 4250719891313555820L;
/**
* 返回结果集
*/
private T result;
/**
* 返回消息
*/
private String msg;
/**
* 响应码
*/
private Integer code;
//set get 略
}
全局异常拦截和验证
定义自定义业务异常
public class MyException extends RuntimeException {
private static final longserialVersionUID = -5875371379845226068L;
public MyException(){}
public MyException(String msg){
this.msg = msg ;
}
/**
* 异常信息
*/
private String msg ;
/**
* 具体异常码
*/
private intcode = Code.FAILED;
get set 略
编写全局异常控制器并对自定义异常做处理
@ControllerAdvice
public class GlobalExceptionHandler {
private Loggerlogger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(value = MyException.class)
@ResponseBody
public Response<String> myExceptionErrorHandler(MyException ex) throws Exception {
logger.error("myExceptionErrorHandler info:{}",ex.getMessage());
Response<String> r = new Response<>();
r.setMsg(ex.getMsg());
r.setCode(ex.getCode());
return r;
}
编写controller模拟抛出业务异常
@RestController
@RequestMapping("/user")
public class UserController {
@PostMapping(value = "/update")
Response<Boolean> update(User user){
//todo 此处为模拟异常抛出
if(true){
throw new MyException("更新失败");
}
//todo 此处为模拟返回
Response<Boolean> response = new Response<>();
response.setCode(Code.SUCCESSED);
response.setResult(true);
return response;
}
}
postMan模拟请求接口，进行验证
数据绑定异常处理
通常我们操作数据的时候，不仅前端需要进行数据校验，后端也应当进行拦截和进行相应的错误提示，JSR-303校验框架也是我们的一种选择。
编写实体`User`，并对属性进行注解控制
public class User {
@NotNull(message = "用户名不能为空")
private String userName;
private int age;
//...
全局异常控制类加入拦截
@ControllerAdvice
public class GlobalExceptionHandler {
private Loggerlogger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(value = BindException.class)
@ResponseBody
public Response<String> bindExceptionErrorHandler(BindException ex) throws Exception {
logger.error("bindExceptionErrorHandler info:{}",ex.getMessage());
Response<String> r = new Response<>();
StringBuildersb = new StringBuilder();
FieldErrorfieldError = ex.getFieldError();
sb.append(fieldError.getDefaultMessage());
r.setMsg(sb.toString());
r.setCode(Code.FAILED);
return r;
}
//...
编写控制器
@RestController
@RequestMapping("/user")
public class UserController {
@PostMapping(value = "/add")
Response<User> add(@Validated User user){
//todo 此处为模拟返回
Response<User> response = new Response<>();
response.setCode(Code.SUCCESSED);
response.setResult(new User());
return response;
}
//...
postMan模拟请求
不填写任何属性，模拟添加操作，准确进行拦截和报错
项目结构预览：
感兴趣的可以自己来我的Java架构群，可以获取免费的学习资料，群号：855801563对Java技术，架构技术感兴趣的同学，欢迎加群，一起学习，相互讨论。
网友评论