背景

軟件開發(fā)過程中，不可避免的是需要處理各種異常涝缝，就我自己來(lái)說扑庞，至少有一半以上的時(shí)間都是在處理各種異常情況，所以代碼中就會(huì)出現(xiàn)大量的try {...} catch {...} finally {...} 代碼塊拒逮，不僅有大量的冗余代碼罐氨，而且還影響代碼的可讀性。比較下面兩張圖滩援，看看您現(xiàn)在編寫的代碼屬于哪一種風(fēng)格栅隐？然后哪種編碼風(fēng)格您更喜歡？

丑陋的 try catch 代碼塊

優(yōu)雅的Controller

上面的示例玩徊，還只是在Controller層租悄，如果是在Service層，可能會(huì)有更多的try catch代碼塊恩袱。這將會(huì)嚴(yán)重影響代碼的可讀性泣棋、“美觀性”。

所以如果是我的話畔塔，我肯定偏向于第二種潭辈，我可以把更多的精力放在業(yè)務(wù)代碼的開發(fā)，同時(shí)代碼也會(huì)變得更加簡(jiǎn)潔澈吨。

既然業(yè)務(wù)代碼不顯式地對(duì)異常進(jìn)行捕獲把敢、處理，而異撑锪桑肯定還是處理的技竟，不然系統(tǒng)豈不是動(dòng)不動(dòng)就崩潰了，所以必須得有其他地方捕獲并處理這些異常屈藐。

那么問題來(lái)了榔组，如何優(yōu)雅的處理各種異常熙尉？

什么是統(tǒng)一異常處理

Spring在3.2版本增加了一個(gè)注解@ControllerAdvice，可以與@ExceptionHandler搓扯、@InitBinder检痰、@ModelAttribute 等注解注解配套使用，對(duì)于這幾個(gè)注解的作用锨推，這里不做過多贅述铅歼，若有不了解的，可以參考Spring3.2新注解@ControllerAdvice换可，先大概有個(gè)了解椎椰。

不過跟異常處理相關(guān)的只有注解@ExceptionHandler，從字面上看沾鳄，就是 異常處理器 的意思慨飘，其實(shí)際作用也是：若在某個(gè)Controller類定義一個(gè)異常處理方法，并在方法上添加該注解译荞，那么當(dāng)出現(xiàn)指定的異常時(shí)瓤的，會(huì)執(zhí)行該處理異常的方法，其可以使用springmvc提供的數(shù)據(jù)綁定吞歼，比如注入HttpServletRequest等圈膏，還可以接受一個(gè)當(dāng)前拋出的Throwable對(duì)象。

但是篙骡，這樣一來(lái)稽坤，就必須在每一個(gè)Controller類都定義一套這樣的異常處理方法，因?yàn)楫惓医增？梢允歉鞣N各樣慎皱。這樣一來(lái)，就會(huì)造成大量的冗余代碼叶骨，而且若需要新增一種異常的處理邏輯茫多，就必須修改所有Controller類了，很不優(yōu)雅忽刽。

當(dāng)然你可能會(huì)說天揖，那就定義個(gè)類似BaseController的基類，這樣總行了吧跪帝。

這種做法雖然沒錯(cuò)今膊，但仍不盡善盡美，因?yàn)檫@樣的代碼有一定的侵入性和耦合性伞剑。簡(jiǎn)簡(jiǎn)單單的Controller斑唬，我為啥非得繼承這樣一個(gè)類呢，萬(wàn)一已經(jīng)繼承其他基類了呢。大家都知道Java只能繼承一個(gè)類恕刘。

那有沒有一種方案缤谎，既不需要跟Controller耦合，也可以將定義的 異常處理器 應(yīng)用到所有控制器呢褐着？所以注解@ControllerAdvice出現(xiàn)了坷澡，簡(jiǎn)單的說，該注解可以把異常處理器應(yīng)用到所有控制器含蓉，而不是單個(gè)控制器频敛。借助該注解，我們可以實(shí)現(xiàn)：在獨(dú)立的某個(gè)地方馅扣，比如單獨(dú)一個(gè)類斟赚，定義一套對(duì)各種異常的處理機(jī)制，然后在類的簽名加上注解@ControllerAdvice差油，統(tǒng)一對(duì) 不同階段的汁展、不同異常 進(jìn)行處理。這就是統(tǒng)一異常處理的原理厌殉。

