欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot中的統(tǒng)一異常處理詳細解析

 更新時間:2024年01月27日 11:00:22   作者:魅Lemon  
這篇文章主要介紹了SpringBoot中的統(tǒng)一異常處理詳細解析,該注解可以把異常處理器應用到所有控制器,而不是單個控制器,借助該注解,我們可以實現(xiàn):在獨立的某個地方,比如單獨一個類,定義一套對各種異常的處理機制,需要的朋友可以參考下

一、概述

1、統(tǒng)一異常處理介紹

Spring在3.2版本增加了一個注解@ControllerAdvice,可以與@ExceptionHandler、@InitBinder、@ModelAttribute 等注解注解配套使用。不過跟異常處理相關的只有注解@ExceptionHandler,從字面上看,就是 異常處理器 的意思

2、原理和目標

簡單的說,該注解可以把異常處理器應用到所有控制器,而不是單個控制器。借助該注解,我們可以實現(xiàn):在獨立的某個地方,比如單獨一個類,定義一套對各種異常的處理機制,然后在類的簽名加上注解@ControllerAdvice,統(tǒng)一對 不同階段的、不同異常 進行處理。這就是統(tǒng)一異常處理的原理。

對異常按階段進行分類,大體可以分成:進入Controller前的異常 和 Service 層異常

目標就是消滅95%以上的 try catch 代碼塊,并以優(yōu)雅的 Assert(斷言) 方式來校驗業(yè)務的異常情況,只關注業(yè)務邏輯,而不用花費大量精力寫冗余的 try catch 代碼塊。

二、Assert(斷言)

1、概述

**Assert(斷言)**是Spring 家族的 org.springframework.util.Assert,在我們寫測試用例的時候經常會用到,使用斷言能讓我們編碼的時候有一種非一般絲滑的感覺

Assert 的部分源碼,可以看到,Assert 其實就是幫我們把 if {…} 封裝了一下,拋出的異常是IllegalArgumentException()

public abstract class Assert {
    public Assert() {
    }
    public static void notNull(@Nullable Object object, String message) {
        if (object == null) {
            throw new IllegalArgumentException(message);
        }
    }
}

2、Assert自定義實戰(zhàn)

2.1 自定義接口Assert

Assert斷言方法是使用接口的默認方法定義的,然后有沒有發(fā)現(xiàn)當斷言失敗后,拋出的異常不是具體的某個異常,而是交由2個newException接口方法提供。因為業(yè)務邏輯中出現(xiàn)的異?;径际菍囟ǖ膱鼍?,比如根據用戶id獲取用戶信息,查詢結果為null,此時拋出的異??赡転閁serNotFoundException,并且有特定的異常碼(比如7001)和異常信息"用戶不存在"。所以具體拋出什么異常,有Assert的實現(xiàn)類決定。

public interface Assert {
    /**
     * 創(chuàng)建異常
     * @param args
     * @return
     */
    BaseException newException(Object... args);
    /**
     * 創(chuàng)建異常
     * @param t
     * @param args
     * @return
     */
    BaseException newException(Throwable t, Object... args);
    /**
     * <p>斷言對象<code>obj</code>非空。如果對象<code>obj</code>為空,則拋出異常
     *
     * @param obj 待判斷對象
     */
    default void assertNotNull(Object obj) {
        if (obj == null) {
            throw newException(obj);
        }
    }
    /**
     * <p>斷言對象<code>obj</code>非空。如果對象<code>obj</code>為空,則拋出異常
     * <p>異常信息<code>message</code>支持傳遞參數方式,避免在判斷之前進行字符串拼接操作
     *
     * @param obj 待判斷對象
     * @param args message占位符對應的參數列表
     */
    default void assertNotNull(Object obj, Object... args) {
        if (obj == null) {
            throw newException(args);
        }
    }
}

2.2 自定義異常

public interface IResponseEnum {
    int getCode();
    String getMessage();
}
/**
 * <p>業(yè)務異常</p>
 * <p>業(yè)務處理時,出現(xiàn)異常,可以拋出該異常</p>
 */
