使用pkg怎么對ThinkJS項目進行打包

使用pkg怎么對ThinkJS項目進行打包？很多新手對此不是很清楚，為了幫助大家解決這個難題，下面小編將為大家詳細講解，有這方面需求的人可以來學習下，希望你能有所收獲。

在pkg 模塊的 README 中，羅列了它的幾大用處，如果你有下面的幾個需求的話建議不妨試試。

• 為應用提供商業發行版而不用暴露源碼

• 為應用提供 demo 而不用暴露源碼

• 一鍵打包所有平臺可執行文件而不需要對應平臺環境依賴

• 提供自解壓或自安裝的解決方案

• 運行應用不需要安裝 Node.js 和 npm

• 部署僅需要一份單文件，不需要通過 npm 安裝大量的依賴

• 資源打包后讓應用遷移起來更加方便

• 在指定 Node.js 版本下對應用進行測試而不需要安裝對應的版本

如何使用

關于 pkg 模塊的基礎使用，大家可以看 《把你的NodeJS程序給沒有NodeJS的人運行》 這篇文章。通過 npm install -g pkg 在全局安裝上模塊后就可以在命令行中使用 pkg 命令了。pkg 除了支持在命令行中指定參數之外，還支持在 package.json 中進行配置。

{
 ...
 "bin": "production.js",
 "scripts": {
  "pkg": "pkg . --out-path=dist/"
 },
 "pkg": {
  "scripts": [...]
  "assets": [...],
  "targets": [...]
 },
 ...
}

以上就是一個簡單的配置。bin 用來指定最終打包的入口文件，pkg.scripts 和 pkg.assets 用來指定除了入口文件之外需要打包進可執行文件中的內容，其中前者用來指定其他 .js 文件，后者用來指定非.js的資源。pkg.targets 則是用來指定需要打包的平臺，平臺名稱結構如下，node${version}-${platform}-${arch}。version 用來指定具體 Node 的版本，platform 用來指定編譯的平臺，可以是 freebsd, linux, alpine, macos 或者 win，最后 arch 用來指定編譯平臺的架構，可以是 x64, x86, armv6 或者 armv7。例如 node10-macos-x64 表示的就是基于 Node 10 打包在 MacOS 平臺上執行的可執行程序。scripts, assets 和 targets 都支持數組配置多個。

將入口文件、依賴的腳本和資源、需要編譯的平臺配置好之后，執行 npm run pkg 即可完成編譯。

如何打包 ThinkJS

pkg 的原理大概是提供一個虛擬的文件系統，將 __filename, __dirname 等變量以及官方 API 中的 IO 操作方法指向本地文件系統的變量修改成指向虛擬系統。通過該虛擬文件系統讀取壓縮打包后的程序源碼，提供腳本執行的環境。需要注意的是該虛擬文件系統是只讀的，所以如果程序中有基于 __dirname 進行讀寫操作的方法，需要規避規避掉。

代碼預處理

在 ThinkJS 項目中會有以下兩個地方有文件寫入操作：

1. 項目啟動后會在 runtime/config/${env}.json 下寫入最終的配置文件

2. 生產環境下默認會在 logs/ 目錄中寫入線上日志

這些目錄默認都是基于當前項目文件夾的，所以基于之前的理論都需要規避。pkg 的 README 中告訴我們 process.cwd() 還是會指向到真實的環境中，所以我們可以修改以上目錄的位置到 process.cwd() 來解決這個問題。

//pkg.js
const path = require('path');
const Application = require('thinkjs');

const instance = new Application({
 //在啟動文件中可以自定義配置 runtime 目錄
 RUNTIME_PATH: path.join(process.cwd(), 'runtime'), 
 ROOT_PATH: __dirname,
 proxy: true,
 env: 'pkg',
});

instance.run();

基于 production.js 我們新建一個 pkg.js 啟動文件，定義項目啟動后的 RUNTIME_PATH 路徑，并將 env 賦值為 pkg，方便后續的配置中通過 think.env === 'pkg' 來切換配置。

//src/config/adapter.js
const {Console, DateFile} = require('think-logger3');
const isDev = think.env === 'development';
const isPkg = think.env === 'pkg';
exports.logger = {
 type: isDev ? 'console' : 'dateFile',
 console: {
  handle: Console
 },
 dateFile: {
  handle: DateFile,
  level: 'ALL',
  absolute: true,
  pattern: '-yyyy-MM-dd',
  alwaysIncludePattern: true,
  filename: path.join(isPkg ? process.cwd() : think.ROOT_PATH, 'logs/app.log')
 }
};

