在使用Spring Boot搭建多模塊項(xiàng)目時(shí)，需要使用到自動(dòng)配置功能，把一些通用功能封裝成模塊后通過
META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
文件注冊配置類。然而，最近遇到一個(gè)奇怪的問題：

1.自動(dòng)配置類怎么都不生效

最終排查發(fā)現(xiàn)，問題竟然出在文件路徑上！這篇文章記錄一下問題的經(jīng)過和解決方法。

一、問題描述

項(xiàng)目背景

1.使用版本：Spring Boot 3.x。

2.模塊設(shè)計(jì)：

• framework 模塊：實(shí)現(xiàn)了一個(gè)冪等注解 @Idempotent，通過切面類 IdempotentAspect 攔截方法，并用 IdempotentAutoConfiguration 注入。
• 測試模塊：引入 framework 模塊，測試冪等注解是否生效。

3.配置方式：

• 在 framework 模塊的 src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件中注冊自動(dòng)配置類：

cn.com.h8k.onecoupon.framework.config.IdempotentAutoConfiguration

問題現(xiàn)象

測試時(shí)發(fā)現(xiàn)：

• @Idempotent 注解沒有觸發(fā)切面邏輯。
• 日志里沒有加載 IdempotentAutoConfiguration 的相關(guān)信息。
• 即使加了調(diào)試代碼和日志，仍然沒有任何效果。

二、排查過程

1. 確認(rèn)自動(dòng)配置文件路徑和內(nèi)容

首先檢查了 AutoConfiguration.imports 文件的位置和內(nèi)容是否正確：

• 路徑：src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
• 內(nèi)容：確認(rèn)類名拼寫無誤。

但是問題依然存在，懷疑是自動(dòng)配置類根本沒有被 Spring Boot 加載。

2. 驗(yàn)證自動(dòng)配置類是否加載

在自動(dòng)配置類 IdempotentAutoConfiguration 中添加靜態(tài)代碼塊或日志輸出，判斷是否加載：

@AutoConfiguration
public class IdempotentAutoConfiguration {
    static {
        System.out.println("IdempotentAutoConfiguration 加載成功！");
    }
}

重新啟動(dòng)項(xiàng)目后，依然沒有看到任何輸出。說明自動(dòng)配置類根本沒有被 Spring Boot 掃描到。

3. 檢查 META-INF 文件夾的實(shí)際路徑

仔細(xì)查看項(xiàng)目結(jié)構(gòu)時(shí)，發(fā)現(xiàn) META-INF/spring 文件夾顯示為 META-INF.spring，這引起了注意。

原因分析：
在 IntelliJ IDEA 中，新建文件夾 META-INF/spring 后，IDEA 默認(rèn)顯示為 META-INF.spring。如果直接在這個(gè)路徑下創(chuàng)建文件，實(shí)際路徑就會(huì)變成錯(cuò)誤的 META-INF.spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports。

最終確認(rèn)：文件路徑寫錯(cuò)了，Spring Boot 無法找到自動(dòng)配置文件。

4. 修正路徑并驗(yàn)證

將文件移動(dòng)到正確路徑 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 后，重新啟動(dòng)項(xiàng)目，問題解決！

日志中成功顯示：

Positive matches:
-----------------
IdempotentAutoConfiguration

測試時(shí)，@Idempotent 注解也正常生效，切面邏輯開始運(yùn)行。

結(jié)論 TL;DR

切記，在resources中創(chuàng)建多級(jí)文件夾(new directory)的時(shí)候，用/進(jìn)行分割父子文件夾，別用.來分割了

到此這篇關(guān)于Spring Boot3.x自動(dòng)配置不生效的排查與解決：IDEA 文件夾命名導(dǎo)致的問題的文章就介紹到這了,更多相關(guān)Spring Boot自動(dòng)配置不生效內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論