概述|背景

報(bào)錯(cuò)發(fā)生背景：在SpringBoot項(xiàng)目中引入Lombok依賴并使用后出現(xiàn)"找不到符號(hào)"的問題。

本文討論在上述背景下發(fā)生的報(bào)錯(cuò)原因和解決辦法，如果僅為了解決BUG不論原因直接通過目錄跳到【解決方法】，如果發(fā)生背景不同請(qǐng)找其他博文尋求解決。

Lombok"找不到符號(hào)"代碼報(bào)錯(cuò)一般位置：

1.代碼： log.info("日志內(nèi)容..");   (使用了注解@Slf4j)

2.代碼：class.getX(); （使用了注解@Data）

報(bào)錯(cuò)解析

1.為什么會(huì)出現(xiàn)“找不到符號(hào)”的報(bào)錯(cuò)呢？

我們遇到這個(gè)報(bào)錯(cuò)時(shí)一般都會(huì)想到：“難道是這個(gè)變量沒有定義？”，但是轉(zhuǎn)念一想我們所引用的是Lombok給我們提供的變量。

所以，我們應(yīng)該去探索Lombok內(nèi)部，我們?cè)谑褂胠og（log.info("日志內(nèi)容..")）變量時(shí)，到底發(fā)生了什么。

實(shí)際上，當(dāng)我們編寫了代碼：log.info("日志內(nèi)容..")，在項(xiàng)目編譯時(shí)遇到log變量，會(huì)發(fā)生的事情是自動(dòng)幫我們補(bǔ)充了代碼：private static final Logger log = LoggerFactory.getLogger(...); 向我們提供了log這個(gè)變量引用。

所以，如果這段“自動(dòng)生成的代碼”沒有自動(dòng)生成的話，那么log變量自然就找不到，報(bào)錯(cuò)"找不到符號(hào)"那也就合理解釋了。

當(dāng)然，代碼：class.getX(); 原理也是一樣的，只不過自動(dòng)生成的代碼不同罷了（這段代碼自動(dòng)生成的是getter函數(shù)）。

2.自動(dòng)生成代碼的時(shí)機(jī)？

當(dāng)我們明白了會(huì)報(bào)“找不到符號(hào)”的原因就是該自動(dòng)生成的代碼沒有生成后，我們就該研究一下“使用lombok時(shí)何時(shí)幫我們自動(dòng)生成代碼”。

我們?cè)谑褂肔ombok時(shí)一般都會(huì)在所在類上添加"lombok相關(guān)注解"。

例如：想使用日志log.info()，我們就該聲明注解"@Slf4j"，當(dāng)想要自動(dòng)給類中所有字段添加Getter和Setter函數(shù)時(shí)就該聲明"@Data"對(duì)吧。

實(shí)際上這些注解就會(huì)成為自動(dòng)生成代碼位置的錨點(diǎn)。

當(dāng)項(xiàng)目代碼編譯時(shí)遇到這些注解，“lombok注解處理器”就會(huì)識(shí)別并生成相應(yīng)代碼。

 3.注解處理器-最終解釋 

最終我們會(huì)把問題聚焦在"注解處理器是否正確加載"的問題上來。

因?yàn)槿绻鹟ombok注解處理器沒有正確加載，那么當(dāng)代碼編譯時(shí)遇到"lombok變量"自然就沒有辦法識(shí)別。

所以，我們下面我們的解決方案就是“讓注解處理器正確工作”。

解決方法

IDEA配置解決

添加VM選項(xiàng)-D jps.track.ap.dependencies=false

這是目前網(wǎng)絡(luò)上熱門的解決方法，但這是一種“回避型”的解決方案，在低版本的SpringBoot項(xiàng)目中有效，但是在高版本3.x中卻不一定有效。

 方法解釋：

1. 首先我們應(yīng)該知道一件事：IDEA（IntelliJ IDEA）自帶了Lombok插件，正常情況下我們?cè)贗DEA中編寫"lombok代碼"是能夠正常運(yùn)行（能正常“自動(dòng)生成代碼”）的。

 2. 當(dāng)我們?cè)陧?xiàng)目Pom中引入了Lombok依賴之后，Lombok 注解處理器會(huì)在編譯時(shí)被 Maven 加載并執(zhí)行，生成 Lombok 注解（如 @Slf4j, @Getter, @Setter）所需要的代碼。但是引入后IDEA自帶的Lombok插件優(yōu)先級(jí)低于Lombok依賴提供的注解處理器。