注意到上面對(duì)異常按階段進(jìn)行分類，大體可以分成：進(jìn)入Controller前的異常 和Service 層異常侈咕，具體可以參考下圖：

不同階段的異常

目標(biāo)

消滅95%以上的 try catch 代碼塊公罕，以優(yōu)雅的 Assert(斷言) 方式來(lái)校驗(yàn)業(yè)務(wù)的異常情況，只關(guān)注業(yè)務(wù)邏輯耀销，而不用花費(fèi)大量精力寫冗余的 try catch 代碼塊楼眷。

統(tǒng)一異常處理實(shí)戰(zhàn)

在定義統(tǒng)一異常處理類之前，先來(lái)介紹一下如何優(yōu)雅的判定異常情況并拋異常熊尉。

用 Assert(斷言) 替換 throw exception

想必 Assert(斷言) 大家都很熟悉，比如 Spring 家族的org.springframework.util.Assert狰住，在我們寫測(cè)試用例的時(shí)候經(jīng)常會(huì)用到张吉，使用斷言能讓我們編碼的時(shí)候有一種非一般絲滑的感覺，比如：

    @Test
    public void test1() {
        ...
        User user = userDao.selectById(userId);
        Assert.notNull(user, "用戶不存在.");
        ...
    }

    @Test
    public void test2() {
        // 另一種寫法
        User user = userDao.selectById(userId);
        if (user == null) {
            throw new IllegalArgumentException("用戶不存在.");
        }
    }

有沒有感覺第一種判定非空的寫法很優(yōu)雅催植，第二種寫法則是相對(duì)丑陋的 if {...} 代碼塊肮蛹。那么神奇的 Assert.notNull() 背后到底做了什么呢？下面是 Assert 的部分源碼：

public abstract class Assert {
    public Assert() {
    }

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

可以看到创南，Assert 其實(shí)就是幫我們把 if {...} 封裝了一下伦忠，是不是很神奇。雖然很簡(jiǎn)單稿辙，但不可否認(rèn)的是編碼體驗(yàn)至少提升了一個(gè)檔次昆码。那么我們能不能模仿org.springframework.util.Assert，也寫一個(gè)斷言類，不過斷言失敗后拋出的異常不是IllegalArgumentException 這些內(nèi)置異常赋咽，而是我們自己定義的異常旧噪。下面讓我們來(lái)嘗試一下。

Assert

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>斷言對(duì)象<code>obj</code>非空冬耿。如果對(duì)象<code>obj</code>為空舌菜，則拋出異常
     *
     * @param obj 待判斷對(duì)象
     */
    default void assertNotNull(Object obj) {
        if (obj == null) {
            throw newException(obj);
        }
    }

    /**
     * <p>斷言對(duì)象<code>obj</code>非空。如果對(duì)象<code>obj</code>為空亦镶，則拋出異常
     * <p>異常信息<code>message</code>支持傳遞參數(shù)方式日月，避免在判斷之前進(jìn)行字符串拼接操作
     *
     * @param obj 待判斷對(duì)象
     * @param args message占位符對(duì)應(yīng)的參數(shù)列表
     */
    default void assertNotNull(Object obj, Object... args) {
        if (obj == null) {
            throw newException(args);
        }
    }
}

