使用 pkg 打包分發 nodejs 應用

pkg 是一個很不錯的跨平臺 nodejs 應用打包工具,使用此工具,咱們只須要給與用戶提供一個簡單的
可執行文件就能夠了,同時代碼也是二進制的,提升了代碼的安全性
備註:測試demo 很簡單,也比較典型,包裝了sofa 框架,咱們能夠直接查看graphql api 以及open api css

環境準備

能夠參考: http://www.javashuo.com/article/p-vysuzxim-my.html,具體的代碼就不用粘貼,主要說明pkg
的使用html

  • package.json 文件
{
  "name": "sofa-graphql2rest",
  "version": "1.0.0",
  "license": "MIT",
  "main": "index.ts",
  "pkg": {
    "scripts": "dist/**/*.js",
    "assets":["node_modules/swagger-ui-dist/**/*.*","node_modules/swagger-ui-express/**/*.*"]
  },
  "bin": "dist/index.js",
  "scripts": {
    "start": "ts-node index.ts",
    "build":"tsc"
  },
  "dependencies": {
    "body-parser": "1.18.3",
    "chalk": "2.4.2",
    "express": "4.16.4",
    "express-graphql": "0.7.1",
    "graphql": "^14.0.2",
    "graphql-subscriptions": "^1.0.0",
    "graphql-tag": "2.10.0",
    "graphql-tools": "4.0.3",
    "sofa-api": "^0.2.2",
    "swagger-ui-express": "4.0.2"
  },
  "devDependencies": {
    "@types/swagger-ui-express": "3.0.0",
    "@types/body-parser": "1.17.0",
    "@types/express": "4.16.0",
    "@types/express-graphql": "0.6.2",
    "@types/graphql": "14.0.3",
    "esm": "^3.0.84",
    "ts-loader": "^5.3.3",
    "ts-node": "7.0.1",
    "typescript": "3.2.2"
  }
}
  • 說明
    對於pkg 的打包咱們須要的主要是package.json 文件的配置,同時注意須要包好bin 以及pkg,對於依賴的靜態資源
    也須要說明,好比上邊的由於swagger ui 須要一個依賴css 資源,同時也是一個npm 包,因此 在pkg 配置中,手工
    指定了加載的資源,這個很重要,相似的問題均可以使用這種方法解決
"assets":["node_modules/swagger-ui-dist/**/*.*","node_modules/swagger-ui-express/**/*.*"]

構建&&效果

  • 安裝pkg (全局)
npm install -g pkg
  • 構建
    不指定平臺的話,默認是三端的(linux,mac windows)
pkg   .
  • 運行
    ./sofa-graphql2rest-macos


說明

使用pkg 的打包方式,對於咱們減小代碼包的大小也是很不錯的,好比在容器中運行,並且對於軟件的分發也很方便,並且跨平臺。
## 參考資料
https://github.com/rongfengliang/sofa-graphql2rest-docker-composenode

相關文章
相關標籤/搜索