使用pkg打包nodejs項目并解決本地文件讀取的問題

更新時間：2023年10月31日 11:02:23 作者：走在大前端的路上

這篇文章主要介紹了使用pkg打包nodejs項目并解決本地文件讀取的問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

使用pkg打包nodejs項目

使用pkg對nodejs程序進行打包，能對項目源碼和重要文件進行一定的保護，也能提升程序運行的便捷性，使用npm install -g pkg全局安裝pkg。

這里我的所有代碼寫在一個js文件（anyAPIcheck.js）中，并包含一些依賴文件：

實際上這是一個非常小的項目，項目主體也只有一個js文件，使用pkg可將該項目主體文件及其引用文件打包為一個可執(zhí)行文件。

進入項目根目錄，執(zhí)行命令pkg anyAPIcheck.js 可同時打包windows、Linux及macos下的可執(zhí)行文件，默認(rèn)打包為64位可執(zhí)行文件，首次打包需要將nodejs以二進制編譯到pkg緩存路徑中，這一步耗時較長，需要耐心等待。

打包完成后會在項目根目錄生成一個可執(zhí)行文件，該文件自帶nodejs，所以不需要用戶額外安裝nodejs環(huán)境。

當(dāng)然，你也可以個性化打包，如：

pkg -t node12-win-x86 anyAPIcheck.js （使用node12版本單獨打包windows下的32位可執(zhí)行文件）
pkg -t node14-win-x64 anyAPIcheck.js （使用node14版本單獨打包windows下的64位可執(zhí)行文件）
pkg -t node12-win-x86 anyAPIcheck.js -o myAPP（使用node12版本單獨打包windows下的32位可執(zhí)行文件并將可執(zhí)行文件命名為myAPP）
pkg -t node12-linux-x64 anyAPIcheck.js （使用node12版本單獨打包linux下的64位可執(zhí)行文件）
pkg -t node12-macos-x64 anyAPIcheck.js （使用node12版本單獨打包macos下的64位可執(zhí)行文件）

注意：

nodejs新版本中沒有32位linux與macos版本，只有64位版本的，只有windows同時包含32位與64位版本。

本人使用多個以前的node版本打包32位linux與macos可執(zhí)行文件均報錯，目前看來暫時無法將項目打包為linux與macos下的32位可執(zhí)行文件。

pkg打包的可執(zhí)行程序讀取本地文件

pkg打包前與打包后的路徑有一些變化，比如打包的時候用 pkg /path/app.js ，那么打包后，__filename 就是 /snapshot/path/app.js， __dirname 就是 /snapshot/path，

詳細(xì)如下表所示：

process.cwd() 就是打包后的可執(zhí)行程序（比如windows下的exe文件，這個exe文件你可以隨意移動）所在路徑，__dirname則是exe內(nèi)部項目根目錄，有如下文件引用場景：

1.項目需要引用配置文件config.json，該配置文件內(nèi)容固定不變。

引用方法： path.join( __dirname, ‘config.json’)
注意： path.join(）函數(shù)中，如果引用文件在項目根目錄直接寫 'config.json’即可，如果不在需要填入詳細(xì)路徑。

2.項目需要引用配置文件config.json，該配置文件內(nèi)容動態(tài)變化。

引用方法：可將config.json文件復(fù)制到exe文件所在目錄，使用 path.join( process.cwd(), ‘config.json’)
注意： path.join(）函數(shù)中，如果引用文件與exe同級，直接寫 'config.json’即可，如果在exe文件同級目錄下的子目錄中，需要填入詳細(xì)路徑。

文件引用問題解決后需要使用 fs.readFileSync(configPath, “utf-8”)讀取文件內(nèi)容，configPath參數(shù)為文件引用路徑，注意了，一定要使用同步讀取readFileSync，因為很可能你程序后面的操作需要在讀取文件的基礎(chǔ)上進行，如果使用異步讀取readFile，則文件還沒讀取后面的操作就繼續(xù)進行了，會直接報錯。