上面的Assert斷言方法是使用接口的默認(rèn)方法定義的，然后有沒有發(fā)現(xiàn)當(dāng)斷言失敗后缤骨，拋出的異常不是具體的某個(gè)異常爱咬，而是交由2個(gè)newException接口方法提供。因?yàn)闃I(yè)務(wù)邏輯中出現(xiàn)的異嘲砥穑基本都是對(duì)應(yīng)特定的場(chǎng)景精拟，比如根據(jù)用戶id獲取用戶信息，查詢結(jié)果為null虱歪，此時(shí)拋出的異撤湟铮可能為UserNotFoundException，并且有特定的異常碼（比如7001）和異常信息“用戶不存在”笋鄙。所以具體拋出什么異常师枣，有Assert的實(shí)現(xiàn)類決定。

看到這里萧落，您可能會(huì)有這樣的疑問践美，按照上面的說法，那豈不是有多少異常情況找岖，就得有定義等量的斷言類和異常類陨倡，這顯然是反人類的，這也沒想象中高明嘛许布。別急兴革，且聽我細(xì)細(xì)道來(lái)。

善解人意的Enum

自定義異常BaseException有2個(gè)屬性蜜唾，即code帖旨、message，這樣一對(duì)屬性灵妨，有沒有想到什么類一般也會(huì)定義這2個(gè)屬性解阅？沒錯(cuò)，就是枚舉類泌霍。且看我如何將 Enum 和 Assert 結(jié)合起來(lái)货抄，相信我一定會(huì)讓你眼前一亮述召。如下：

public interface IResponseEnum {
    int getCode();
    String getMessage();
}
/**
 * <p>業(yè)務(wù)異常</p>
 * <p>業(yè)務(wù)處理時(shí)，出現(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);
    }
}
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;
}

看到這里积暖，有沒有眼前一亮的感覺，代碼示例中定義了兩個(gè)枚舉實(shí)例：

BAD_LICENCE_TYPE怪与、LICENCE_NOT_FOUND夺刑，分別對(duì)應(yīng)了BadLicenceTypeException、LicenceNotFoundException兩種異常分别。以后每增加一種異常情況遍愿，只需增加一個(gè)枚舉實(shí)例即可，再也不用每一種異常都定義一個(gè)異常類了耘斩。然后再來(lái)看下如何使用沼填，假設(shè)LicenceService有校驗(yàn)Licence是否存在的方法，如下：

    /**
     * 校驗(yàn){@link Licence}存在
     * @param licence
     */
    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.");
        }
    }

使用枚舉類結(jié)合(繼承)Assert坞笙，只需根據(jù)特定的異常情況定義不同的枚舉實(shí)例，如上面的BAD_LICENCE_TYPE荚虚、LICENCE_NOT_FOUND薛夜，就能夠針對(duì)不同情況拋出特定的異常（這里指攜帶特定的異常碼和異常消息），這樣既不用定義大量的異常類，同時(shí)還具備了斷言的良好可讀性，當(dāng)然這種方案的好處遠(yuǎn)不止這些视译，請(qǐng)繼續(xù)閱讀后文，慢慢體會(huì)。

注：上面舉的例子是針對(duì)特定的業(yè)務(wù)简十，而有部分異常情況是通用的檬某，比如：服務(wù)器繁忙、網(wǎng)絡(luò)異常螟蝙、服務(wù)器異常恢恼、參數(shù)校驗(yàn)異常、404等胰默，所以有CommonResponseEnum场斑、ArgumentResponseEnum、ServletResponseEnum牵署，其中ServletResponseEnum 會(huì)在后文詳細(xì)說明漏隐。

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

@Slf4j
@Component
@ControllerAdvice
@ConditionalOnWebApplication
@ConditionalOnMissingBean(UnifiedExceptionHandler.class)
public class UnifiedExceptionHandler {
    /**
     * 生產(chǎn)環(huán)境
     */
    private final static String ENV_PROD = "prod"; 

    @Autowired
    private UnifiedMessageSource unifiedMessageSource;

    /**
     * 當(dāng)前環(huán)境
     */
    @Value("${spring.profiles.active}")
    private String profile;
    
