SpringBoot全局异常处理方案分享

目录

• 一 业务场景
• 二 全局系统异常类
  • 一）全局系统异常类
  • 二） 包装异常返回结果给前端，修改自定义异常
• 三 返回案例

一 业务场景

调用接口时需要对属性进行校验，比如属性长度，当属性为邮箱时校验邮箱格式等，这时候要要用到@Validated注解，在使用这个注解后发现出现了一个问题，调用接口后并没有返回我们想要的报错结果，而是返回了 "message": "Validation failed for object='IMMessageSend'. Error count: 1",显然这不是我们想要的结果，查看控制台打印，发现如下输出：

org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver Line:199 - Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.dst.mid.common.entities.result.Results<com.dst.message.core.common.model.IMMessageResponse> com.dst.message.core.modules.business.open.sendmessage.controller.IMMessageController.sendMessage(com.dst.message.core.common.model.IMMessageSend): [Field error in object 'IMMessageSend' on field 'msg': rejected value [901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789]; codes [Length.IMMessageSend.msg,Length.msg,Length.java.lang.String,Length]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [IMMessageSend.msg,msg]; arguments []; default message [msg],5,0]; default message [消息长度不能大于500个字符]] ]

原因是异常拦截字符串太长，这时候我们需要定义全局异常处理，来多系统抛出的异常进行拦截处理

二 全局系统异常类

一）全局系统异常类

@Data
public class IMMessageSend {
   /**
    * 发送消息信息
   */
   @Length(max = 500,message = "消息长度不能大于500个字符")
   private String msg;
   /**
    * 接收用户id集合
   */
   private List<String> receiveUserIds;
   /**
    * 发送用户id
   */
   private String sendUserId;
}

@Slf4j
@RestControllerAdvice
public class ExceptionHandlerConfig {
![image.png](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/210abf8f82204ea18c9af123dcb4a7f3~tplv-k3u1fbpfcp-watermark.image?)
   
    /**
     * 自定义验证异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        return new Results<>(false, "99999999",  e.getBindingResult().getFieldErrors().stream().map(FieldError::getDefaultMessage).collect(Collectors.joining("\n")));
    }
}

• @RestControllerAdvice与@ExceptionHandler搭配使用可以对异常进行拦截
• e.getBindingResult().getFieldErrors().stream().map(FieldError::getDefaultMessage)对异常进行拦截并遍历
• 返回异常

二） 包装异常返回结果给前端，修改自定义异常

新建一个自定义异常：

public class MidRouteException extends RuntimeException {
    private static final String ERROR_MESSAGE_FORMAT = "执行路由流程异常：%s";
    public MidRouteException(String error) {
        super(String.format(ERROR_MESSAGE_FORMAT, error));
    }
}

在断言中使用自定义异常：

public class MidAssert {
    /**
     * 断言 执行异常
     *
     * @param isTrue  判断标识
     * @param message 异常信息
     */
    public static void isTrueWithSqlException(boolean isTrue, String message) {
        if (!isTrue) {
            throw new MidRouteException(message);
        }
    }

在全局异常处理中对异常进行操作：

/**
 * 拦截MidSqlException MidSqlFrameException  MidRouteException MidRouteFrameException异常
 */
@ExceptionHandler({MidSqlException.class, MidSqlFrameException.class, MidRouteException.class, MidRouteFrameException.class})
public Results<String> midRouteExceptionHandler(HttpServletRequest req, HttpServletResponse res, Exception e) {
    log.error("中台异常", e);
    return new Results<>(false, "99999999", e.getMessage());
}

三 返回案例

到此这篇关于SpringBoot全局异常处理方案分享的文章就介绍到这了！