快捷導(dǎo)航

SpringBoot全局異常處理方案分享

更新時間：2022年05月25日 09:33:20 作者：??千云????

這篇文章主要介紹了SpringBoot全局異常處理方案分享，文章圍繞主題展開詳細(xì)的內(nèi)容介紹，具有一定的參考價值，需要的小伙伴可以參考一下

一業(yè)務(wù)場景

調(diào)用接口時需要對屬性進行校驗，比如屬性長度，當(dāng)屬性為郵箱時校驗郵箱格式等，這時候要要用到@Validated注解，在使用這個注解后發(fā)現(xiàn)出現(xiàn)了一個問題，調(diào)用接口后并沒有返回我們想要的報錯結(jié)果，而是返回了 "message": "Validation failed for object='IMMessageSend'. Error count: 1",顯然這不是我們想要的結(jié)果，查看控制臺打印，發(fā)現(xiàn)如下輸出：

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個字符]] ]

原因是異常攔截字符串太長，這時候我們需要定義全局異常處理，來多系統(tǒng)拋出的異常進行攔截處理

二全局系統(tǒng)異常類

一）全局系統(tǒng)異常類

@Data
public class IMMessageSend {
   /**
    * 發(fā)送消息信息
   */
   @Length(max = 500,message = "消息長度不能大于500個字符")
   private String msg;
   /**
    * 接收用戶id集合
   */
   private List<String> receiveUserIds;
   /**
    * 發(fā)送用戶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)對異常進行攔截并遍歷
返回異常

二）包裝異常返回結(jié)果給前端，修改自定義異常

新建一個自定義異常：

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

在斷言中使用自定義異常：

public class MidAssert {
    /**
     * 斷言 執(zhí)行異常
     *
     * @param isTrue  判斷標(biāo)識
     * @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());
}