    /**
     * 獲取國(guó)際化消息
     *
     * @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è)務(wù)異常
     *
     * @param e 異常
     * @return 異常結(jié)果
     */
    @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 異常結(jié)果
     */
    @ExceptionHandler(value = BaseException.class)
    @ResponseBody
    public ErrorResponse handleBaseException(BaseException e) {
        log.error(e.getMessage(), e);

        return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
    }

    /**
     * Controller上一層相關(guān)異常
     *
     * @param e 異常
     * @return 異常結(jié)果
     */
    @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)) {
            // 當(dāng)為生產(chǎn)環(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());
    }


    /**
     * 參數(shù)綁定異常
     *
     * @param e 異常
     * @return 異常結(jié)果
     */
    @ExceptionHandler(value = BindException.class)
    @ResponseBody
    public ErrorResponse handleBindException(BindException e) {
        log.error("參數(shù)綁定校驗(yàn)異常", e);

        return wrapperBindingResult(e.getBindingResult());
    }

    /**
     * 參數(shù)校驗(yàn)異常，將校驗(yàn)失敗的所有異常組合成一條錯(cuò)誤信息
     *
     * @param e 異常
     * @return 異常結(jié)果
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseBody
    public ErrorResponse handleValidException(MethodArgumentNotValidException e) {
        log.error("參數(shù)綁定校驗(yàn)異常", e);

        return wrapperBindingResult(e.getBindingResult());
    }

    /**
     * 包裝綁定異常結(jié)果
     *
     * @param bindingResult 綁定結(jié)果
     * @return 異常結(jié)果
     */
    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 異常結(jié)果
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ErrorResponse handleException(Exception e) {
        log.error(e.getMessage(), e);

        if (ENV_PROD.equals(profile)) {
            // 當(dāng)為生產(chǎn)環(huán)境, 不適合把具體的異常信息展示給用戶, 比如數(shù)據(jù)庫(kù)異常信息.
            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());
    }
    
}

可以看到奴迅，上面將異常分成幾類青责，實(shí)際上只有兩大類，一類是ServletException、ServiceException脖隶，還記得上文提到的 按階段分類 嗎扁耐，即對(duì)應(yīng) 進(jìn)入Controller前的異常 和 Service 層異常；然后 ServiceException 再分成自定義異常产阱、未知異常婉称。對(duì)應(yīng)關(guān)系如下：

• 進(jìn)入Controller前的異常: handleServletException、handleBindException构蹬、handleValidException

• 自定義異常: handleBusinessException王暗、handleBaseException

• 未知異常: handleException

接下來(lái)分別對(duì)這幾種異常處理器做詳細(xì)說明。

異常處理器說明

handleServletException

一個(gè)http請(qǐng)求怎燥，在到達(dá)Controller前瘫筐，會(huì)對(duì)該請(qǐng)求的請(qǐng)求信息與目標(biāo)控制器信息做一系列校驗(yàn)。這里簡(jiǎn)單說一下：

• NoHandlerFoundException：首先根據(jù)請(qǐng)求Url查找有沒有對(duì)應(yīng)的控制器铐姚，若沒有則會(huì)拋該異常策肝，也就是大家非常熟悉的404異常；

• HttpRequestMethodNotSupportedException：若匹配到了（匹配結(jié)果是一個(gè)列表隐绵，不同的是http方法不同之众，如：Get、Post等）依许，則嘗試將請(qǐng)求的http方法與列表的控制器做匹配棺禾，若沒有對(duì)應(yīng)http方法的控制器，則拋該異常峭跳；

• HttpMediaTypeNotSupportedException：然后再對(duì)請(qǐng)求頭與控制器支持的做比較膘婶，比如content-type請(qǐng)求頭，若控制器的參數(shù)簽名包含注解@RequestBody蛀醉，但是請(qǐng)求的content-type請(qǐng)求頭的值沒有包含application/json悬襟，那么會(huì)拋該異常（當(dāng)然，不止這種情況會(huì)拋這個(gè)異常）拯刁；