public class BusinessException extends  BaseException {
    private static final long serialVersionUID = 1L;
    public BusinessException(IResponseEnum responseEnum, Object[] args, String message) {
        super(responseEnum, args, message);
    }
    public BusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
        super(responseEnum, args, message, cause);
    }
}

2.3 Enum整合

代碼示例中定義了兩個枚舉實例:BAD_LICENCE_TYPE、LICENCE_NOT_FOUND,分別對應了BadLicenceTypeException、LicenceNotFoundException兩種異常。

以后每增加一種異常情況,只需增加一個枚舉實例即可,再也不用每一種異常都定義一個異常類了

public interface BusinessExceptionAssert extends IResponseEnum, Assert {
    @Override
    default BaseException newException(Object... args) {
        String msg = MessageFormat.format(this.getMessage(), args);
        return new BusinessException(this, args, msg);
    }
    @Override
    default BaseException newException(Throwable t, Object... args) {
        String msg = MessageFormat.format(this.getMessage(), args);
        return new BusinessException(this, args, msg, t);
    }
}
@Getter
@AllArgsConstructor
public enum ResponseEnum implements BusinessExceptionAssert {
    /**
     * Bad licence type
     */
    BAD_LICENCE_TYPE(7001, "Bad licence type."),
    /**
     * Licence not found
     */
    LICENCE_NOT_FOUND(7002, "Licence not found.")
    ;
    /**
     * 返回碼
     */
    private int code;
    /**
     * 返回消息
     */
    private String message;
}

2.4 實戰(zhàn)檢測

使用枚舉類結合(繼承)Assert,只需根據特定的異常情況定義不同的枚舉實例,如上面的BAD_LICENCE_TYPE、LICENCE_NOT_FOUND,就能夠針對不同情況拋出特定的異常(這里指攜帶特定的異常碼和異常消息),這樣既不用定義大量的異常類,同時還具備了斷言的良好可讀性

private void checkNotNull(Licence licence) {
    ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence,"測試");
}
// 替代下面的方法
private void checkNotNull(Licence licence) {
    if (licence == null) {
        throw new LicenceNotFoundException();
        // 或者這樣
        throw new BusinessException(7001, "Bad licence type.");
    }
}

三、統(tǒng)一異常處理器

1、異常處理器說明

1.1 handleServletException

一個http請求,在到達Controller前,會對該請求的請求信息與目標控制器信息做一系列校驗

  • NoHandlerFoundException:首先根據請求Url查找有沒有對應的控制器,若沒有則會拋該異常,也就是大家非常熟悉的404異常,但是實際上當出現(xiàn)404的時候,默認是不拋異常的,而是 forward跳轉到/error控制器,spring也提供了默認的error控制器,如果要拋出異常,需要配置
spring.mvc.throw-exception-if-no-handler-found=true
spring.web.resources.add-mappings=false
  • HttpRequestMethodNotSupportedException:若匹配到了(匹配結果是一個列表,不同的是http方法不同,如:Get、Post等),則嘗試將請求的http方法與列表的控制器做匹配,若沒有對應http方法的控制器,則拋該異常;
  • HttpMediaTypeNotSupportedException:然后再對請求頭與控制器支持的做比較,比如content-type請求頭,若控制器的參數簽名包含注解@RequestBody,但是請求的content-type請求頭的值沒有包含application/json,那么會拋該異常(當然,不止這種情況會拋這個異常);
  • MissingPathVariableException:未檢測到路徑參數。比如url為:/licence/{licenceId},參數簽名包含@PathVariable("licenceId"),當請求的url為/licence,在沒有明確定義url為/licence的情況下,會被判定為:缺少路徑參數;
  • MissingServletRequestParameterException:缺少請求參數。比如定義了參數@RequestParam("licenceId") String licenceId,但發(fā)起請求時,未攜帶該參數,則會拋該異常;
  • TypeMismatchException: 參數類型匹配失敗。比如:接收參數為Long型,但傳入的值確是一個字符串,那么將會出現(xiàn)類型轉換失敗的情況,這時會拋該異常;
  • HttpMessageNotReadableException:與上面的HttpMediaTypeNotSupportedException舉的例子完全相反,即請求頭攜帶了"content-type: application/json;charset=UTF-8",但接收參數卻沒有添加注解@RequestBody,或者請求體攜帶的 json 串反序列化成 pojo 的過程中失敗了,也會拋該異常;
  • HttpMessageNotWritableException:返回的 pojo 在序列化成 json 過程失敗了,那么拋該異常;

