SpringBoot詳細列印啟動時異常堆疊資訊

springboot在專案啟動時如果遇到異常並不能友好的列印出具體的堆疊錯誤資訊，我們只能檢視到簡單的錯誤訊息，以致於並不能及時解決發生的問題，針對這個問題springboot提供了故障分析儀的概念（failure-analyzer），內部根據不同型別的異常提供了一些實現，我們如果想自定義該怎麼去做？

springboot提供了啟動異常分析介面failureanalyzer，該介面位於org.springframework.boot.diagnosticspackage內。內部僅提供乙個分析的方法，原始碼如下所示：

@functionalinte***ce
public inte***ce failureanalyzer , or  if no analysis
* was possible.
* @param failure the failure
* @return the analysis or 
*/failureanalysis analyze(throwable failure);
}

該介面會把遇到的異常物件例項throwable failure交付給實現類，實現類進行自定義處理。

abstractfailureanalyzer是failureanalyzer的基礎實現抽象類，實現了failureanalyzer定義的analyze(throwable failure)方法，並提供了乙個指定異常型別的抽象方法analyze(throwable rootfailure, t cause)，原始碼如下所示：

public abstract class abstractfailureanalyzerimplements failureanalyzer 
return null;
}/**
* returns an analysis of the given , or  if no
* analysis was possible.
* @param rootfailure the root failure passed to the analyzer
* @param cause the actual found cause
* @return the analysis or 
*/protected abstract failureanalysis analyze(throwable rootfailure, t cause);
/*** return the cause type being handled by the analyzer. by default the class generic
* is used.
* @return the cause type
*/@suppresswarnings("unchecked")
protected class extends t> getcausetype() 
@suppresswarnings("unchecked")
protected final e findcause(throwable failure, classtype) 
failure = failure.getcause();
}return null;}}

通過abstractfailureanalyzer原始碼我們可以看到，它在實現於failureanalyzer的介面方法內進行了特殊處理，根據getcausetype()方法獲取當前類定義的第乙個泛型型別，也就是我們需要分析的指定異常型別。

獲取泛型異常型別後根據方法findcause判斷throwable是否與泛型異常型別匹配，如果匹配直接返回給springboot進行註冊處理。

springboot內部通過實現abstractfailureanalyzer抽象類定義了一系列的針對性異常型別的啟動分析，如下圖所示：

springboot內部提供的啟動異常分析都是指定具體的異常型別實現的，最常見的乙個錯誤就是埠號被占用（portinuseexception），雖然springboot內部提供乙個這個異常的啟動分析，我們也是可以進行替換這一異常分析的，我們只需要建立portinuseexception異常的abstractfailureanalyzer，並且實現類註冊給springboot即可，實現自定義如下所示：

/**
* 埠號被占用異常啟動分析
* * @author 恆宇少年
*/public class portinusefailureanalyzer extends abstractfailureanalyzer
}

在上面我們只是編寫了指定異常啟動分析，我們接下來需要讓它生效，這個生效方式比較特殊，類似於自定義springboot starter autoconfiguration的形式，我們需要在meta-inf/spring.factories檔案內進行定義，如下所示：

org.springframework.boot.diagnostics.failureanalyzer=\ org.minbox.chapter.springboot.failure.analyzer.portinusefailureanalyzer

那我們為什麼需要使用這種方式定義呢？專案啟動遇到的異常順序不能確定，很可能在spring ioc並未執行初始化之前就出現了異常，我們不能通過@component註解的形式使其生效，所以springboot提供了通過spring.factories配置檔案的方式定義。

自定義的執行異常一般都是繼承自runtimeexception，如果我們定義乙個runtimeexception的異常啟動分析例項會是什麼效果呢？

/**
* 專案啟動執行時異常統一啟動分析
* * @author 恆宇少年
*/public class projectbootunifiedfailureanalyzer extends abstractfailureanalyzer
}

將該類也一併註冊到spring.factories檔案內，如下所示：

org.springframework.boot.diagnostics.failureanalyzer=\ org.minbox.chapter.springboot.failure.analyzer.portinusefailureanalyzer,\ org.minbox.chapter.springboot.failure.analyzer.projectbootunifiedfailureanalyzer

執行專案並測試埠號被占用異常我們會發現，並沒有執行projectbootunifiedfailureanalyzer內的analyze方法，而是繼續執行了portinusefailureanalyzer類內的方法。

那我們將portinusefailureanalyzer這個啟動分析從spring.factories檔案內暫時刪除掉，再來執行專案我們會發現這時卻是會執行projectbootunifiedfailureanalyzer類內分析方法。

根據本章我們了解了springboot提供的啟動異常分析介面以及基本抽象實現類的運作原理，而且啟動異常分析存在分析泛型異常類的上下級繼承關係，異常子類的啟動分析會覆蓋掉異常父類的啟動分析，如果你想包含全部異常的啟動分析可以嘗試使用exception作為abstractfailureanalyzer的泛型引數。

SpringBoot詳細列印啟動時異常堆疊資訊

SpringBoot詳細列印啟動時異常堆疊資訊

SpringBoot中Mybatis列印sql日誌

spring boot 配置不占用埠方式啟動

SpringBoot詳細列印啟動時異常堆疊資訊

SpringBoot詳細列印啟動時異常堆疊資訊

SpringBoot中Mybatis列印sql日誌

spring boot 配置不占用埠方式啟動

相關推薦