• MissingPathVariableException：未檢測(cè)到路徑參數(shù)脊岳。比如url為：/licence/{licenceId}，參數(shù)簽名包含@PathVariable("licenceId")垛玻，當(dāng)請(qǐng)求的url為/licence割捅，在沒有明確定義url為/licence的情況下，會(huì)被判定為：缺少路徑參數(shù)帚桩；

• MissingServletRequestParameterException：缺少請(qǐng)求參數(shù)亿驾。比如定義了參數(shù)@RequestParam("licenceId") String licenceId，但發(fā)起請(qǐng)求時(shí)账嚎，未攜帶該參數(shù)颊乘，則會(huì)拋該異常参淹；

• TypeMismatchException: 參數(shù)類型匹配失敗。比如：接收參數(shù)為L(zhǎng)ong型乏悄，但傳入的值確是一個(gè)字符串浙值，那么將會(huì)出現(xiàn)類型轉(zhuǎn)換失敗的情況，這時(shí)會(huì)拋該異常檩小；

• HttpMessageNotReadableException：與上面的HttpMediaTypeNotSupportedException舉的例子完全相反开呐，即請(qǐng)求頭攜帶了"content-type: application/json;charset=UTF-8"，但接收參數(shù)卻沒有添加注解@RequestBody规求，或者請(qǐng)求體攜帶的 json 串反序列化成 pojo 的過程中失敗了筐付，也會(huì)拋該異常；

• HttpMessageNotWritableException：返回的 pojo 在序列化成 json 過程失敗了阻肿，那么拋該異常瓦戚；

• HttpMediaTypeNotAcceptableException：未知；

• ServletRequestBindingException：未知丛塌；

• ConversionNotSupportedException：未知较解；

• MissingServletRequestPartException：未知；

• AsyncRequestTimeoutException：未知赴邻；

handleBindException

參數(shù)校驗(yàn)異常印衔，后文詳細(xì)說明。

handleValidException

參數(shù)校驗(yàn)異常姥敛，后文詳細(xì)說明奸焙。

handleBusinessException、handleBaseException

處理自定義的業(yè)務(wù)異常彤敛，只是handleBaseException處理的是除了 BusinessException 意外的所有業(yè)務(wù)異常与帆。就目前來(lái)看，這2個(gè)是可以合并成一個(gè)的墨榄。

handleException

處理所有未知的異常玄糟，比如操作數(shù)據(jù)庫(kù)失敗的異常。

注：上面的handleServletException渠概、handleException 這兩個(gè)處理器，返回的異常信息嫂拴，不同環(huán)境返回的可能不一樣播揪，以為這些異常信息都是框架自帶的異常信息，一般都是英文的筒狠，不太好直接展示給用戶看猪狈，所以統(tǒng)一返回SERVER_ERROR代表的異常信息。

異于常人的404

上文提到辩恼，當(dāng)請(qǐng)求沒有匹配到控制器的情況下雇庙，會(huì)拋出NoHandlerFoundException異常谓形，但其實(shí)默認(rèn)情況下不是這樣，默認(rèn)情況下會(huì)出現(xiàn)類似如下頁(yè)面：

Whitelabel Error Page

這個(gè)頁(yè)面是如何出現(xiàn)的呢疆前？實(shí)際上寒跳，當(dāng)出現(xiàn)404的時(shí)候，默認(rèn)是不拋異常的竹椒，而是forward跳轉(zhuǎn)到/error控制器童太，spring也提供了默認(rèn)的error控制器，如下：

BasicErrorController

那么胸完，如何讓404也拋出異常呢书释，只需在properties文件中加入如下配置即可：

spring.mvc.throw-exception-if-no-handler-found=true
spring.resources.add-mappings=false

如此，就可以異常處理器中捕獲它了赊窥，然后前端只要捕獲到特定的狀態(tài)碼爆惧，立即跳轉(zhuǎn)到404頁(yè)面即可

捕獲404對(duì)應(yīng)的異常

統(tǒng)一返回結(jié)果