1.2 handleBindException和handleValidException

參數校驗異常

1.3 handleBusinessException、handleBaseException

處理自定義的業(yè)務異常,只是handleBaseException處理的是除了 BusinessException 意外的所有業(yè)務異常。就目前來看,這2個是可以合并成一個的

1.4 handleException

處理所有未知的異常,比如操作數據庫失敗的異常。

注:上面的handleServletException、handleException 這兩個處理器,返回的異常信息,不同環(huán)境返回的可能不一樣,以為這些異常信息都是框架自帶的異常信息,一般都是英文的,不太好直接展示給用戶看,所以統(tǒng)一返回SERVER_ERROR代表的異常信息

2、自定義統(tǒng)一異常處理器類

將異常分成幾類,實際上只有兩大類,一類是ServletException、ServiceException,還記得上文提到的 按階段分類 嗎,即對應 進入Controller前的異常 和 Service 層異常;然后 ServiceException 再分成自定義異常、未知異常。對應關系如下:

  • 進入Controller前的異常: handleServletException、handleBindException、handleValidException
  • 自定義異常:handleBusinessException、handleBaseException
  • 未知異常: handleException
@Slf4j
@Component
@ControllerAdvice
@ConditionalOnWebApplication
@ConditionalOnMissingBean(UnifiedExceptionHandler.class)
public class UnifiedExceptionHandler {
    /**
     * 生產環(huán)境
     */
    private final static String ENV_PROD = "prod";
    @Autowired
    private UnifiedMessageSource unifiedMessageSource;
    /**
     * 當前環(huán)境
     */
    @Value("${spring.profiles.active}")
    private String profile;
    /**
     * 獲取國際化消息
     * 這里可以做處理
     * @param e 異常
     * @return
     */
    public String getMessage(BaseException e) {
        String code = "response." + e.getResponseEnum().toString();
        String message = unifiedMessageSource.getMessage(code, e.getArgs());
        if (message == null || message.isEmpty()) {
            return e.getMessage();
        }
        return message;
    }
    /**
     * 業(yè)務異常
     *
     * @param e 異常
     * @return 異常結果
     */
    @ExceptionHandler(value = BusinessException.class)
    @ResponseBody
    public ErrorResponse handleBusinessException(BaseException e) {
        log.error(e.getMessage(), e);
        return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
    }
    /**
     * 自定義異常
     *
     * @param e 異常
     * @return 異常結果
     */
    @ExceptionHandler(value = BaseException.class)
    @ResponseBody
    public ErrorResponse handleBaseException(BaseException e) {
        log.error(e.getMessage(), e);
        return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
    }
    /**
     * Controller上一層相關異常
     *
     * @param e 異常
     * @return 異常結果
     */
    @ExceptionHandler({
            NoHandlerFoundException.class,
            HttpRequestMethodNotSupportedException.class,
            HttpMediaTypeNotSupportedException.class,
            MissingPathVariableException.class,
            MissingServletRequestParameterException.class,
            TypeMismatchException.class,
            HttpMessageNotReadableException.class,
            HttpMessageNotWritableException.class,
            // BindException.class,
            // MethodArgumentNotValidException.class
            HttpMediaTypeNotAcceptableException.class,
            ServletRequestBindingException.class,
            ConversionNotSupportedException.class,
            MissingServletRequestPartException.class,
            AsyncRequestTimeoutException.class
    })
    @ResponseBody
    public ErrorResponse handleServletException(Exception e) {
        log.error(e.getMessage(), e);
        int code = CommonResponseEnum.SERVER_ERROR.getCode();
        try {
            ServletResponseEnum servletExceptionEnum = ServletResponseEnum.valueOf(e.getClass().getSimpleName());
            code = servletExceptionEnum.getCode();
        } catch (IllegalArgumentException e1) {
            log.error("class [{}] not defined in enum {}", e.getClass().getName(), ServletResponseEnum.class.getName());
        }
        if (ENV_PROD.equals(profile)) {
            // 當為生產環(huán)境, 不適合把具體的異常信息展示給用戶, 比如404.
            code = CommonResponseEnum.SERVER_ERROR.getCode();
            BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
            String message = getMessage(baseException);
            return new ErrorResponse(code, message);
        }
        return new ErrorResponse(code, e.getMessage());
    }
    /**
     * 參數綁定異常
     *
     * @param e 異常
     * @return 異常結果
     */
    @ExceptionHandler(value = BindException.class)
    @ResponseBody
    public ErrorResponse handleBindException(BindException e) {
        log.error("參數綁定校驗異常", e);
        return wrapperBindingResult(e.getBindingResult());
    }
    /**
     * 參數校驗異常,將校驗失敗的所有異常組合成一條錯誤信息
     *
     * @param e 異常
     * @return 異常結果
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseBody
    public ErrorResponse handleValidException(MethodArgumentNotValidException e) {
        log.error("參數綁定校驗異常", e);
        return wrapperBindingResult(e.getBindingResult());
    }
    /**
     * 包裝綁定異常結果
     *
     * @param bindingResult 綁定結果
     * @return 異常結果
     */
    private ErrorResponse wrapperBindingResult(BindingResult bindingResult) {
        StringBuilder msg = new StringBuilder();
        for (ObjectError error : bindingResult.getAllErrors()) {
            msg.append(", ");
            if (error instanceof FieldError) {
                msg.append(((FieldError) error).getField()).append(": ");
            }
            msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());
        }
        return new ErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2));
    }
    /**
     * 未定義異常
     *
     * @param e 異常
     * @return 異常結果
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ErrorResponse handleException(Exception e) {
        log.error(e.getMessage(), e);
        if (ENV_PROD.equals(profile)) {
            // 當為生產環(huán)境, 不適合把具體的異常信息展示給用戶, 比如數據庫異常信息.
            int code = CommonResponseEnum.SERVER_ERROR.getCode();
            BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
            String message = getMessage(baseException);
            return new ErrorResponse(code, message);
        }
        return new ErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage());
    }
}

3、其他類型統(tǒng)一處理器

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 沒有登錄
     * @param request
     * @param response
     * @param e
     * @return
     */
    @ExceptionHandler(NoLoginException.class)
    public Object noLoginExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
    {
        log.error("[GlobalExceptionHandler][noLoginExceptionHandler] exception",e);
        JsonResult jsonResult = new JsonResult();
        jsonResult.setCode(JsonResultCode.NO_LOGIN);
        jsonResult.setMessage("用戶登錄失效或者登錄超時,請先登錄");
        return jsonResult;
    }
    /**
     * 業(yè)務異常
     * @param request
     * @param response
     * @param e
     * @return
     */
    @ExceptionHandler(ServiceException.class)
    public Object businessExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
    {
        log.error("[GlobalExceptionHandler][businessExceptionHandler] exception",e);
        JsonResult jsonResult = new JsonResult();
        jsonResult.setCode(JsonResultCode.FAILURE);
        jsonResult.setMessage("業(yè)務異常,請聯(lián)系管理員");
        return jsonResult;
    }
    /**
     * 全局異常處理
     * @param request
     * @param response
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    public Object exceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
    {
        log.error("[GlobalExceptionHandler][exceptionHandler] exception",e);
        JsonResult jsonResult = new JsonResult();
        jsonResult.setCode(JsonResultCode.FAILURE);
        jsonResult.setMessage("系統(tǒng)錯誤,請聯(lián)系管理員");
        return jsonResult;
    }
}

4、統(tǒng)一返回結果

code、message 是所有返回結果中必有的字段,而當需要返回數據時,則需要另一個字段 data 來表示。所以首先定義一個 BaseResponse 來作為所有返回結果的基類

然后定義一個通用返回結果類CommonResponse,繼承 BaseResponse,而且多了字段 data;為了區(qū)分成功和失敗返回結果,于是再定義一個 ErrorResponse

最后還有一種常見的返回結果,即返回的數據帶有分頁信息,因為這種接口比較常見,所以有必要單獨定義一個返回結果類 QueryDataResponse,該類繼承自 CommonResponse,只是把 data 字段的類型限制為 QueryDdata,QueryDdata中定義了分頁信息相應的字段,即totalCount、pageNo、 pageSize、records。其中比較常用的只有 CommonResponse 和 QueryDataResponse,但是名字又賊鬼死長,何不定義2個名字超簡單的類來替代呢?于是 R 和 QR 誕生了,以后返回結果的時候只需這樣寫:new R<>(data)、new QR<>(queryData)

因為這一套統(tǒng)一異常處理可以說是通用的,所有可以設計成一個 common包,以后每一個新項目/模塊只需引入該包即可

到此這篇關于SpringBoot中的統(tǒng)一異常處理詳細解析的文章就介紹到這了,更多相關SpringBoot統(tǒng)一異常處理內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!

相關文章

  • SharedingSphere?自定義脫敏規(guī)則介紹

    SharedingSphere?自定義脫敏規(guī)則介紹

    這篇文章主要介紹了SharedingSphere?自定義脫敏規(guī)則,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2021-12-12
  • Java中如何控制bean的加載順序

    Java中如何控制bean的加載順序

    springboot遵從約定大于配置的原則,極大程度的解決了配置繁瑣的問題,在此基礎上,又提供了spi機制,用spring.factories可以完成一個小組件的自動裝配功能,這篇文章主要介紹了如何控制bean的加載順序,需要的朋友可以參考下
    2024-12-12
  • Java實現(xiàn)布隆過濾器的方法步驟

    Java實現(xiàn)布隆過濾器的方法步驟

    布隆過濾器是可以用于判斷一個元素是不是在一個集合里,并且相比于其它的數據結構,布隆過濾器在空間和時間方面都有巨大的優(yōu)勢。下面這篇文章主要給大家介紹了關于Java實現(xiàn)布隆過濾器的相關資料,需要的朋友可以參考下
    2018-11-11
  • 使用Java增刪改查數據庫的操作方法

    使用Java增刪改查數據庫的操作方法

    這篇文章主要介紹了使用Java增刪改查數據庫的操作方法,本文通過實例代碼給大家介紹的非常詳細,感興趣的朋友跟隨小編一起看看吧
    2024-12-12
  • idea使用war以及war exploded的區(qū)別說明

    idea使用war以及war exploded的區(qū)別說明

    本文詳細解析了war與warexploded兩種部署方式的差異及步驟,war方式是先打包成war包,再部署到服務器上;warexploded方式是直接把文件夾、class文件等移到Tomcat上部署,支持熱部署,開發(fā)時常用,文章分別列出了warexploded模式和war包形式的具體操作步驟
    2024-10-10
  • Spring Security 實現(xiàn)多種登錄方式(常規(guī)方式外的郵件、手機驗證碼登錄)

    Spring Security 實現(xiàn)多種登錄方式(常規(guī)方式外的郵件、手機驗證碼登錄)

    本文主要介紹了Spring Security 實現(xiàn)多種登錄方式(常規(guī)方式外的郵件、手機驗證碼登錄),文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2022-01-01
  • Java Spring框架的概述

    Java Spring框架的概述

    這篇文章主要為大家介紹了Java Spring框架,具有一定的參考價值,感興趣的小伙伴們可以參考一下,希望能夠給你帶來幫助
    2022-01-01
  • springboot使用@Validated或@Valid注解校驗參數方式

    springboot使用@Validated或@Valid注解校驗參數方式

    這篇文章主要介紹了springboot使用@Validated或@Valid注解校驗參數方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教
    2024-07-07
  • SpringCache緩存處理詳解

    SpringCache緩存處理詳解

    這篇文章主要介紹了SpringCache緩存處理詳解,SpringCache是一個框架,實現(xiàn)了基于注解緩存功能,只需要簡單地加一個注解,就能實現(xiàn)緩存功能,需要的朋友可以參考下
    2023-09-09
  • Java中\(zhòng)n和\r區(qū)別

    Java中\(zhòng)n和\r區(qū)別

    本文主要介紹了Java中\(zhòng)n和\r區(qū)別。具有很好的參考價值,下面跟著小編一起來看下吧
    2017-02-02

最新評論