背景

筆者所在項(xiàng)目組在搭建一個(gè)全新項(xiàng)目的時(shí)候選用了SpringBoot3.x，項(xiàng)目中應(yīng)用了很多SpringBoot2.x時(shí)代相關(guān)的第三方組件例如baomidou出品的mybatis-plus、dynamic-datasource等。在配置好相關(guān)依賴(lài)、最小啟動(dòng)類(lèi)和配置之后，發(fā)現(xiàn)項(xiàng)目無(wú)法啟動(dòng)。于是根據(jù)啟動(dòng)上下文日志和按行DEBUG找到原因并且在等待組件升級(jí)兼容之前進(jìn)行臨時(shí)性解決。

關(guān)于spring.factories

spring.factories其實(shí)是SpringBoot提供的SPI機(jī)制，底層實(shí)現(xiàn)是基于SpringFactoriesLoader檢索ClassLoader中所有jar（包括ClassPath下的所有模塊）引入的META-INF/spring.factories文件，基于文件中的接口（或者注解）加載對(duì)應(yīng)的實(shí)現(xiàn)類(lèi)并且注冊(cè)到IOC容器。這種方式對(duì)于@ComponentScan不能掃描到的并且想自動(dòng)注冊(cè)到IOC容器的使用場(chǎng)景十分合適，基本上絕大多數(shù)第三方組件甚至部分spring-projects中編寫(xiě)的組件都是使用這種方案。

spring.factories文件的格式大致如下：

# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener

# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer

# Environment Post Processors
org.springframework.boot.env.EnvironmentPostProcessor=\
org.springframework.boot.autoconfigure.integration.IntegrationPropertiesEnvironmentPostProcessor

# Auto Configuration Import Listeners
org.springframework.boot.autoconfigure.AutoConfigurationImportListener=\
org.springframework.boot.autoconfigure.condition.ConditionEvaluationReportAutoConfigurationImportListener

# Auto Configuration Import Filters
org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
org.springframework.boot.autoconfigure.condition.OnBeanCondition,\
org.springframework.boot.autoconfigure.condition.OnClassCondition,\
org.springframework.boot.autoconfigure.condition.OnWebApplicationCondition

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration,\
com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration

通用格式是：接口（或者注解）全類(lèi)名=\接口實(shí)現(xiàn)類(lèi)（或者使用了該注解的類(lèi)）全類(lèi)名-1,\接口實(shí)現(xiàn)類(lèi)（或者使用了該注解的類(lèi)）全類(lèi)名-2,\...接口實(shí)現(xiàn)類(lèi)（或者使用了該注解的類(lèi)）全類(lèi)名-n。spring.factories中最常用的注解是org.springframework.boot.autoconfigure.EnableAutoConfiguration，通過(guò)配置此注解對(duì)應(yīng)的實(shí)現(xiàn)了，底層會(huì)由AutoConfigurationImportSelector對(duì)響應(yīng)的目標(biāo)類(lèi)進(jìn)行加載和自動(dòng)注冊(cè)。通過(guò)閱讀Spring Boot 3.0 Migration Guide得知，spring.factories功能在Spring Boot 2.7已經(jīng)廢棄，并且會(huì)在Spring Boot 3.0移除。

spring.factories被移除后的替代方案

Spring Boot 2.x升級(jí)到Spring Boot 3.0其實(shí)是一個(gè)"破壞性"升級(jí)，目前來(lái)看相對(duì)較大的影響是：

• 必須使用JDK17
• Jakarta EE的引入，導(dǎo)致很多舊的類(lèi)包名稱(chēng)改變
• 部分類(lèi)被徹底移除
• spring-data模塊的所有配置屬性必須使用spring.data前綴，例如spring.redis.host必須更變?yōu)?code>spring.data.redis.host
• spring.factories功能在Spring Boot 2.7已經(jīng)廢棄，在Spring Boot 3.0徹底移除（見(jiàn)下圖）

替代方案比較簡(jiǎn)單，就是在類(lèi)路徑下創(chuàng)建META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，文件的內(nèi)容是：每個(gè)實(shí)現(xiàn)類(lèi)的全類(lèi)名單獨(dú)一行。例如對(duì)于使用了（低版本還沒(méi)適配Spring Boot 3.0）mybatis-plus、dynamic-datasource組件的場(chǎng)景，可以在項(xiàng)目某個(gè)模塊的resources目錄下建立META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，輸入以下內(nèi)容：

com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration

對(duì)于某些社區(qū)熱度比較高的組件近期可以密切關(guān)注其基于Spring Boot 3.0適配的版本發(fā)布，例如mybatis-spring、dubbo等：

這里還沒(méi)詳細(xì)分析META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports的源碼實(shí)現(xiàn)，從描述和文件名來(lái)看，大致看出它在使用上跟原來(lái)的spring.factories文件中編寫(xiě)org.springframework.boot.autoconfigure.EnableAutoConfiguration是相同的

小結(jié)

Spring Boot 3.0的升級(jí)門(mén)檻比較高。目前來(lái)看spring.factories功能的移除個(gè)人認(rèn)為是本次版本升級(jí)的最大影響因素，有可能導(dǎo)致大部分第三方編寫(xiě)過(guò)自動(dòng)注冊(cè)板塊的組件全部失效。當(dāng)然，JDK17也是一個(gè)比較高的門(mén)檻，對(duì)于大部分有歷史包袱的項(xiàng)目如果決定升級(jí)需要極大的容器。建議先觀望和關(guān)注團(tuán)隊(duì)用到的技術(shù)棧或者框架都適配Spring Boot 3.0后再進(jìn)行版本升級(jí)。

到此這篇關(guān)于SpringBoot3.x中spring.factories功能被移除的解決方案的文章就介紹到這了,更多相關(guān)SpringBoot3.x中spring.factories功能移除內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論