在驗(yàn)證統(tǒng)一異常處理器之前，順便說一下統(tǒng)一返回結(jié)果锨能。說白了扯再，其實(shí)是統(tǒng)一一下返回結(jié)果的數(shù)據(jù)結(jié)構(gòu)。code腹侣、message 是所有返回結(jié)果中必有的字段叔收，而當(dāng)需要返回?cái)?shù)據(jù)時(shí)，則需要另一個(gè)字段 data 來(lái)表示傲隶。

所以首先定義一個(gè) BaseResponse 來(lái)作為所有返回結(jié)果的基類饺律；

然后定義一個(gè)通用返回結(jié)果類CommonResponse，繼承 BaseResponse跺株，而且多了字段data复濒；

為了區(qū)分成功和失敗返回結(jié)果，于是再定義一個(gè) ErrorResponse乒省；

最后還有一種常見的返回結(jié)果巧颈，即返回的數(shù)據(jù)帶有分頁(yè)信息，因?yàn)檫@種接口比較常見袖扛，所以有必要單獨(dú)定義一個(gè)返回結(jié)果類 QueryDataResponse砸泛，該類繼承自CommonResponse，只是把 data 字段的類型限制為 QueryDdata蛆封，QueryDdata中定義了分頁(yè)信息相應(yīng)的字段唇礁，即totalCount、pageNo惨篱、 pageSize盏筐、records。

其中比較常用的只有 CommonResponse 和 QueryDataResponse砸讳，但是名字又賊鬼死長(zhǎng)琢融，何不定義2個(gè)名字超簡(jiǎn)單的類來(lái)替代呢界牡？于是 R 和 QR 誕生了，以后返回結(jié)果的時(shí)候只需這樣寫：new R<>(data)漾抬、new QR<>(queryData)宿亡。

所有的返回結(jié)果類的定義這里就不貼出來(lái)了

驗(yàn)證統(tǒng)一異常處理

因?yàn)檫@一套統(tǒng)一異常處理可以說是通用的，所有可以設(shè)計(jì)成一個(gè) common包奋蔚，以后每一個(gè)新項(xiàng)目/模塊只需引入該包即可她混。所以為了驗(yàn)證，需要新建一個(gè)項(xiàng)目泊碑，并引入該 common包坤按。項(xiàng)目結(jié)構(gòu)如下：

項(xiàng)目結(jié)構(gòu)

以后只需這樣引入即可

引入common包

主要代碼

下面是用于驗(yàn)證的主要源碼：

@Service
public class LicenceService extends ServiceImpl<LicenceMapper, Licence> {

    @Autowired
    private OrganizationClient organizationClient;

    /**
     * 查詢{@link Licence} 詳情
     * @param licenceId
     * @return
     */
    public LicenceDTO queryDetail(Long licenceId) {
        Licence licence = this.getById(licenceId);
        checkNotNull(licence);

        OrganizationDTO org = ClientUtil.execute(() -> organizationClient.getOrganization(licence.getOrganizationId()));
        return toLicenceDTO(licence, org);
    }

    /**
     * 分頁(yè)獲取
     * @param licenceParam 分頁(yè)查詢參數(shù)
     * @return
     */
    public QueryData<SimpleLicenceDTO> getLicences(LicenceParam licenceParam) {
        String licenceType = licenceParam.getLicenceType();
        LicenceTypeEnum licenceTypeEnum = LicenceTypeEnum.parseOfNullable(licenceType);
        // 斷言, 非空
        ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum);