在 adapter 配置中我們將原來基于 think.ROOT_PATH 的路徑修改成基于 process.cwd()。除了日志服務之外，如果業務中有使用到 cache 和 session 等服務，它們如果也是基于文件存儲的話，也需要修改對應的文件存儲配置。當然這些都是 ThinkJS 自帶的一些服務，如果項目中有用到其它的一些服務，或者說本身的業務邏輯中有涉及到文件寫入的也都需要修改配置。

打包配置

項目的寫入操作規避掉之后我們就可以正常的配置 pkg 然后進行打包處理了。一份簡單的 pkg 模塊的配置大概是這樣的：

//package.json
{
 "bin": "pkg.js",
 "pkg": {
  "assets": [
   "src/**/*",
   "view/**/*",
   "www/**/*"
  ],
  "targets": [
   "node10-linux-x64",
   "node10-macos-x64",
   "node10-win-x64"
  ]
 }
}

這里我們指定了 pkg.js 為打包的入口文件，指定了需要編譯出 linux, macos, win 三個平臺的可執行腳本，同時指定了需要將 src/, view/, www/ 三個目錄作為資源一塊打包進去。這是因為 ThinkJS 是動態 require 的項目，具體的業務邏輯都是在執行的時候通過遍歷文件目錄讀取文件的形式載入的，對于 pkg 模塊打包來說無法在編譯的時候知道這些依賴關系，所以需要作為啟動依賴的“資源”一塊打包進去。

配置好后直接在項目目錄下執行 pkg .，如果一切 OK 的話應該能在當前目錄中看到三個可執行文件，直接執行對應平臺的二進制文件即可啟動服務了。

? www.thinkjs.org git:(master) npm run pkg-build

> thinkjs-official@1.2.0 pkg-build /Users/lizheming/workspace/thinkjs/www.thinkjs.org
> pkg ./ --out-path=dist

> pkg@4.4.0
? www.thinkjs.org git:(master) ? ls -alh dist
total 577096
drwxr-xr-x  5 lizheming staff  160B 12 28 17:35 .
drwxr-xr-x@ 30 lizheming staff  960B 12 28 17:34 ..
-rwxr-xr-x  1 lizheming staff  87M 12 28 17:34 thinkjs-official-linux
-rwxr-xr-x  1 lizheming staff  87M 12 28 17:35 thinkjs-official-macos
-rw-r--r--  1 lizheming staff  82M 12 28 17:35 thinkjs-official-win.exe
? www.thinkjs.org git:(master) ?

后記

項目打包后有一個問題是配置沒辦法修改了，如果有動態配置的需求的話就不是很方便了。這里提供兩個思路解決該問題：

1. 將動態的配置配置到環境變量中，程序通過讀取環境變量覆蓋默認的配置。

2. 利用 ThinkJS 提供的 beforeStartServer() 鉤子在啟動前讀取真實目錄下的配置文件進行配置覆蓋。

//pkg.js
const path = require('path');
think.beforeStartServer(() => {
 const configFile = path.join(process.cwd(), 'config.js');
 const config = require(configFile);
 think.config(config);
});

另外隨著項目的復雜度提高，業務內可能會引入大量的第三方模塊。前文只是解決了 ThinkJS 項目本身的動態引入問題，如果引入的第三方模塊也有動態引入的話也需要在 pkg.assets 配置中顯示指定出來。還有就是針對 C++ 模塊，pkg 目前還沒有辦法做到自動引入，同樣需要在 pkg.assets 中指定依賴資源。

//package.json
{
 "pkg": {
  "assets": [
   //以 node-sqlite3 模塊為例
   "node_modules/sqlite3/lib/binding/node-v64-darwin-x64/node_sqlite3.node"
  ]
 }
}

其中 node-v64-darwin-x64 可能會根據平臺不一樣導致名字不太一樣。無法引入 .node 模塊的原因是因為 C++ 模塊安裝的時候會通過 node-gyp 進行動態編譯，該操作是和平臺相關的。也就是說該特性和 pkg 模塊在一個平臺上能打包所有平臺的二進制包特性是沖突的，畢竟 pkg 模塊也沒辦法在 Mac 平臺上編譯 Windows 平臺的模塊。所以在這種情況下除了需要手動引入編譯后的 .node 模塊之外，還需要注意引入的該 .node 模塊和 pkg.targets 指定的編譯平臺的一致性。

看完上述內容是否對您有幫助呢？如果還想對相關知識有進一步的了解或閱讀更多相關文章，請關注億速云行業資訊頻道，感謝您對億速云的支持。