3. 所以當(dāng)引入Lombok依賴后，Maven代碼編譯時(shí)會(huì)優(yōu)先尋找Lombok依賴提供的注解處理器（追蹤依賴），如果沒有，直接報(bào)錯(cuò)“找不到符號(hào)”，而不是去使用IDEA自帶的插件去生成代碼。

4.上面這個(gè)參數(shù)通過禁用 IDEA 的依賴追蹤機(jī)制，讓編譯過程 忽略 Maven 構(gòu)建時(shí)依賴檢查失敗的情況。這相當(dāng)于告訴 IDEA：“不要強(qiáng)制檢查這些注解處理器的依賴，不要因?yàn)?Maven 的編譯失敗而阻止代碼編譯。”

5. 這樣一來，即使 Maven 沒有找到注解處理器，IDEA 插件仍然可以繼續(xù)使用，并且 Lombok 的相關(guān)代碼仍然可以通過 IDE 插件自動(dòng)生成，從而避免報(bào)錯(cuò)。

總結(jié)：添加VM選項(xiàng)參數(shù)jps.track.ap.dependencies=false，實(shí)際上并沒有解決根本問題，只是有忽略了問題導(dǎo)致的編譯終止，讓編譯繼續(xù)，使得IDEA的lombok插件可以兜底解決。

（并非所有IDE都默認(rèn)支持lombok，所以這種解決方案理論上并不是最好的）

Pom配置插件解決

 合理的解決方案應(yīng)該是我們到Pom文件中配置Lombok的注解處理器。

<!-- pom.xml -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
        <annotationProcessorPaths>
            <path>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>版本號(hào)需要和boot版本匹配</version>
            </path>
        </annotationProcessorPaths>
    </configuration>
</plugin>

配置好記得"clean"一下，然后重新maven編譯，運(yùn)行。 

正確配置后，當(dāng)Maven編譯時(shí)就能正確加載到Lombok注解處理器，使得"lombok代碼"能正常生成，避免報(bào)錯(cuò)發(fā)生。 

值得注意的是：在配置如上插件的時(shí)候lombok版本最好填一下<version>版本號(hào)</version>。

如果不顯示填的話，大概率會(huì)從maven遠(yuǎn)程倉庫調(diào)用下載最新版或穩(wěn)定版的Lombok，自動(dòng)下載的版本不一定和你SpringBoot項(xiàng)目版本兼容，依然會(huì)報(bào)錯(cuò)。

所以，請(qǐng)到spring-boot-dependencies.pom中查看boot項(xiàng)目版本對(duì)應(yīng)的Lombok版本。

文件查找路徑/方法：

最后總結(jié)：

1. 問題的核心就在于Lombok注解處理器沒有被正確加載或配置，導(dǎo)致Maven在編譯過程中報(bào)錯(cuò)，無法生成相應(yīng)的代碼。

2. 盡管使用VM選項(xiàng)參數(shù) -Djps.track.ap.dependencies=false 可以避免報(bào)錯(cuò)，但最好是確保Maven的Lombok注解處理器配置正確，以確保Maven構(gòu)建過程和IDEA插件共同協(xié)作，使得項(xiàng)目在任何構(gòu)建環(huán)境下都能正確生成代碼。

延申出的問題

 當(dāng)我們解決掉了"找不到符號(hào)"的報(bào)錯(cuò)后，很可能再后續(xù)的實(shí)際開發(fā)中會(huì)遇到的BUG：

1. 406：Not Acceptable

2.No converter for [class X] with preset Content-Type 'application/json;charset=UTF-8'].

因?yàn)槌霈F(xiàn)過上面的問題，所以報(bào)錯(cuò)這些很大可能是我們的lombok注解處理器仍然沒有能正常工作。

測試：我們可以手動(dòng)的給報(bào)錯(cuò)所在的類所有字段添加上Getter和Setter方法。

ps: 如果是用IDEA，可以使用快捷鍵【alt + insert】生成。

如果你發(fā)現(xiàn)手動(dòng)添加上Getter和Setter方法后報(bào)錯(cuò)消除，說明還是上面所說的問題。

解決

 直接在IDEA設(shè)置中把注解處理器的獲取方式設(shè)為"從項(xiàng)目類路徑獲取處理器"。

設(shè)置后，應(yīng)用，lean，重新啟動(dòng)！

到此這篇關(guān)于IDEA編寫SpringBoot項(xiàng)目時(shí)使用Lombok報(bào)錯(cuò)“找不到符號(hào)”的原因和解決的文章就介紹到這了,更多相關(guān)IDEA Lombok報(bào)錯(cuò)找不到符號(hào)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！