        LambdaQueryWrapper<Licence> wrapper = new LambdaQueryWrapper<>();
        wrapper.eq(Licence::getLicenceType, licenceType);
        IPage<Licence> page = this.page(new QueryPage<>(licenceParam), wrapper);
        return new QueryData<>(page, this::toSimpleLicenceDTO);
    }

    /**
     * 新增{@link Licence}
     * @param request 請(qǐng)求體
     * @return
     */
    @Transactional(rollbackFor = Throwable.class)
    public LicenceAddRespData addLicence(LicenceAddRequest request) {
        Licence licence = new Licence();
        licence.setOrganizationId(request.getOrganizationId());
        licence.setLicenceType(request.getLicenceType());
        licence.setProductName(request.getProductName());
        licence.setLicenceMax(request.getLicenceMax());
        licence.setLicenceAllocated(request.getLicenceAllocated());
        licence.setComment(request.getComment());
        this.save(licence);

        return new LicenceAddRespData(licence.getLicenceId());
    }

    /**
     * entity -> simple dto
     * @param licence {@link Licence} entity
     * @return {@link SimpleLicenceDTO}
     */
    private SimpleLicenceDTO toSimpleLicenceDTO(Licence licence) {
        // 省略
    }

    /**
     * entity -> dto
     * @param licence {@link Licence} entity
     * @param org {@link OrganizationDTO}
     * @return {@link LicenceDTO}
     */
    private LicenceDTO toLicenceDTO(Licence licence, OrganizationDTO org) {
        // 省略
    }

    /**
     * 校驗(yàn){@link Licence}存在
     * @param licence
     */
    private void checkNotNull(Licence licence) {
        ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);
    }

}

ps: 這里使用的DAO框架是mybatis-plus。
啟動(dòng)時(shí)馒过，自動(dòng)插入的數(shù)據(jù)為：

-- licence
INSERT INTO licence (licence_id,  organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (1, 1, 'user','CustomerPro', 100,5);
INSERT INTO licence (licence_id,  organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (2, 1, 'user','suitability-plus', 200,189);
INSERT INTO licence (licence_id,  organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (3, 2, 'user','HR-PowerSuite', 100,4);
INSERT INTO licence (licence_id,  organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (4, 2, 'core-prod','WildCat Application Gateway', 16,16);

-- organizations
INSERT INTO organization (id, name, contact_name, contact_email, contact_phone)
VALUES (1, 'customer-crm-co', 'Mark Balster', 'mark.balster@custcrmco.com', '823-555-1212');
INSERT INTO organization (id, name, contact_name, contact_email, contact_phone)
VALUES (2, 'HR-PowerSuite', 'Doug Drewry','doug.drewry@hr.com', '920-555-1212');

開始驗(yàn)證

捕獲自定義異常

1. 獲取不存在的 licence 詳情：http://localhost:10000/licence/5臭脓。成功響應(yīng)的請(qǐng)求：licenceId=1

校驗(yàn)非空

捕獲 Licence not found 異常

Licence not found

2.根據(jù)不存在的 licence type 獲取 licence 列表：http://localhost:10000/licence/list?licenceType=ddd「购觯可選的 licence type 為：user来累、core-prod 。

校驗(yàn)非空

捕獲 Bad licence type 異常

Bad licence type

捕獲進(jìn)入 Controller 前的異常

1.訪問不存在的接口：http://localhost:10000/licence/list/ddd

捕獲404異常

2.http 方法不支持：http://localhost:10000/licence

PostMapping

捕獲 Request method not supported 異常

Request method not supported

3.校驗(yàn)異常1：http://localhost:10000/licence/list?licenceType=

getLicences

LicenceParam

捕獲參數(shù)綁定校驗(yàn)異常

licence type cannot be empty

4.校驗(yàn)異常2：post 請(qǐng)求窘奏，這里使用postman模擬嘹锁。

addLicence

LicenceAddRequest

請(qǐng)求url即結(jié)果

捕獲參數(shù)綁定校驗(yàn)異常

注：因?yàn)閰?shù)綁定校驗(yàn)異常的異常信息的獲取方式與其它異常不一樣，所以才把這2種情況的異常從 進(jìn)入 Controller 前的異常 單獨(dú)拆出來(lái)着裹，下面是異常信息的收集邏輯：

異常信息的收集

捕獲未知異常

假設(shè)我們現(xiàn)在隨便對(duì) Licence 新增一個(gè)字段 test领猾，但不修改數(shù)據(jù)庫(kù)表結(jié)構(gòu)，然后訪問：http://localhost:10000/licence/1骇扇。

增加test字段

捕獲數(shù)據(jù)庫(kù)異常

Error querying database

小結(jié)

可以看到摔竿，測(cè)試的異常都能夠被捕獲，然后以 code少孝、message 的形式返回继低。每一個(gè)項(xiàng)目/模塊，在定義業(yè)務(wù)異常的時(shí)候稍走，只需定義一個(gè)枚舉類袁翁，然后實(shí)現(xiàn)接口BusinessExceptionAssert，最后為每一種業(yè)務(wù)異常定義對(duì)應(yīng)的枚舉實(shí)例即可婿脸，而不用定義許多異常類粱胜。使用的時(shí)候也很方便，用法類似斷言盖淡。

擴(kuò)展

在生產(chǎn)環(huán)境年柠，若捕獲到 未知異常 或者 ServletException凿歼，因?yàn)槎际且婚L(zhǎng)串的異常信息褪迟，若直接展示給用戶看冗恨，顯得不夠?qū)I(yè)，于是味赃，我們可以這樣做：當(dāng)檢測(cè)到當(dāng)前環(huán)境是生產(chǎn)環(huán)境掀抹，那么直接返回 "網(wǎng)絡(luò)異常"。

