SpringBoot自定義FailureAnalyzer過程解析
這篇文章主要介紹了SpringBoot自定義FailureAnalyzer,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
官網(wǎng)說明
1.1 創(chuàng)建自己的 FailureAnalyzer
FailureAnalyzer是一種在啟動(dòng)時(shí)攔截 exception 并將其轉(zhuǎn)換為 human-readable 消息的好方法,包含在故障分析中。 Spring Boot 為 application context 相關(guān)的 exceptions,JSR-303 驗(yàn)證等提供了這樣的分析器。實(shí)際上很容易創(chuàng)建自己的。
AbstractFailureAnalyzer是FailureAnalyzer的方便擴(kuò)展,它檢查 exception 中是否存在指定的 exception 類型來處理。你可以從中擴(kuò)展,這樣你的 implementation 只有在它實(shí)際存在時(shí)才有機(jī)會(huì)處理 exception。如果由于某種原因你無法處理 exception,return null給另一個(gè) implementation 一個(gè)處理 exception 的機(jī)會(huì)。
FailureAnalyzer __mplement 將在META-INF/spring.factories中注冊(cè):以下寄存器ProjectConstraintViolationFailureAnalyzer:
org.springframework.boot.diagnostics.FailureAnalyzer=\ com.example.ProjectConstraintViolationFailureAnalyzer
1.2 排除故障 auto-configuration
Spring Boot auto-configuration 盡力'做正確的事',但有時(shí)事情會(huì)失敗,而且很難說出原因。
在 Spring Boot ApplicationContext中有一個(gè)非常有用的ConditionEvaluationReport可用。如果啟用DEBUG logging 輸出,您將看到它。如果使用spring-boot-actuator,還有一個(gè)端點(diǎn),用 JSON 呈現(xiàn)報(bào)表。使用它來調(diào)試 application 并查看 Spring Boot 在運(yùn)行時(shí)添加了哪些 features(以及哪些沒有)。
通過查看 source code 和 Javadoc 可以回答更多問題。一些經(jīng)驗(yàn)法則:
- 查找名為*AutoConfiguration的 classes 并讀取它們的源,特別是@Conditional* 注釋,以找出它們啟用的 features 和何時(shí)啟用。將--debug添加到命令 line 或 System property -Ddebug以在 console 上添加 log 在您的應(yīng)用程序中做出的所有 auto-configuration 決策。在 running Actuator 應(yīng)用程序中,查看autoconfig端點(diǎn)('/autoconfig'或 JMX 等效項(xiàng))以獲取相同的信息。
- 查找@ConfigurationProperties(e.g. ServerProperties)的 classes 并從那里讀取可用的外部 configuration 選項(xiàng)。 @ConfigurationProperties有一個(gè)name屬性,作為外部 properties 的前綴,因此ServerProperties有prefix="server",其 configuration properties 是server.port,server.address等。在 running Actuator 應(yīng)用程序中查看configprops端點(diǎn)。
- 尋找使用RelaxedPropertyResolver從Environment中明確地提取 configuration 值。它通常與前綴一起使用。
- 查找直接綁定到Environment的@Value 注釋。這不如RelaxedPropertyResolver方法靈活,但允許一些輕松的 binding,特別是 OS 環(huán)境變量(因此CAPITALS_AND_UNDERSCORES是period.separated的同義詞)。
- 查找@ConditionalOnExpression 注釋,以響應(yīng) SpEL 表達(dá)式打開和關(guān)閉 features,通常使用從Environment解析的占位符進(jìn)行評(píng)估。
1.3 在啟動(dòng)之前自定義 Environment 或 ApplicationContext
SpringApplication具有ApplicationListeners和ApplicationContextInitializers,用于將自定義應(yīng)用于 context 或環(huán)境。 Spring Boot 加載了許多此類自定義項(xiàng),以便在META-INF/spring.factories內(nèi)部使用。注冊(cè)其他方法的方法不止一種:
- 通過在_運(yùn)行之前調(diào)用SpringApplication上的addListeners和addInitializers方法,以編程方式為每個(gè) application。
- 通過設(shè)置context.initializer.classes或context.listener.classes來聲明每個(gè) application。
- 通過添加META-INF/spring.factories并打包_appar 全部用作 library 的 jar 文件來聲明所有 applications。
SpringApplication向 listeners 發(fā)送一些特殊的ApplicationEvents(甚至在創(chuàng)建 context 之前的一些),然后為ApplicationContext發(fā)布的 events 注冊(cè) listeners
在使用EnvironmentPostProcessor刷新 application context 之前,還可以自定義Environment。每個(gè) implementation 都應(yīng)該在META-INF/spring.factories中注冊(cè):
org.springframework.boot.env.EnvironmentPostProcessor=com.example.YourEnvironmentPostProcessor
implementation 可以加載任意 files 并將它們添加到Environment。例如,此 example 從 classpath 加載 YAML configuration 文件:
public class EnvironmentPostProcessorExample implements EnvironmentPostProcessor { private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader(); @Override public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { Resource path = new ClassPathResource("com/example/myapp/config.yml"); PropertySource<?> propertySource = loadYaml(path); environment.getPropertySources().addLast(propertySource); } private PropertySource<?> loadYaml(Resource path) { if (!path.exists()) { throw new IllegalArgumentException("Resource " + path + " does not exist"); } try { return this.loader.load("custom-resource", path, null); } catch (IOException ex) { throw new IllegalStateException( "Failed to load yaml configuration from " + path, ex); } } }
Environment已經(jīng)準(zhǔn)備好了 Spring Boot 默認(rèn)加載的所有常用 property 源。因此,可以從環(huán)境中獲取文件的位置。此 example 在列表末尾添加custom-resource property 源,以便在任何其他常用位置中定義的 key 優(yōu)先。自定義 implementation 顯然可以定義另一個(gè) order。
雖然在@SpringBootApplication上使用@PropertySource似乎方便且容易在Environment中加載自定義資源,但我們不推薦它為 Spring Boot 在ApplicationContext刷新之前準(zhǔn)備Environment。通過@PropertySource定義的任何 key 都將被加載太晚而不會(huì)對(duì) auto-configuration 產(chǎn)生任何影響。
代碼示例
2.1 指定異常分析
SpringBoot內(nèi)部提供的啟動(dòng)異常分析都是指定具體的異常類型實(shí)現(xiàn)的,最常見的一個(gè)錯(cuò)誤就是端口號(hào)被占用(PortInUseException),雖然SpringBoot內(nèi)部提供一個(gè)這個(gè)異常的啟動(dòng)分析,我們也是可以進(jìn)行替換這一異常分析的,我們只需要?jiǎng)?chuàng)建PortInUseException異常的AbstractFailureAnalyzer,并且實(shí)現(xiàn)類注冊(cè)給SpringBoot即可,實(shí)現(xiàn)自定義如下所示
/** * @author WGR * @create 2019/11/24 -- 23:00 */ public class PortInUseFailureAnalyzer extends AbstractFailureAnalyzer<PortInUseException> { /** * logger instance */ static Logger logger = LoggerFactory.getLogger(PortInUseFailureAnalyzer.class); @Override protected FailureAnalysis analyze(Throwable rootFailure, PortInUseException cause) { logger.error("端口被占用。", cause); return new FailureAnalysis("端口號(hào):" + cause.getPort() + "被占用", "PortInUseException", rootFailure); } }
注冊(cè)啟動(dòng)異常分析
在上面我們只是編寫了指定異常啟動(dòng)分析,我們接下來需要讓它生效,這個(gè)生效方式比較特殊,類似于自定義SpringBoot Starter AutoConfiguration的形式,我們需要在META-INF/spring.factories文件內(nèi)進(jìn)行定義,如下所示:
org.springframework.boot.diagnostics.FailureAnalyzer=\ com.topcheer.activiti.analyzer.PortInUseFailureAnalyzer
那我們?yōu)槭裁葱枰褂眠@種方式定義呢?
項(xiàng)目啟動(dòng)遇到的異常順序不能確定,很可能在Spring IOC并未執(zhí)行初始化之前就出現(xiàn)了異常,我們不能通過@Component注解的形式使其生效,所以SpringBoot提供了通過spring.factories配置文件的方式定義。
測(cè)試:?jiǎn)?dòng)2個(gè)8080端口
啟動(dòng)異常分析繼承關(guān)系
自定義的運(yùn)行異常一般都是繼承自RuntimeException,如果我們定義一個(gè)RuntimeException的異常啟動(dòng)分析實(shí)例會(huì)是什么效果呢?
public class ProjectBootUnifiedFailureAnalyzer extends AbstractFailureAnalyzer<RuntimeException> { /** * logger instance */ static Logger logger = LoggerFactory.getLogger(ProjectBootUnifiedFailureAnalyzer.class); @Override protected FailureAnalysis analyze(Throwable rootFailure, RuntimeException cause) { logger.error("遇到運(yùn)行時(shí)異常", cause); return new FailureAnalysis(cause.getMessage(), "error", rootFailure); } }
將該類也一并注冊(cè)到spring.factories文件內(nèi),如下所示:
org.springframework.boot.diagnostics.FailureAnalyzer=\ com.topcheer.activiti.analyze.PortInUseFailureAnalyzer,\ com.topcheer.activiti.analyze.ProjectBootUnifiedFailureAnalyzer
運(yùn)行項(xiàng)目并測(cè)試端口號(hào)被占用異常我們會(huì)發(fā)現(xiàn),并沒有執(zhí)行ProjectBootUnifiedFailureAnalyzer內(nèi)的analyze方法,而是繼續(xù)執(zhí)行了PortInUseFailureAnalyzer類內(nèi)的方法。
那我們將PortInUseFailureAnalyzer這個(gè)啟動(dòng)分析從spring.factories文件內(nèi)暫時(shí)刪除掉,再來運(yùn)行項(xiàng)目我們會(huì)發(fā)現(xiàn)這時(shí)卻是會(huì)執(zhí)行ProjectBootUnifiedFailureAnalyzer類內(nèi)分析方法。
總結(jié)
根據(jù)本章我們了解了SpringBoot提供的啟動(dòng)異常分析接口以及基本抽象實(shí)現(xiàn)類的運(yùn)作原理,而且啟動(dòng)異常分析存在分析泛型異常類的上下級(jí)繼承關(guān)系,異常子類的啟動(dòng)分析會(huì)覆蓋掉異常父類的啟動(dòng)分析,如果你想包含全部異常的啟動(dòng)分析可以嘗試使用Exception作為AbstractFailureAnalyzer的泛型參數(shù)。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Spring注入Map集合實(shí)現(xiàn)策略模式詳解
這篇文章主要介紹了Spring注入Map集合實(shí)現(xiàn)策略模式詳解,Spring提供通過@Resource注解將相同類型的對(duì)象注入到Map集合,并將對(duì)象的名字作為key,對(duì)象作為value封裝進(jìn)入Map,需要的朋友可以參考下2023-11-11Spring cloud Gateway簡(jiǎn)介及相關(guān)配置方法
這篇文章主要介紹了Spring cloud Gateway簡(jiǎn)介及相關(guān)配置方法,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-04-04Java中forward轉(zhuǎn)發(fā)與redirect重定向的區(qū)別
轉(zhuǎn)發(fā)和重定向都是常用的頁面跳轉(zhuǎn)方式,但在實(shí)現(xiàn)上有一些區(qū)別,本文主要介紹了Java中forward轉(zhuǎn)發(fā)與redirect重定向的區(qū)別,具有一定的參考價(jià)值,感興趣的可以了解一下2023-11-11詳解SpringBoot實(shí)現(xiàn)ApplicationEvent事件的監(jiān)聽與發(fā)布
這篇文章主要為大家詳細(xì)介紹了SpringBoot如何實(shí)現(xiàn)ApplicationEvent事件的監(jiān)聽與發(fā)布,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-03-03