場(chǎng)景說(shuō)明

原來(lái)的SpringBoot 自動(dòng)配置功能如下，主要是創(chuàng)建spring.factories 文件，在里面寫(xiě)入你要自動(dòng)配置的類(lèi)全路徑。

文件內(nèi)容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.bigshow.starter.sse.config.SseAutoConfigure

其中 SseAutoConfigure 就是你要自動(dòng)化配置的類(lèi)：

/**
 * SSE服務(wù)端 核心配置類(lèi)
 *
 * @author BigShow
 */
@Configuration
@ConditionalOnProperty(prefix = "bigshow.sse", value = "enable", havingValue = "true")
@EnableConfigurationProperties({SseProperties.class})
public class SseAutoConfigure implements InitializingBean {

    @Lazy
    @Resource
    private ApplicationContext applicationContext;

    @Bean
    @ConditionalOnMissingBean
    SseServer sseServer() {
        return new SseServer();
    }


    @Bean
    @ConditionalOnMissingBean
    public SseBusinessService sseBusinessService() {
        return new DefaultSseBusinessServiceImpl();
    }
}

該項(xiàng)目打包 mvn clean install 或者 mvn deploy 發(fā)布到maven倉(cāng)庫(kù)中去，

其他應(yīng)用項(xiàng)目直接引入然后在application.yml文件中配置一下即可使用此功能。

    <dependency>
        <groupId>com.bigshow</groupId>
        <artifactId>sse-spring-boot-starter</artifactId>
        <version>1.0</version>
    </dependency>

bigshow:
  sse:
    enable: true

但是！從SpringBoot3開(kāi)始，這樣 spring.factories 自動(dòng)配置功能不生效了。

原因是：官方做出了改變！

原因說(shuō)明

Spring Boot 3采用了基于META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件的自動(dòng)配置加載策略，替代了過(guò)去的spring.factories方式

注意：文件名字就是 “org.springframework.boot.autoconfigure.AutoConfiguration.imports”

這個(gè)文件里面的內(nèi)容就是你要配置類(lèi)的全路徑名稱(chēng)即可：

com.example.autoconfig.MyAutoConfiguration1
com.example.autoconfig.MyAutoConfiguration2
com.example.autoconfig.MyAutoConfiguration3
...

看到這里不禁要問(wèn)：這和之前的有什么區(qū)別 ，感覺(jué)就是配置文件名稱(chēng)不一樣了 ? !

從表面上看，確實(shí)是這樣，但是這為未來(lái)提供了很大的意義：

原來(lái)的 spring.factories 文件里面可以做很多其他的事情，它是一個(gè) 多功能的配置文件，采用鍵值對(duì)形式，內(nèi)部可以聲明多種類(lèi)型的自動(dòng)加載內(nèi)容，不只是自動(dòng)配置類(lèi)，還包括：

• 監(jiān)聽(tīng)器（ApplicationListener）
• 環(huán)境后置處理器（EnvironmentPostProcessor）
• ApplicationContextInitializer
• FactoryBean 等等

所以確實(shí)，spring.factories文件長(zhǎng)期承擔(dān)了很多職責(zé)，Spring Boot3通過(guò)拆分專(zhuān)用文件來(lái)讓自動(dòng)配置更清晰規(guī)范，也更適合未來(lái)演進(jìn)，

Spring Boot 3 對(duì) spring.factories 中的自動(dòng)配置部分做了拆分，但 其他功能和擴(kuò)展點(diǎn)并沒(méi)有全部拋棄 spring.factories，而是逐步遷移或沿用不同的新機(jī)制。

簡(jiǎn)單總結(jié)過(guò)去和現(xiàn)在的配置文件方式對(duì)比：

未來(lái)趨勢(shì)和新機(jī)制

• Spring 團(tuán)隊(duì)計(jì)劃逐步拆解 spring.factories 的過(guò)度職責(zé)，將不同的擴(kuò)展分別拆分到更明確、可維護(hù)的專(zhuān)用文件或基于 Java 模塊系統(tǒng)（JPMS）的機(jī)制中。
• 部分機(jī)制將使用 spring.autoconfigure 專(zhuān)用資源文件，其他高級(jí)擴(kuò)展會(huì)結(jié)合 SPI（ServiceLoader機(jī)制）、spring/org/springframework/boot 下的專(zhuān)用目錄，或者全新注解驅(qū)動(dòng)方式實(shí)現(xiàn)。
• 但目前絕大多數(shù)非自動(dòng)配置的擴(kuò)展仍舊通過(guò) spring.factories 管理。

如何遷移老的starter

原自定義的starter工程：

刪除META-INF/spring.factories文件或者停止使用它。

在META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中添加你的自動(dòng)配置類(lèi)路徑，例如：

com.bigshow.starter.sse.config.SseAutoConfigure

自動(dòng)配置類(lèi)里使用@AutoConfiguration替換原來(lái)@Configuration和 （Spring Boot 3 官方推薦使用@AutoConfiguration替代以前的@Configuration + @ConditionalOn等組合注解）

@AutoConfiguration
@ConditionalOnProperty(prefix = "bigshow.sse", value = "enable", havingValue = "true")
@EnableConfigurationProperties({SseProperties.class})
public class SseAutoConfigure implements InitializingBean {
...
}

這里簡(jiǎn)單說(shuō)明下：@Configuration 換成 @AutoConfiguration 好處

1. 明確標(biāo)識(shí)自動(dòng)配置類(lèi)身份
2. 增強(qiáng)編譯期和IDE的支持
3. 更精準(zhǔn)的自動(dòng)配置加載機(jī)制
4. 未來(lái)擴(kuò)展和模塊化支持更友好
5. 避免潛在的類(lèi)路徑掃描沖突
6. 結(jié)合條件注解效果更可靠

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論