生產(chǎn)環(huán)境返回“網(wǎng)絡(luò)異承乃祝”

可以通過以下方式修改當(dāng)前環(huán)境：

修改當(dāng)前環(huán)境為生產(chǎn)環(huán)境

總結(jié)

使用 斷言 和 枚舉類 相結(jié)合的方式傲武，再配合統(tǒng)一異常處理，基本大部分的異常都能夠被捕獲城榛。為什么說大部分異常揪利，因?yàn)楫?dāng)引入 spring cloud security 后，還會(huì)有認(rèn)證/授權(quán)異常狠持，網(wǎng)關(guān)的服務(wù)降級(jí)異常疟位、跨模塊調(diào)用異常、遠(yuǎn)程調(diào)用第三方服務(wù)異常等喘垂，這些異常的捕獲方式與本文介紹的不太一樣甜刻，不過限于篇幅，這里不做詳細(xì)說明正勒，以后會(huì)有單獨(dú)的文章介紹得院。

另外，當(dāng)需要考慮國(guó)際化的時(shí)候章贞，捕獲異常后的異常信息一般不能直接返回祥绞，需要轉(zhuǎn)換成對(duì)應(yīng)的語(yǔ)言，不過本文已考慮到了這個(gè)阱驾，獲取消息的時(shí)候已經(jīng)做了國(guó)際化映射就谜，邏輯如下：

獲取國(guó)際化消息

最后總結(jié)，全局異常屬于老生長(zhǎng)談的話題里覆，希望這次通過手機(jī)的項(xiàng)目對(duì)大家有點(diǎn)指導(dǎo)性的學(xué)習(xí)丧荐。大家根據(jù)實(shí)際情況自行修改。

也可以采用以下的jsonResult對(duì)象的方式進(jìn)行處理喧枷，也貼出來(lái)代碼.

@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("用戶登錄失效或者登錄超時(shí),請(qǐng)先登錄");
        return jsonResult;
    }

    /**
     *  業(yè)務(wù)異常
     * @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è)務(wù)異常,請(qǐng)聯(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)錯(cuò)誤,請(qǐng)聯(lián)系管理員");
        return jsonResult;
    }
}

寫在最后

歡迎大家關(guān)注我的公眾號(hào)【風(fēng)平浪靜如碼】虹统，海量Java相關(guān)文章，學(xué)習(xí)資料都會(huì)在里面更新隧甚，整理的資料也會(huì)放在里面车荔。

覺得寫的還不錯(cuò)的就點(diǎn)個(gè)贊，加個(gè)關(guān)注唄戚扳！點(diǎn)關(guān)注忧便，不迷路，持續(xù)更新Ｃ苯琛Ｖ樵觥超歌！