1、为什么要全局异常处理

在实际开发中，如果不处理统一处理异常，那么前端在调用后端提供的接口，就会处理各种的异常结构，对于前端来说那可谓是一场灾难，这对前后端的协作也不友好。比如后端路径：/api/v1/index/user?id=222，如果前端未传入ID，那么SpringBoot就会报如下异常：

{"timestamp":"2021-03-30T15:22:46.139+00:00","status":400,"error":"Bad Request","message":"","path":"/api/v1/index/user"}

或者是我们代码里面自定义异常throw new RuntimeException("用户信息未找到！");，对于Spring Boot来说抛出如下异常：

{"timestamp":"2021-03-30T15:25:55.657+00:00","status":500,"error":"Internal Server Error","message":"","path":"/api/v1/index/users"}

而后端真的异常信息是用户信息未找到！,前端获取到500异常，完全不知后端的具体异常。基于这些就有必要全局统一处理异常。

2、实现全局异常处理

2.1 封装统一结构消息

在实现全局异常处理之前，我们先封装一个统一结构的消息对象。

消息类

import lombok.AllArgsConstructor;
import lombok.Data;
@Data
@AllArgsConstructor
public class RestResponse {private String code;private String message;private Object data;
}

异常状态枚举

import lombok.AllArgsConstructor;
import lombok.Getter;
@Getter
@AllArgsConstructor
public enum ExceptionStatusEnums {OK("0","success"),ERROR("1","error");private String code;private String msg;
}

处理消息的工厂类

import com.tenghu.lf.enums.ExceptionStatusEnums;
import com.tenghu.lf.resp.RestResponse;public class ResponseFactory {private ResponseFactory(){}public static RestResponse getOkResponse(){return new RestResponse(ExceptionStatusEnums.OK.getCode(),ExceptionStatusEnums.OK.getMsg(),null);}public static RestResponse getOkResponse(String message){return new RestResponse(ExceptionStatusEnums.OK.getCode(),message,null);}public static RestResponse getOkResponse(Object data){return new RestResponse(ExceptionStatusEnums.OK.getCode(),ExceptionStatusEnums.OK.getMsg(),data);}public static RestResponse getOkResponse(String message,Object data){return new RestResponse(ExceptionStatusEnums.OK.getCode(),message,data);}public static RestResponse getErrorMessage(){return new RestResponse(ExceptionStatusEnums.ERROR.getCode(),ExceptionStatusEnums.ERROR.getMsg(),null);}public static RestResponse getErrorMessage(String message){return new RestResponse(ExceptionStatusEnums.ERROR.getCode(),message,null);}public static RestResponse getErrorMessage(String message,Object data){return new RestResponse(ExceptionStatusEnums.ERROR.getCode(),message,data);}public static RestResponse getBuildMessage(String code,String message){return new RestResponse(code,message,null);}public static RestResponse getBuildMessage(String code,String message,Object data){return new RestResponse(code,message,data);}
}

2.2 实现全局异常

定义一个全局异常处理类，在类上加上@RestControllerAdvice注解，也可以使用@ControllerAdvice注解，只不过使用后者，需要在各个方法上加上@ResponseBody注解

@RestControllerAdvice
public class GlobalExceptionHandler {/*** 处理自定义异常* @param componentException* @return*/@ExceptionHandler(ComponentException.class)public RestResponse componentException(ComponentException componentException) {componentException.printStackTrace();return ResponseFactory.getBuildMessage(componentException.getCode(),componentException.getLocalizedMessage());}/*** 处理请求参数异常* @param e* @return*/@ExceptionHandler(MissingServletRequestParameterException.class)public RestResponse paramMissingException(MissingServletRequestParameterException e){e.printStackTrace();return ResponseFactory.getBuildMessage(HttpStatus.INTERNAL_SERVER_ERROR.value()+"",String.format("请求参数：%s不能为空！",e.getParameterName()));}/*** 处理请求体异常* @param e* @return*/@ExceptionHandler(HttpMessageNotReadableException.class)public RestResponse readableException(HttpMessageNotReadableException e){e.printStackTrace();return ResponseFactory.getBuildMessage(HttpStatus.INTERNAL_SERVER_ERROR.value()+"",String.format("请求参数体不能为空！%s",e.getLocalizedMessage()));}/*** 处理其他未知的运行时异常* @param runtimeException* @return*/@ExceptionHandler(RuntimeException.class)public RestResponse runtimeException(RuntimeException runtimeException) {runtimeException.printStackTrace();return ResponseFactory.getBuildMessage(HttpStatus.INTERNAL_SERVER_ERROR.value()+"",runtimeException.getLocalizedMessage());}/*** 处理其他异常* @param exception* @return*/@ExceptionHandler(Exception.class)public RestResponse otherException(Exception exception){exception.printStackTrace();return ResponseFactory.getErrorMessage(exception.getLocalizedMessage());}
}

3、测试

访问路径/api/v1/index/user?name=小A，不传name的情况下。

{"code": "500","message": "请求参数：name不能为空！","data": null
}

访问路径/api/v1/index/user?name=小A，传name的情况下。

{"code": "0","message": "success","data": {"id": "1111","name": "小A"}
}

访问路径/api/v1/index，不传请求体。

{"code": "500","message": "请求参数体不能为空！Required request body is missing: public com.tenghu.lf.resp.RestResponse com.tenghu.lf.controller.IndexController.save(com.tenghu.lf.entity.User)","data": null
}

访问路径/api/v1/index，传请求体。

{"code": "0","message": "success","data": null
}

其他就不一一测试了，感兴趣的可以自己尝试下。

SpringBoot全局异常处理相关推荐

springboot全局异常处理_SpringBoot:如何优雅地处理全局异常
之前用springboot的时候,只知道捕获异常使用try{}catch,一个接口一个try{}catch,这也是大多数开发人员异常处理的常用方式,虽然屡试不爽,但会造成一个问题,就是一个Contro ...
springboot 全局异常处理类
目录标题 springboot 全局异常处理类依赖代码 springboot 全局异常处理类依赖 <dependen ...
[SpringBoot]全局异常处理
2019独角兽企业重金招聘Python工程师标准>>> 1. 全局异常处理 2. SpringBoot错误处理原理 3. SpringBoot定制错误页面 4. SpringBoot ...
SpringBoot 全局异常处理
下面首先来观察一个程序代码,例如:现在建立一个控制器,而后这个控制器自己抛出一个异常.@Controller public class MemberController extends Abstrac ...
SpringBoot全局异常处理及前端请求参数校验
SpringBoot全局异常捕获处理及参数校验文章目录 SpringBoot全局异常捕获处理及参数校验为什么要用全局异常处理? 如何进行全局异常捕获和处理? 统一结果封装统一返回结果枚举类使 ...
springBoot 全局异常处理报错： Could not resolve method parameter at index 0 in public .....
在学习 springboot 的全局异常处理时 ,我写了一个处理异常类 @ControllerAdvice public class ErrorCatchController {@Exceptio ...
springboot 全局异常处理自定义mvc错误页面展示
如下:所有的异常都会进入到这里.根据个人业务按需处理全局异常处理 @ControllerAdvice public class ErrorAdviceController {//指定捕获对象@Exc ...
springboot全局异常处理详解
对于全局异常需要认识两个注解 @RestControllerAdvice,@ExceptionHandler 1. @RestControllerAdvice 组成:@ControllerAdvice ...
springboot全局异常处理BasicErrorController和RestControllerAdvice
文章目录 RestControllerAdvice BasicErrorController ResponseBodyAdvice RestControllerAdvice @RestControll ...

SpringBoot全局异常处理