戰(zhàn):Java應(yīng)用打包成Windows雙擊EXE的完整指南)
Launch4j這個(gè)工具我斷斷續(xù)續(xù)用了大概七八年。最早接觸是在給單位做一個(gè)內(nèi)部臺(tái)賬小工具的時(shí)候好不容易把功能寫完結(jié)果同事一句怎么雙擊打不開直接把我說懵了——后來才明白不是程序有問題是對(duì)方電腦上壓根沒裝Java。這種事經(jīng)歷幾次就知道Java桌面應(yīng)用在Windows下的最后一百米有多重要。這篇文章就是聊聊怎么用Launch4j把JAR包變成雙擊就能跑的EXE以及這七八年時(shí)間里踩過的各種坑、總結(jié)出的經(jīng)驗(yàn)。內(nèi)容我盡量寫得實(shí)際操作一些適合做內(nèi)部工具、個(gè)人小項(xiàng)目和輕量分發(fā)的場(chǎng)景。如果你想用Java寫點(diǎn)東西丟給Windows用戶用又不想強(qiáng)迫人家安裝JDK或者背一籮筐環(huán)境變量配置這篇應(yīng)該對(duì)你有用。我會(huì)先從最核心的問題聊起——為什么Java應(yīng)用非要套個(gè)殼然后講工具選型再拆解Launch4j的配置邏輯最后是完整的實(shí)際操作流程和避坑經(jīng)驗(yàn)。1. 為什么Java桌面應(yīng)用需要一個(gè)殼1.1 直接發(fā)JAR包的尷尬先說個(gè)最基礎(chǔ)的現(xiàn)實(shí)。JAR包本質(zhì)上是一個(gè)zip壓縮文件只不過里面的內(nèi)容遵循Java的規(guī)范。要讓別人運(yùn)行它通常只有兩種方式雙擊需要系統(tǒng)里有正確的文件關(guān)聯(lián)或者命令行輸入java -jar xxx.jar需要PATH里有java命令。這兩種方式在開發(fā)機(jī)上都沒問題因?yàn)槟阊b了JDKIDE也幫你配好了環(huán)境。但一旦把JAR發(fā)給普通用戶——特別是那種電腦里只有微信、WPS、愛奇藝的用戶——問題一下就出來了用戶雙擊JAR系統(tǒng)彈出選擇打開方式對(duì)話框一臉懵用戶手動(dòng)裝了個(gè)JDK但環(huán)境變量沒配好java命令找不著就算環(huán)境配好了也可能出現(xiàn)版本不匹配比如你用Java 17新特性寫的代碼對(duì)方裝的是Java 8直接報(bào)UnsupportedClassVersionErrorJAR雙擊后有時(shí)會(huì)有一個(gè)黑色的cmd窗口一閃而過用戶根本看不到報(bào)錯(cuò)信息只會(huì)覺得程序壞了。這些問題的本質(zhì)是你交付的是半成品運(yùn)行環(huán)境需要使用者自己搞定。而正確的交付方式是給用戶一個(gè)獨(dú)立的EXE雙擊打開用不用JRE是程序自己的事用戶不需要知道底層細(xì)節(jié)。1.2 殼給用戶和開發(fā)者帶來的價(jià)值Launch4j做的事情就是給JAR做一層Windows下的殼——一個(gè)原生EXE啟動(dòng)器。它的運(yùn)行邏輯大致是這樣的用戶雙擊EXE后啟動(dòng)器檢查本機(jī)是否有符合條件的Java運(yùn)行時(shí)找到后就啟動(dòng)對(duì)應(yīng)的JVM并加載你的JAR找不到就彈出提示或者走你設(shè)定的兜底邏輯。這個(gè)過程對(duì)用戶是完全透明的。帶來的直接好處有用戶不需要手動(dòng)安裝JDK/JRE或者即使需要也能通過你設(shè)定的方式去獲取EXE以原生進(jìn)程方式運(yùn)行在任務(wù)管理器里能看到清晰的進(jìn)程名而不是一長串java.exe可以配置圖標(biāo)、版本信息、公司名看起來像一個(gè)正經(jīng)的Windows應(yīng)用支持文件關(guān)聯(lián)、啟動(dòng)參數(shù)透?jìng)?、JVM選項(xiàng)定制等能力。這里要澄清一個(gè)概念戴上一個(gè)殼并不改變JVM的運(yùn)行機(jī)制。程序跑起來之后底層還是Java進(jìn)程字節(jié)碼還是在JVM里解釋執(zhí)行。殼并不是把Java代碼編譯成原生機(jī)器碼它只是一個(gè)引導(dǎo)器。這一點(diǎn)經(jīng)常有人誤解以為用了Launch4j就有了原生應(yīng)用一樣的啟動(dòng)速度和性能——不存在的。啟動(dòng)速度取決于JVM的加載速度而不是殼本身。1.3 什么樣的場(chǎng)景適合殼方案用Launch4j這類工具適合的是這些場(chǎng)景內(nèi)部工具、管理腳本的圖形化前端比如一個(gè)連接數(shù)據(jù)庫做數(shù)據(jù)清洗的小界面給非技術(shù)同事、客戶分發(fā)的桌面小應(yīng)用比如合同臺(tái)賬、批量改文件名的工具需要自定義圖標(biāo)、版本信息和Windows集成特性的Java應(yīng)用希望在最小改動(dòng)下把現(xiàn)有JAR交付成EXE的遺留項(xiàng)目。不太適合的場(chǎng)景是對(duì)啟動(dòng)速度有極致要求的單文件應(yīng)用或者希望完全脫離JVM的軟件。這類需求更適合考慮GraalVM Native Image或者jpackage配合jlink產(chǎn)出自帶運(yùn)行時(shí)的小型鏡像。如果你只是想讓Java程序在Windows上像樣地跑起來Launch4j這個(gè)級(jí)別的殼就夠用。2. 主流打包工具橫評(píng)為什么選擇Launch4j2.1 業(yè)界常用的幾種方案Java應(yīng)用打包成Windows可執(zhí)行文件市面上大致有這幾類思路。我實(shí)際都用過簡單說說各自的定位。工具/方案授權(quán)方式核心能力典型不足exe4j商業(yè)收費(fèi)啟動(dòng)器、服務(wù)模式、自定義畫面配置項(xiàng)太多上手成本高收費(fèi)jpackageJDK官方能生成EXE/MSI可配合jlink裁剪運(yùn)行時(shí)打包體積大交叉構(gòu)建麻煩WinSW開源把Java程序包裝成Windows服務(wù)只面向后臺(tái)服務(wù)不做桌面應(yīng)用批處理/自解壓無解壓JRE和JAR再運(yùn)行沒有原生圖標(biāo)容易被殺軟誤報(bào)Launch4j開源免費(fèi)輕量啟動(dòng)器支持JRE搜索和捆綁不做安裝包單文件或多文件分發(fā)需搭配其他工具這些工具我基本都試過。exe4j功能確實(shí)全但那個(gè)界面密密麻麻的選項(xiàng)每次打開都像在做閱讀理解而且收費(fèi)license對(duì)個(gè)人開發(fā)者不友好。jpackage是官方方案Java 14之后的版本能用不過在實(shí)際項(xiàng)目中它的構(gòu)建過程比較重特別是你想在Linux的CI上交叉編譯出Windows的EXE或者M(jìn)SI會(huì)比較折騰。WinSW我用了大概半年它的定位很純粹——服務(wù)場(chǎng)景很棒我之前寫過一篇用WinSW把Java程序做成Windows服務(wù)的內(nèi)容但這不是同一個(gè)問題。如果你要做的是有界面的桌面應(yīng)用WinSW幫不上忙。2.2 Launch4j的優(yōu)劣勢(shì)分析站在多年使用的角度我覺得Launch4j最大的優(yōu)點(diǎn)是輕和直接。配置文件就是一個(gè)XML十幾行就能完成基本打包。沒有復(fù)雜的安裝包向?qū)б矝]有一堆你根本用不到的選項(xiàng)。它生成的核心產(chǎn)物就是一個(gè)EXE加上可選的配套JRE目錄整個(gè)交付物非常透明。而且它是純Java實(shí)現(xiàn)的工具GUI是Swing寫的在Windows、Linux、macOS都能運(yùn)行而且生成Windows的EXE。這對(duì)在Linux CI服務(wù)器上做交叉打包特別友好——你不需要一臺(tái)Windows機(jī)器就能產(chǎn)出Windows可執(zhí)行文件這個(gè)特性在自動(dòng)化發(fā)布流程里非常實(shí)用。缺點(diǎn)也明顯它不會(huì)優(yōu)化你的代碼或者裁剪運(yùn)行時(shí)只是加殼不能像jlink那樣按需裁剪模塊所以如果你的需求是盡量減小分發(fā)體積它幫不上太多開源項(xiàng)目沒有商業(yè)支持遇到問題基本靠GitHub issues和自己摸索對(duì)Windows Installer/MSI這類安裝包格式?jīng)]有支持如果要給用戶做完整安裝引導(dǎo)需要另配Inno Setup等工具界面看起來比較上古時(shí)代圖標(biāo)資源管理和版本信息編輯都不是很順手。2.3 我可以給出的選擇建議如果你的目標(biāo)用戶是一群Windows小白項(xiàng)目本身結(jié)構(gòu)簡單、依賴也不多Launch4j完全夠用。如果你需要的是安裝包、自動(dòng)更新、卸載程序這些完整分發(fā)體驗(yàn)有兩個(gè)方向一是用jpackage直接生成安裝包二是用Launch4j生成的EXE配合Inno Setup做安裝器。我自己目前的組合是Launch4j Inno Setup。為什么不用jpackage全包因?yàn)閖package生成的安裝包在每次版本更新時(shí)安裝向?qū)У慕换ミ壿嬓枰3忠恢峦瑫r(shí)它對(duì)國內(nèi)一些軟件管理器的兼容性不如傳統(tǒng)Inno Setup生成的安裝程序。當(dāng)然這有點(diǎn)個(gè)人偏好jpackage也是官方正路??傊甃aunch4j這層啟動(dòng)器角色在目前的主流方案里仍然有不可替代的位置。3. Launch4j核心配置逐項(xiàng)拆解3.1 最小可用配置長什么樣Launch4j有兩種操作方式GUI填表后生成XML或者直接寫XML再交給命令行程序處理。我第一次用它就是GUI填幾項(xiàng)點(diǎn)一下構(gòu)建就成了但后來發(fā)現(xiàn)還是XML可維護(hù)性高——因?yàn)橐粋€(gè)項(xiàng)目每次發(fā)版都要重新構(gòu)建手填GUI既慢又容易漏。所以我建議一開始就熟悉XML結(jié)構(gòu)把配置納入版本管理。一份最簡配置大致是這樣的launch4jConfig dontWrapJarfalse/dontWrapJar headerTypegui/headerType jarapp.jar/jar outfileapp.exe/outfile errTitle應(yīng)用啟動(dòng)失敗/errTitle jre pathjre/path minVersion1.8.0/minVersion maxVersion17/maxVersion /jre versionInfo fileVersion1.0.0.0/fileVersion productVersion1.0.0.0/productVersion companyName我的公司/companyName productName臺(tái)賬工具/productName fileDescription內(nèi)部臺(tái)賬管理工具/fileDescription copyright? 2024/copyright /versionInfo /launch4jConfig這里有個(gè)核心配置要先理解清楚dontWrapJar。這個(gè)配置決定了JAR是被嵌進(jìn)EXE里面還是保持外部JAR文件。默認(rèn)false表示把JAR包裝進(jìn)EXE好處是最終只有一個(gè)文件用戶不會(huì)誤刪JAR壞處是每次改代碼都要重新生成EXE而且如果JAR很大比如幾十MBEXE的啟動(dòng)加載會(huì)稍慢。如果選trueJAR就放在EXE旁邊EXE只是作為啟動(dòng)器尋找同目錄下的JAR。我個(gè)人的習(xí)慣是小工具5MB以內(nèi)的JAR用false一個(gè)文件發(fā)出去干凈利落項(xiàng)目較大或者代碼改動(dòng)頻繁的用true省得每次都重新打包EXE。另外如果你的程序會(huì)被殺毒軟件盯上保持外部JAR也有助于降低誤報(bào)率——因?yàn)樗幌袷菑腅XE里釋放代碼再運(yùn)行的行為。3.2 JRE搜索邏輯這是配置里最重要的部分Launch4j默認(rèn)不會(huì)幫你攜帶JRE它會(huì)在目標(biāo)機(jī)器上搜索可用的Java運(yùn)行時(shí)。這個(gè)搜索順序是固定的理解它對(duì)于排查為什么用戶機(jī)器打不開至關(guān)重要。官方文檔給出的搜索順序大致是如果在配置里指定了捆綁JRE即jre里的path字段優(yōu)先使用它嘗試使用靜態(tài)注冊(cè)的JRE路徑比如某些安裝程序?qū)懭肓俗?cè)表項(xiàng)掃描注冊(cè)表里已安裝的JDK/JRE版本匹配minVersion和maxVersion嘗試JAVA_HOME環(huán)境變量嘗試PATH中的java命令還是不行就會(huì)彈出錯(cuò)誤對(duì)話框提示找不到JRE??吹竭@里你應(yīng)該明白了配置里jre的path字段如果填了一個(gè)相對(duì)路徑比如jreLaunch4j會(huì)在EXE所在目錄下找這個(gè)jre子目錄找不到就往下走注冊(cè)表和環(huán)境變量。也就是說你不一定要捆綁JRE但要保證目標(biāo)機(jī)器上至少有一個(gè)版本符合條件的Java運(yùn)行時(shí)。minVersion和maxVersion用于限定版本范圍。minVersion很有用比如你的代碼用了Java 8的Lambda就設(shè)置minVersion為1.8.0。maxVersion要謹(jǐn)慎一般建議要么不設(shè)要么設(shè)一個(gè)較大的上限。為什么因?yàn)橛脩魴C(jī)器上可能裝了Java 21而你的程序其實(shí)兼容Java 8到17不設(shè)maxVersion反而兼容面更廣。除非你明確知道自己的代碼在某些新版本上有問題否則不要輕易設(shè)上限——我就見過有人設(shè)了maxVersion為17結(jié)果用戶機(jī)器上只裝了Java 21程序直接啟動(dòng)不了只因?yàn)槎鄠€(gè)版本號(hào)的好心限制。3.3 圖標(biāo)、版本信息和啟動(dòng)行為配置圖標(biāo)是窗口和任務(wù)欄顯示的圖片Launch4j只支持ICO格式的圖標(biāo)文件。這里有個(gè)常見誤區(qū)直接把PNG改后綴名為.ico或者用一個(gè)尺寸很小的ICO就完事了。Windows圖標(biāo)資源的最佳實(shí)踐是包含多種尺寸16x16、32x32、48x48、256x256等的ICO文件這樣在任務(wù)欄、資源管理器不同縮放級(jí)別下都能清晰顯示。你可以在網(wǎng)上找在線轉(zhuǎn)換工具生成多尺寸ICO或者用ImageMagick處理命令行如下magick convert icon_1024.png -define icon:auto-resize256,48,32,16 app.ico版本信息在文件的屬性-詳細(xì)信息里展示包括文件版本、產(chǎn)品版本、公司名、版權(quán)等。這里的版本號(hào)格式是四個(gè)數(shù)字段比如1.0.0.0Windows用這個(gè)做版本對(duì)比。注意版本號(hào)不能出現(xiàn)中文或特殊符號(hào)否則Windows資源管理器會(huì)顯示不了。啟動(dòng)行為里值得留意的配置是manifest和dpiAware。manifest可以指定以管理員權(quán)限運(yùn)行比如程序需要寫C盤Program Files下的配置文件以及操作系統(tǒng)版本兼容性聲明。dpiAware設(shè)為true可以避免高分屏下字體模糊。這兩個(gè)配置如果缺失在高DPI屏幕或者需要管理員權(quán)限的目錄操作時(shí)你會(huì)遇到一些看似莫名其妙的界面問題。3.4 內(nèi)存、啟動(dòng)參數(shù)與JVM選項(xiàng)啟動(dòng)器另一個(gè)實(shí)用功能是配置JVM參數(shù)。常見的寫法jre pathjre/path minVersion1.8.0/minVersion jvmOptions opt-Xmx512m/opt opt-Dfile.encodingUTF-8/opt /jvmOptions initialHeapSize128/initialHeapSize maxHeapSize512/maxHeapSize /jre這里initialHeapSize和maxHeapSize單位是MB對(duì)應(yīng)JVM的-Xms和-Xmx。如果程序是內(nèi)存敏感型比如加載大數(shù)據(jù)文件或大量圖片記得給足maxHeapSize。但如果是運(yùn)行在內(nèi)存較小的辦公電腦上給一個(gè)過大的值反而容易啟動(dòng)失敗而且還可能導(dǎo)致用戶的電腦卡頓。穩(wěn)妥做法是初始128MB、最大512MB到1024MB之間具體數(shù)值根據(jù)自己的程序?qū)崪y(cè)來定。還要注意JVM參數(shù)和程序參數(shù)的區(qū)分。jvmOptions是給JVM的比如-Xmx、-D系統(tǒng)屬性這類程序自己的參數(shù)也就是main方法接收的String[] args應(yīng)該在Java代碼里通過啟動(dòng)器額外參數(shù)或者運(yùn)行時(shí)命令行傳入。寫代碼時(shí)可以用System.getProperty讀取-D配置用main函數(shù)入?yún)⒆x取外部參數(shù)。這樣和啟動(dòng)器配合起來更靈活。4. 實(shí)戰(zhàn)打包從JAR到EXE的全流程4.1 準(zhǔn)備工作項(xiàng)目與JAR的構(gòu)建在用Launch4j之前先把Java項(xiàng)目構(gòu)建成可執(zhí)行的JAR包。如果是Maven項(xiàng)目在pom.xml里加上maven-jar-plugin配置Main-Class或者用spring-boot-maven-plugin打成Fat JAR。以普通Maven項(xiàng)目為例plugin groupIdorg.apache.maven.plugins/groupId artifactIdmaven-jar-plugin/artifactId version3.4.1/version configuration archive manifest mainClasscom.example.Main/mainClass /manifest /archive /configuration /plugin如果是Spring Boot項(xiàng)目直接mvn clean package生成的JAR就是可執(zhí)行的但要注意Spring Boot的JAR結(jié)構(gòu)比較特殊BOOT-INF目錄Launch4j的dontWrapJarfalse機(jī)制能不能正確處理實(shí)話說是可以的因?yàn)閱?dòng)器最終是通過java -jar方式加載JAR并不關(guān)心JAR內(nèi)部結(jié)構(gòu)。不過如果把這種Fat JAR嵌進(jìn)EXEEXE的體積會(huì)明顯變大啟動(dòng)時(shí)的解壓邏輯也會(huì)多耗一點(diǎn)時(shí)間。所以Spring Boot項(xiàng)目我更推薦dontWrapJartrue讓JAR作為外部文件保持清晰。4.2 使用GUI工具構(gòu)建從Launch4j官方GitHub Releases或官網(wǎng)下載對(duì)應(yīng)版本。Windows版自帶launch4j.exe這個(gè)GUI程序同時(shí)也有l(wèi)aunch4jc這兩個(gè)命令行程序。打開GUI后界面分幾個(gè)Tab基本配置、JRE配置、圖標(biāo)/版本、啟動(dòng)界面等。基本配置里填JAR路徑、輸出EXE路徑、是否包裝JAR。JRE配置里填版本范圍和JVM參數(shù)。圖標(biāo)與版本里加載ICO填寫版本信息。都填好后點(diǎn)右上角的構(gòu)建按鈕會(huì)生成一個(gè)EXE文件。GUI適合第一次嘗試和快速驗(yàn)證而且它也會(huì)生成一份XML配置文件。我建議你點(diǎn)一下保存配置把它存下來。這樣下一次發(fā)版直接改版本號(hào)用命令行重新構(gòu)建就完了不用再開GUI。XML配置跟著項(xiàng)目走也方便團(tuán)隊(duì)成員各自打包。4.3 使用命令行和XML構(gòu)建命令行構(gòu)建的核心是launch4jc這個(gè)程序它接收兩個(gè)參數(shù)--config xxx.xml。在Windows上launch4jc.exe --config app.xml在Linux CI上/opt/launch4j/launch4jc --config app.xml注意launch4jc在Linux上是一個(gè)shell腳本在某些系統(tǒng)上可能需要先賦予執(zhí)行權(quán)限。另外如果你的launch4jc腳本指向了GUI程序在無顯示器環(huán)境下會(huì)出現(xiàn)無法打開display這類報(bào)錯(cuò)。要確認(rèn)你使用的是真正的命令行程序而不是GUI版。Linux下無頭環(huán)境跑GUI版是我踩過的坑簡單說就是頭文件路徑問題我們后面再細(xì)聊。4.4 驗(yàn)證打包結(jié)果的關(guān)鍵點(diǎn)打包完成后不要急著發(fā)出去。先按這個(gè)清單驗(yàn)證一下雙擊EXE確認(rèn)程序能正常啟動(dòng)窗口標(biāo)題、圖標(biāo)正確打開任務(wù)管理器看進(jìn)程名是否是app.exe而不是java.exe這能確認(rèn)啟動(dòng)器用的是原生殼而不是繞開了殼打開CMD輸入app.exe --version這樣的參數(shù)確認(rèn)參數(shù)能透?jìng)鞯街鞒绦騧ain方法在沒有安裝Java的機(jī)器或者臨時(shí)禁用了系統(tǒng)JRE環(huán)境變量上測(cè)試確認(rèn)JRE搜索邏輯符合預(yù)期檢查EXE的屬性菜單確認(rèn)版本信息、文件描述、公司名都填上了。其中在沒有Java的機(jī)器上測(cè)試這一點(diǎn)怎么強(qiáng)調(diào)都不為過。你可以用一臺(tái)干凈的Windows虛擬機(jī)裝好后什么Java環(huán)境變量都不配然后直接跑EXE。如果程序在這種環(huán)境下能正常起來說明你的JRE捆綁或搜索策略是有效的。4.5 一種更穩(wěn)的分發(fā)方式捆綁JRE如果目標(biāo)用戶是徹底的小白注冊(cè)表搜索、環(huán)境變量這些都指望不上最穩(wěn)妥的方案是把一個(gè)精簡過的JRE放在EXE旁邊并在配置里指定path指向它。怎么獲得精簡JRE用jlink命令jlink --module-path $JAVA_HOME/jmods --add-modules java.base,java.desktop,java.sql --output jre --strip-debug --no-header-files --no-man-pages這樣生成的jre目錄通常只有40MB左右具體取決于你保留的模塊。比如一個(gè)只做數(shù)據(jù)庫管理和文件處理的小工具保留java.base、java.desktop、java.sql基本就夠了。然后把EXE、JAR如果用dontWrapJartrue和jre目錄放在同一個(gè)文件夾里整個(gè)文件夾一起發(fā)給用戶。用戶雙擊EXELaunch4j在EXE同級(jí)目錄找到j(luò)re直接使用完全不需要用戶手動(dòng)安裝Java。這種EXE jre目錄 可選JAR的形態(tài)自己打包、自己分發(fā)、自己控制運(yùn)行時(shí)版本是日常交付桌面小工具最實(shí)用的方式。缺點(diǎn)只是體積稍微大了一點(diǎn)但換來的是用戶零配置這個(gè)交換非常劃算。我在內(nèi)網(wǎng)環(huán)境下給非技術(shù)同事分發(fā)工具基本都是這種形式。5. 踩坑實(shí)錄圖標(biāo)、JRE搜索與路徑問題5.1 圖標(biāo)不顯示原來不是Launch4j的問題有一次我給工具換了新圖標(biāo)重新構(gòu)建EXE后發(fā)給同事對(duì)方說怎么還是舊圖標(biāo)。我本地怎么看都是新的反復(fù)對(duì)比了文件md5也沒問題后來發(fā)現(xiàn)不是圖標(biāo)沒進(jìn)去而是Windows的圖標(biāo)緩存。Windows Explorer會(huì)緩存EXE的圖標(biāo)尤其在文件沒有徹底修改文件指紋的時(shí)候。讓同事刷新縮略圖緩存或者重命名文件圖標(biāo)就正常了。最簡單的驗(yàn)證方法是把EXE復(fù)制到另一個(gè)目錄再看如果新目錄里圖標(biāo)是新的那就是緩存問題。另一個(gè)坑是ICO格式的兼容性。有些在線轉(zhuǎn)換工具生成的ICO只有單一尺寸在某些Windows版本或者縮放下會(huì)模糊或干脆不顯示。所以在生成ICO時(shí)注意多尺寸同時(shí)檢查分辨率避免用從PNG直接改擴(kuò)展名得來的假ICO。用ImageMagick轉(zhuǎn)換是最省心的前面提過的命令生成的多尺寸ICO實(shí)測(cè)在Windows 10/11上表現(xiàn)正常。5.2 找不到JRE的經(jīng)典報(bào)錯(cuò)與排查鏈路最常見的用戶報(bào)錯(cuò)就是雙擊EXE彈出Failed to find Java Development Kit之類的對(duì)話框。這個(gè)提示的英文是Launch4j默認(rèn)帶的很多初學(xué)者直接把默認(rèn)錯(cuò)誤提示發(fā)給了用戶結(jié)果就是等了好久用戶才反饋打不開有一個(gè)英文彈窗。排查這類問題我建議按這個(gè)順序來先看EXE旁邊的jre目錄是否存在是否和配置里的path字段對(duì)應(yīng)檢查目標(biāo)機(jī)器上是否有符合版本范圍的Java運(yùn)行時(shí)用命令行執(zhí)行java -version確認(rèn)實(shí)際版本確認(rèn)JAVA_HOME環(huán)境變量有沒有被設(shè)置成異常值比如指向了一個(gè)不存在或者版本過低的路徑打開注冊(cè)表編輯器查看HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment下的版本記錄是否正常用Launch4j的日志功能或者自定義errTitle讓錯(cuò)誤的細(xì)節(jié)對(duì)用戶可見。還有一個(gè)容易忽略的點(diǎn)有些殺毒軟件會(huì)攔截或靜默刪除Launch4j生成的EXE因?yàn)樗举|(zhì)是一個(gè)從EXE里釋放JAR到臨時(shí)目錄再運(yùn)行的程序——這個(gè)行為特征和某些惡意軟件非常相似。如果用戶環(huán)境里的安全軟件管得嚴(yán)建議加白名單或者想辦法做代碼簽名。沒有代碼簽名證書的情況下這也是我傾向于用dontWrapJartrue、保持外部JAR的一個(gè)原因。5.3 相對(duì)路徑的坑怎么都繞不過去Launch4j生成的EXE工作目錄默認(rèn)是用戶雙擊EXE時(shí)所在的目錄而不是EXE所在目錄。這一點(diǎn)是很多人踩坑的重災(zāi)區(qū)。舉個(gè)例子程序里用new File(config.properties)讀取配置用戶從桌面快捷方式啟動(dòng)工作目錄就是桌面而不是你安裝程序的目錄自然讀不到config.properties程序就崩了。解決方案有幾種在程序里通過定位自身JAR或者Class.getProtectionDomain().getCodeSource()來推斷程序根目錄進(jìn)而拼接配置路徑使用System.getProperty(user.dir)獲取當(dāng)前工作目錄但要小心這個(gè)值在不同啟動(dòng)方式下會(huì)變?cè)贚aunch4j的XML配置里設(shè)置workingDirectory字段指定程序的工作目錄為EXE所在目錄。我的建議是在代碼里做根目錄定位不要依賴外殼。因?yàn)長aunch4j只是在啟動(dòng)時(shí)解析路徑真正運(yùn)行時(shí)的當(dāng)前目錄由Windows決定這個(gè)坑不是一個(gè)配置能完全解決的。自己在代碼里處理才是根本辦法。具體來說就是拿到JAR文件所在的絕對(duì)路徑然后用這個(gè)絕對(duì)路徑去拼配置文件的位置。5.4 中文路徑與空格這些小問題很傷人還有一個(gè)多語言環(huán)境下的隱藏坑程序路徑里有中文或空格。Launch4j生成的EXE一般能應(yīng)對(duì)但如果你在配置里寫了硬編碼的相對(duì)路徑或者JAR路徑用的是絕對(duì)路徑可能出問題。例如把工具放在C:\Users\張三\我的工具\(yùn)下某些第三方庫和舊版JVM在讀路徑時(shí)編碼不一致就可能拋出FileNotFoundException或者ClassNotFoundException。穩(wěn)妥做法是開發(fā)時(shí)就用相對(duì)路徑發(fā)布時(shí)把EXE、JAR、jre放在同一個(gè)目錄不依賴系統(tǒng)任何絕對(duì)路徑。同時(shí)建議在配置文件中避免含中文目錄的硬編碼。用戶機(jī)器上如果有中文用戶名Windows用戶目錄本身就是中文的所以代碼和腳本盡量不要寫死路徑而是用動(dòng)態(tài)定位。你要是在目標(biāo)用戶電腦上部署最好提前確認(rèn)一下他的用戶目錄名是中文還是英文——這決定了你會(huì)不會(huì)踩這個(gè)坑。6. 進(jìn)階玩法命令行批處理與CI集成6.1 每次發(fā)版都手動(dòng)點(diǎn)GUI沒必要一旦你的項(xiàng)目開始頻繁發(fā)版手動(dòng)開GUI改版本號(hào)、點(diǎn)構(gòu)建、復(fù)制文件這一整套流程就會(huì)很痛苦。把Launch4j集成進(jìn)構(gòu)建腳本我自己的做法是先寫一個(gè)打包腳本然后和Maven/Gradle生命周期綁定。寫一個(gè)pack.shWindows下就是pack.bat內(nèi)容大致如下#!/bin/bash /opt/launch4j/launch4jc --config config.xml然后把這個(gè)腳本接入Maven的exec-maven-plugin在package階段自動(dòng)調(diào)用plugin groupIdorg.codehaus.mojo/groupId artifactIdexec-maven-plugin/artifactId version3.1.0/version executions execution idlaunch4j-package/id phasepackage/phase goals goalexec/goal /goals configuration executablelaunch4jc/executable arguments argument--config/argument argument${project.basedir}/packaging/launch4j.xml/argument /arguments /configuration /execution /executions /plugin這里有個(gè)細(xì)節(jié)exec-maven-plugin執(zhí)行時(shí)executable的路徑需要在PATH里能找到或者寫成絕對(duì)路徑。相對(duì)路徑在某些CI上會(huì)因?yàn)楣ぷ髂夸洸煌ё詈糜?{project.basedir}拼一個(gè)完整路徑。另外一個(gè)更Maven原生的做法是直接用com.akathist.maven.plugins.launch4j插件它封裝了Launch4j的調(diào)用用法更簡潔不過需要插件倉庫里能找到對(duì)應(yīng)版本。6.2 在GitHub Actions里自動(dòng)打包如果項(xiàng)目托管在GitHub上可以在workflow里加一個(gè)job專門做Windows EXE的構(gòu)建。因?yàn)長aunch4j是Java工具Linux環(huán)境就能跑交叉構(gòu)建非常方便jobs: build-exe: runs-on: ubuntu-latest steps: - uses: actions/checkoutv4 - uses: actions/setup-javav4 with: distribution: temurin java-version: 17 - run: mvn -B package - name: Run launch4j run: | wget -q -O launch4j.tar.gz https://github.com/launch4j/launch4j/releases/download/3.50/launch4j-3.50-linux-x64.tgz tar xzf launch4j.tar.gz ./launch4j/launch4jc --config packaging/launch4j.xml - uses: actions/upload-artifactv4 with: name: app-windows path: target/app.exe注意下載Launch4j的URL要鎖定你驗(yàn)證過的版本號(hào)不要用latest動(dòng)態(tài)鏈接。我在CI里踩過的坑一個(gè)是網(wǎng)絡(luò)源不穩(wěn)定導(dǎo)致拉取失敗另一個(gè)是解壓后的目錄結(jié)構(gòu)和文檔不完全一致。解決辦法就是先把工具鏈在本地跑通再把同樣的命令原樣搬進(jìn)workflow不要想當(dāng)然。6.3 用變量模板管理版本號(hào)Launch4j的XML配置文件里versionInfo字段建議用占位符比如${project.version}在構(gòu)建腳本里通過sed替換成真實(shí)版本。這些都是構(gòu)建腳本的常規(guī)操作但是能讓發(fā)版流程規(guī)范很多。我這里給一個(gè)簡單的思路維護(hù)一份launch4j-template.xml里面把版本號(hào)和產(chǎn)物名寫成占位符fileVersionVERSION.0/fileVersion productVersionVERSION.0/productVersion outfileAPP_NAME.exe/outfile然后在打包腳本里做替換sed -i s/VERSION/$VERSION/g; s/APP_NAME/$APP_NAME/g launch4j-final.xml整個(gè)流程就是一條命令mvn clean package腳本自動(dòng)完成JAR構(gòu)建、Launch4j打包、生成EXE、發(fā)布到內(nèi)部文件服務(wù)器。省去了大量手工操作也杜絕了忘了更新版本號(hào)這種低級(jí)錯(cuò)誤。6.4 啟動(dòng)器分發(fā)的最后一道細(xì)節(jié)錯(cuò)誤提示與日志最后說一個(gè)容易被忽略但很重要的細(xì)節(jié)錯(cuò)誤提示。當(dāng)目標(biāo)機(jī)器找不到JRE、或者JAR缺失的時(shí)候Launch4j默認(rèn)的錯(cuò)誤對(duì)話框往往只有一行英文提示用戶看了毫無頭緒。配置里有一個(gè)errTitle字段可以自定義標(biāo)題欄文字正文則可以用自定義消息模板。更實(shí)用的做法是結(jié)合日志??梢栽谂渲美锎蜷_日志功能讓啟動(dòng)器把啟動(dòng)過程和錯(cuò)誤信息寫入EXE同目錄下的日志文件。對(duì)技術(shù)人員排查問題非常有用。我自己一般是開發(fā)環(huán)境開日志發(fā)布時(shí)關(guān)閉避免用戶目錄被日志文件污染。6.5 和其他工具的組合Inno Setup Launch4j前面提過一次的經(jīng)典組合這里展開說說。Launch4j生成EXE后再用Inno Setup寫一個(gè)安裝腳本把EXE、JAR、jre目錄、配置文件一起打包成Setup.exe。安裝過程中Inno Setup負(fù)責(zé)創(chuàng)建桌面快捷方式、寫注冊(cè)表卸載信息、設(shè)置安裝目錄。用戶得到一個(gè)完整的安裝體驗(yàn)。Inno Setup的腳本不算復(fù)雜核心就是定義Source文件和任務(wù)[Files] Source: target\app.exe; DestDir: {app} Source: target\jre\*; DestDir: {app}\jre; Flags: recursesubdirs Source: target\app.jar; DestDir: {app} [Icons] Name: {group}\臺(tái)賬工具; Filename: {app}\app.exe這個(gè)組合的好處是Launch4j解決怎么啟動(dòng)Inno Setup解決怎么安裝各司其職比單一工具單打獨(dú)斗效果更好。安裝包做出來后用戶只需要一路Next裝完桌面就有快捷方式卸載也能從控制面板走。我目前的對(duì)外發(fā)布流程都是這個(gè)組合實(shí)測(cè)用戶接受度非常高。最后想分享一個(gè)個(gè)人體會(huì)打包工具這種東西最重要的不是功能多齊全而是你要完全理解它每一步在做什么。Launch4j的XML配置其實(shí)不復(fù)雜但JRE搜索順序、工作目錄、dontWrapJar這些概念如果只是照著網(wǎng)上教程填一遍很可能在某個(gè)用戶那里突然翻車。多花點(diǎn)時(shí)間在啟動(dòng)器和JRE的關(guān)系上比什么都值。以后你每做一個(gè)Java桌面工具這層殼就不會(huì)再成為交付路上的阻礙了。