1. 為什么相對路徑在Eclipse里總跟你捉對廝殺剛?cè)胄心菚何覍懥艘粋€讀取配置文件的Java小工具在命令行里用java -jar跑得好好的一挪到Eclipse里點Run As立刻甩給我一個FileNotFoundException。當(dāng)時我盯著控制臺那行紅字心里只有一個念頭同一個文件同一個路徑怎么換個地方就翻臉不認(rèn)人了這個問題的根源在于Eclipse啟動Java程序時的工作目錄Working Directory和你想象的不一樣。命令行里你cd到哪個目錄工作目錄就是哪個但在Eclipse里默認(rèn)的工作目錄是項目根目錄而不是src目錄也不是你放資源文件的那個子目錄。很多人寫相對路徑時腦子里想的是相對于我的Java文件但JVM認(rèn)的是相對于進(jìn)程啟動時的工作目錄這兩者經(jīng)常對不上。更麻煩的是Eclipse的項目結(jié)構(gòu)本身就有src、bin或target/classes、項目根目錄這幾層資源文件放哪兒、編譯后跑到哪兒每一步都可能讓相對路徑失效。所以這篇內(nèi)容我打算把這件事徹底講透從工作目錄的確認(rèn)方法到資源加載的正確姿勢再到打包成JAR后路徑行為的變化最后給出一套我自己一直在用的、能同時兼容Eclipse內(nèi)運行和打包后運行的路徑處理方案。適合誰看如果你寫過new File(config.properties)然后在Eclipse里報錯或者你的程序在IDE里正常、打包后就找不到文件那這篇就是寫給你的。不需要你有多深的Java功底但至少要能看懂基本的文件IO代碼。2. 先搞清楚Eclipse到底把哪個目錄當(dāng)成了家在動手改代碼之前必須先確認(rèn)一件事你的程序在Eclipse里運行時工作目錄到底是哪個。這個問題不搞清楚后面所有關(guān)于相對路徑的討論都是空中樓閣。2.1 三種確認(rèn)工作目錄的實操方法最直接的辦法是在代碼里打印一行public class WorkDirDemo { public static void main(String[] args) { System.out.println(工作目錄: System.getProperty(user.dir)); } }在Eclipse里Run As → Java Application控制臺輸出的就是當(dāng)前工作目錄。我實測過很多次默認(rèn)情況下輸出的是項目根目錄的絕對路徑比如D:\workspace\MyProject。注意是項目根目錄不是src也不是bin。第二種方法是通過Run Configuration查看。右鍵你的Java文件 → Run As → Run Configurations → 在Arguments選項卡里找到Working directory這一欄。這里默認(rèn)勾選的是Default而Default指向的就是項目根目錄。你可以手動改成Other并指定任意目錄但改完之后你的相對路徑基準(zhǔn)就變了團(tuán)隊里其他人如果沒同步這個配置行為就會不一致。第三種方法更直觀在項目根目錄下放一個測試文件比如test.txt然后寫new File(test.txt).exists()返回true就說明工作目錄確實是項目根目錄。如果返回false那說明你的Run Configuration被人改過或者項目用了Maven/Gradle的某些插件改變了工作目錄。提示Maven項目在Eclipse里通過mvn exec:java運行時工作目錄默認(rèn)也是項目根目錄但如果你在pom.xml里配置了workingDirectory參數(shù)行為可能不同。這一點在排查時要特別留意。2.2 為什么Eclipse要這樣設(shè)計很多人覺得Eclipse這個默認(rèn)值很坑但其實它有自己的邏輯。項目根目錄是項目所有內(nèi)容的最大公約數(shù)——src下面是源碼resources下面是資源lib下面是依賴從根目錄出發(fā)你可以用統(tǒng)一的相對路徑訪問到項目內(nèi)的任何東西。如果默認(rèn)工作目錄設(shè)成src那訪問項目根目錄下的pom.xml就得寫../pom.xml反而更別扭。問題在于大多數(shù)初學(xué)者寫相對路徑時參照系是自己的Java文件所在位置而不是項目根目錄。比如Java文件在src/com/example/下資源文件也在同一層很多人就寫new File(config.properties)心里想的是就在我旁邊啊。但JVM從項目根目錄出發(fā)去找自然找不到。這里有個生活化的類比你站在一棟大樓的門口項目根目錄有人告訴你去三樓找302房間相對路徑你能找到。但如果有人告訴你去我辦公室旁邊的會議室相對于某個具體房間的路徑而你根本不知道我辦公室在哪一層那就抓瞎了。Eclipse默認(rèn)給你的參照系是大樓門口而你的代碼里寫的參照系可能是某個具體房間。2.3 一個容易忽略的細(xì)節(jié)不同運行方式的工作目錄差異同一個項目在Eclipse里用不同方式啟動工作目錄可能不一樣。我整理了一個對照表啟動方式默認(rèn)工作目錄備注Run As → Java Application項目根目錄最常見Run As → JUnit Test項目根目錄與Java Application一致Debug As → Java Application項目根目錄與Run一致Maven buildexec:java項目根目錄除非pom中另行配置外部終端 java -jar執(zhí)行命令時所在目錄與Eclipse無關(guān)這張表的關(guān)鍵結(jié)論是在Eclipse內(nèi)部工作目錄基本穩(wěn)定為項目根目錄。所以只要你的相對路徑以項目根目錄為基準(zhǔn)來寫在IDE內(nèi)運行就不會出問題。但打包成JAR拿到外面跑工作目錄就變成了你敲java -jar命令時所在的目錄這時候原來的相對路徑很可能失效。這就是為什么IDE里好好的打包就崩。3. 資源文件到底該放在哪一層工作目錄搞清楚了下一個問題就是我的配置文件、圖片、模板這些資源到底應(yīng)該放在項目的哪個位置放錯位置路徑怎么寫都是錯。3.1 src目錄下的資源會被編譯進(jìn)classpath如果你把config.properties直接放在src目錄下或者src/main/resources下Maven項目Eclipse在編譯時會把非Java文件復(fù)制到bin目錄Maven項目是target/classes。這意味著這些文件在運行時是classpath資源而不是普通文件系統(tǒng)里的文件。這兩者的區(qū)別很關(guān)鍵。classpath資源要用getClass().getResourceAsStream()或getClassLoader().getResourceAsStream()來讀取不能用new File()。因為打包成JAR后classpath資源被壓縮在JAR包里文件系統(tǒng)路徑根本訪問不到。我見過太多人把配置文件放在src下然后用new File(src/config.properties)去讀在Eclipse里能跑通因為工作目錄是項目根目錄src/config.properties確實存在但打包后JAR里沒有src這個目錄結(jié)構(gòu)直接報錯。這種假成功最害人因為它讓你誤以為路徑寫對了。3.2 項目根目錄下的文件是真正的文件系統(tǒng)路徑如果你把資源放在項目根目錄下比如D:\workspace\MyProject\config.properties那它就是一個普通的文件系統(tǒng)文件。用new File(config.properties)可以訪問因為工作目錄就是項目根目錄。但打包成JAR后這個文件不會自動被打進(jìn)去除非你在構(gòu)建腳本里顯式配置。而且即使打進(jìn)去了JAR內(nèi)的文件也不能用new File()訪問。所以我的建議很明確需要隨程序分發(fā)的資源一律放在src/main/resources下用classpath方式讀取只有那些明確不打包、由外部提供的配置文件才放在項目根目錄或外部目錄用文件系統(tǒng)方式讀取。3.3 一個真實項目的目錄結(jié)構(gòu)示例假設(shè)你在做一個數(shù)據(jù)導(dǎo)出工具需要讀取一個模板文件template.xlsx和一個配置文件app.properties。我推薦的目錄結(jié)構(gòu)是這樣的MyProject/ ├── src/ │ └── main/ │ ├── java/ │ │ └── com/example/ │ │ └── Exporter.java │ └── resources/ │ ├── template.xlsx │ └── app.properties ├── pom.xml └── output/ 運行時生成的目錄不納入版本控制template.xlsx和app.properties都放在resources下編譯后它們會出現(xiàn)在target/classes或Eclipse的bin目錄下運行時通過classpath讀取。output目錄是程序運行時創(chuàng)建的用相對路徑output/訪問因為工作目錄是項目根目錄所以會創(chuàng)建在項目根目錄下。打包后如果工作目錄變了output也會跟著變這通常是符合預(yù)期的——輸出文件本來就該跟著運行位置走。4. 讀取資源的三種姿勢與各自的適用場景知道了資源放哪兒接下來就是怎么讀。Java里讀取資源有好幾種寫法每種的行為邊界都不一樣用錯了就會踩坑。4.1 用getResourceAsStream讀取classpath資源這是讀取打包資源的標(biāo)準(zhǔn)做法InputStream is Exporter.class.getResourceAsStream(/template.xlsx);注意路徑前面的斜杠。getResourceAsStream方法在Class對象上調(diào)用時如果路徑以/開頭表示從classpath根目錄開始找如果不以/開頭表示從當(dāng)前類所在的包目錄開始找。這個規(guī)則很容易搞混我的習(xí)慣是一律加斜杠從根目錄找這樣路徑含義最明確。對應(yīng)的getClassLoader().getResourceAsStream()方法則不能以斜杠開頭因為ClassLoader本來就從根目錄找。這兩種寫法混用是常見錯誤// 正確Class方式加斜杠 Exporter.class.getResourceAsStream(/template.xlsx); // 正確ClassLoader方式不加斜杠 Exporter.class.getClassLoader().getResourceAsStream(template.xlsx); // 錯誤ClassLoader方式加斜杠返回null Exporter.class.getClassLoader().getResourceAsStream(/template.xlsx);我實測過最后那種寫法不會拋異常而是靜默返回null然后你在后面用的時候才報NullPointerException排查起來很費勁。所以記住這個口訣Class加斜杠Loader不加斜杠。4.2 用Files或FileInputStream讀取文件系統(tǒng)資源如果資源確實在文件系統(tǒng)上比如用戶自己指定的配置文件那就用標(biāo)準(zhǔn)文件IOPath configPath Paths.get(config, app.properties); try (InputStream is Files.newInputStream(configPath)) { Properties props new Properties(); props.load(is); }這里的config/app.properties是相對于工作目錄的路徑。在Eclipse里工作目錄是項目根目錄所以它會去找項目根目錄/config/app.properties。如果你希望這個路徑更可控可以在程序啟動時通過啟動參數(shù)傳入絕對路徑或者用System.getProperty(user.dir)拼出絕對路徑再操作。4.3 兩種方式的對比與選擇依據(jù)對比維度classpath方式文件系統(tǒng)方式資源位置src/main/resources項目根目錄或外部目錄打包后是否可用可用資源在JAR內(nèi)需額外配置且不能用File直接讀JAR內(nèi)文件路徑基準(zhǔn)classpath根工作目錄適合場景程序內(nèi)置的模板、默認(rèn)配置用戶自定義配置、運行時生成的文件修改是否需要重新打包需要不需要選擇邏輯很簡單跟著程序走的用classpath跟著用戶或環(huán)境走的用文件系統(tǒng)。模板文件、默認(rèn)配置、圖標(biāo)這些跟著程序走數(shù)據(jù)庫連接串、日志輸出目錄這些跟著環(huán)境走。注意如果你的程序既要能在Eclipse里跑又要能打包成JAR跑那所有內(nèi)置資源都必須用classpath方式讀取。用new File(src/...)這種寫法在Eclipse里能跑通但打包后必掛這是最典型的IDE陷阱。5. 打包成JAR后路徑行為的變化與應(yīng)對Eclipse里跑通只是第一步真正考驗路徑處理的是打包之后。我見過太多項目在IDE里一切正常一打成JAR就各種找不到文件。這一節(jié)把打包后的變化講清楚。5.1 JAR內(nèi)文件不能用File訪問這是最核心的一條規(guī)則。JAR本質(zhì)上是一個ZIP壓縮包里面的文件沒有獨立的文件系統(tǒng)路徑。new File(template.xlsx)在JAR運行時會在工作目錄下找這個文件而不是在JAR包內(nèi)找。所以如果你的資源在JAR里必須用getResourceAsStream。我做過一個實驗把template.xlsx放在src/main/resources下打包成JAR然后在JAR所在目錄運行java -jar app.jar。用new File(template.xlsx)返回false用getResourceAsStream(/template.xlsx)能正常讀到內(nèi)容。結(jié)論很明確JAR內(nèi)資源只能用流的方式讀。5.2 工作目錄變成命令執(zhí)行位置在Eclipse里工作目錄是項目根目錄打包后你在哪個目錄敲java -jar工作目錄就是哪個。比如你把JAR放在D:\dist\下在D:\dist\目錄執(zhí)行命令工作目錄就是D:\dist\。這時候如果代碼里有new File(output/result.txt)文件會生成在D:\dist\output\下而不是項目根目錄。這個行為本身是合理的——輸出文件跟著運行位置走符合直覺。但如果你在代碼里硬編碼了new File(src/output/result.txt)這種路徑打包后就會在D:\dist\src\output\下找大概率不存在。所以任何包含src的硬編碼路徑都是危險信號看到就應(yīng)該改掉。5.3 用啟動參數(shù)顯式指定路徑基準(zhǔn)如果你希望程序的工作目錄不受啟動位置影響可以在啟動腳本里顯式切換目錄cd /path/to/app java -jar app.jar或者在Java代碼里用絕對路徑String baseDir System.getProperty(app.home, System.getProperty(user.dir)); Path outputDir Paths.get(baseDir, output);然后在啟動時通過-Dapp.home/your/path傳入基準(zhǔn)目錄。這樣無論從哪里啟動輸出路徑都是可控的。這個技巧在部署服務(wù)時特別有用我自己的項目基本都會留一個這樣的配置項。6. 一套兼容Eclipse與JAR的路徑處理方案講了這么多原理和坑最后給出一套我自己一直在用的方案。核心思路是內(nèi)置資源走classpath外部文件走可配置的基準(zhǔn)目錄絕不硬編碼src。6.1 資源加載工具類的實現(xiàn)public final class ResourceLoader { private ResourceLoader() {} /** * 讀取classpath資源兼容Eclipse與JAR運行 */ public static InputStream loadClasspath(String path) { String normalized path.startsWith(/) ? path : / path; InputStream is ResourceLoader.class.getResourceAsStream(normalized); if (is null) { throw new IllegalArgumentException(classpath資源不存在: normalized); } return is; } /** * 獲取外部文件路徑基準(zhǔn)目錄可通過系統(tǒng)屬性覆蓋 */ public static Path resolveExternal(String relativePath) { String base System.getProperty(app.home, System.getProperty(user.dir)); return Paths.get(base, relativePath); } }這個工具類有兩個方法loadClasspath用于讀取打包在JAR內(nèi)的資源resolveExternal用于處理外部文件。resolveExternal的基準(zhǔn)目錄默認(rèn)是工作目錄但可以通過-Dapp.homexxx覆蓋部署時很靈活。6.2 在Eclipse中驗證的完整步驟在src/main/resources下放一個app.properties內(nèi)容隨便寫幾行。寫一個測試類調(diào)用ResourceLoader.loadClasspath(app.properties)確認(rèn)能讀到。在項目根目錄下創(chuàng)建一個data目錄調(diào)用ResourceLoader.resolveExternal(data/test.txt)確認(rèn)路徑指向項目根目錄/data/test.txt。在Eclipse里Run As → Java Application觀察輸出。6.3 打包后驗證的完整步驟用Maven執(zhí)行mvn clean package確認(rèn)target下生成了JAR。把JAR復(fù)制到一個干凈目錄比如D:\test-run\。在D:\test-run\下執(zhí)行java -jar app.jar確認(rèn)classpath資源能讀到外部文件生成在D:\test-run\data\下。再執(zhí)行java -Dapp.homeD:\custom -jar app.jar確認(rèn)外部文件生成在D:\custom\data\下。這兩步驗證做完基本可以保證路徑處理在IDE和打包后行為一致。我每次新建項目都會跑一遍這個流程花不了幾分鐘但能省掉后面大量的排查時間。6.4 幾個我踩過的坑和對應(yīng)經(jīng)驗第一個坑用getResource返回null時不報錯。getResourceAsStream找不到資源返回null后面用的時候才炸。所以我在工具類里加了判空并拋異常讓問題在源頭暴露。第二個坑路徑中的空格和中文。Windows下項目路徑帶空格時new File(my folder/config.txt)一般沒問題但如果用URL方式獲取路徑再轉(zhuǎn)File空格會被編碼成%20導(dǎo)致找不到文件。解決辦法是統(tǒng)一用Paths.get()處理不要手動拼URL。第三個坑Eclipse的clean操作。有時候改了資源文件Eclipse沒有自動復(fù)制到bin目錄導(dǎo)致讀到的還是舊內(nèi)容。執(zhí)行Project → Clean可以強(qiáng)制重新編譯復(fù)制。這個坑很隱蔽因為代碼沒變但資源內(nèi)容不對容易懷疑人生。第四個坑Maven的resource filtering。如果你在pom.xml里開啟了resource filteringapp.properties里的${...}占位符會被替換有時候會意外破壞文件內(nèi)容。如果不需要這個功能建議關(guān)閉或者把不需要過濾的資源排除掉。7. 關(guān)于相對路徑我現(xiàn)在的工作習(xí)慣寫了這么多年Java關(guān)于路徑處理我總結(jié)了幾條自己的規(guī)矩基本沒再在這上面翻過車。第一條代碼里永遠(yuǎn)不出現(xiàn)src。只要看到new File(src/...)不管當(dāng)前能不能跑通一律改掉。因為src是開發(fā)期的目錄結(jié)構(gòu)運行期不存在。第二條內(nèi)置資源一律classpath。模板、默認(rèn)配置、圖標(biāo)、字體全部放resources下用getResourceAsStream讀。這樣IDE和JAR行為一致不用操心工作目錄。第三條外部文件路徑可配置。輸出目錄、用戶配置、日志位置全部通過系統(tǒng)屬性或配置文件指定基準(zhǔn)目錄默認(rèn)值用user.dir。這樣部署時改一個參數(shù)就能調(diào)整不用改代碼。第四條新項目先跑一遍路徑驗證。就是上面6.2和6.3那套流程花幾分鐘跑一遍確認(rèn)classpath資源和外部文件在兩種環(huán)境下都正常。這個習(xí)慣幫我省了無數(shù)次打包后才發(fā)現(xiàn)問題的返工。最后分享一個小技巧如果你在Eclipse里調(diào)試時不確定某個相對路徑最終指向哪里可以在表達(dá)式視圖里對Paths.get(your/path).toAbsolutePath()求值它會直接告訴你絕對路徑是什么。這比在代碼里加打印語句再重新運行要快得多尤其是在斷點調(diào)試的時候。