electron-builder打包的示例分析

這篇文章主要介紹了electron-builder打包的示例分析，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

開發electron客戶端程序，打包是繞不開的問題。下面就我在工作中的經驗以及目前對electron-builder的了解來分享一些心得。

基本概念

官網的定義

A complete solution to package and build a ready for distribution Electron app for macOS, Windows and Linux with “auto update” support out of the box.

關于electron和electron-builder的基礎部分這篇文章就跳過了，有興趣的話可以看這篇文章

如何使用

builder的使用和配置都是很簡單的
builder配置有兩種方式

package.json中直接配置使用（比較常用，我們下面著重來講這個）

指定electron-builder.yml文件

demo地址會在文章末尾給出（demo項目中electron使用得是V2.0.7版本,目前更高得是2.0.8版本）。

下面是一個簡單的package.js中帶注釋的配置

1. 基礎配置

"build": {  // 這里是electron-builder的配置
    "productName":"xxxx",//項目名 這也是生成的exe文件的前綴名
    "appId": "com.xxx.xxxxx",//包名  
    "copyright":"xxxx",//版權  信息
    "directories": { // 輸出文件夾
      "output": "build"
    }, 
    // windows相關的配置
    "win": {  
      "icon": "xxx/icon.ico"//圖標路徑 
    }  
  }

在配置文件中加入以上的文件之后就可以打包出來簡單的<font clolor="red">文件夾</font>，文件夾肯定不是我們想要的東西。下一步我們來繼續講別的配置。

1. 打包目標配置

要打包成安裝程序的話我們有兩種方式，

1. 使用NSIS工具對我們的文件夾再進行一次打包，打包成exe

2. 通過electron-builder的nsis直接打包成exe，配置如下

"win": {  // 更改build下選項
    "icon": "build/icons/aims.ico",
    "target": [
      {
        "target": "nsis" // 我們要的目標安裝包
      }
    ]
  },

1. 其他平臺配置

  "dmg": { // macOSdmg
    "contents": [
      ...
    ]
    },
    "mac": {  // mac
      "icon": "build/icons/icon.icns"
    },
    "linux": { // linux
      "icon": "build/icons"
    }

1. nsis配置

這個要詳細的講一下，這個nsis的配置指的是安裝過程的配置，其實還是很重要的，如果不配置nsis那么應用程序就會自動的安裝在C盤。沒有用戶選擇的余地，這樣肯定是不行的

關于nsis的配置是在build中nsis這個選項中進行配置，下面是部分nsis配置

"nsis": {
  "oneClick": false, // 是否一鍵安裝
  "allowElevation": true, // 允許請求提升。 如果為false，則用戶必須使用提升的權限重新啟動安裝程序。
  "allowToChangeInstallationDirectory": true, // 允許修改安裝目錄
  "installerIcon": "./build/icons/aaa.ico",// 安裝圖標
  "uninstallerIcon": "./build/icons/bbb.ico",//卸載圖標
  "installerHeaderIcon": "./build/icons/aaa.ico", // 安裝時頭部圖標
  "createDesktopShortcut": true, // 創建桌面圖標
  "createStartMenuShortcut": true,// 創建開始菜單圖標
  "shortcutName": "xxxx", // 圖標名稱
  "include": "build/script/installer.nsh", // 包含的自定義nsis腳本 這個對于構建需求嚴格得安裝過程相當有用。
  "script" : "build/script/installer.nsh" // NSIS腳本的路徑，用于自定義安裝程序。 默認為build / installer.nsi  
},

關于include 和 script 到底選擇哪一個 ？

在對個性化安裝過程需求并不復雜，只是需要修改一下安裝位置，卸載提示等等的簡單操作建議使用include配置,如果你需要炫酷的安裝過程，建議使用script進行完全自定義。

NSIS對于處理安裝包這種東西，功能非常的強大。但是學習起來并不比一門高級語言要容易。其中的奧秘還要各位大佬自行探索

這里上一些學習資源

• NSIS初級篇

• NSIS 打包腳本基礎

• 示例腳本

• NSIS論壇

1. 關于操作系統的配置

主要是windows中64和32位的配置

CLI參數

electron-builder --ia32 // 32位
electron-builder        // 64位(默認)

nsis中配置

"win": {
  "icon": "build/icons/aims.ico",
  "target": [
    {
      "target": "nsis",
      "arch": [ // 這個意思是打出來32 bit + 64 bit的包，但是要注意：這樣打包出來的安裝包體積比較大，所以建議直接打32的安裝包。
        "x64", 
        "ia32"
      ]
    }
  ]
}

1. 更新配置

下面這個是給更新用的配置，主要是為了生成lastest.yaml配置文件

"publish": [
  {
    "provider": "generic", // 服務器提供商 也可以是GitHub等等
    "url": "http://xxxxx/" // 服務器地址
  }
],

完整配置

基本上可用的完整的配置

"build": {
    "productName":"xxxx",//項目名 這也是生成的exe文件的前綴名
    "appId": "com.leon.xxxxx",//包名  
    "copyright":"xxxx",//版權  信息
    "directories": { // 輸出文件夾
      "output": "build"
    }, 
    "nsis": {
      "oneClick": false, // 是否一鍵安裝
      "allowElevation": true, // 允許請求提升。 如果為false，則用戶必須使用提升的權限重新啟動安裝程序。
      "allowToChangeInstallationDirectory": true, // 允許修改安裝目錄
      "installerIcon": "./build/icons/aaa.ico",// 安裝圖標
      "uninstallerIcon": "./build/icons/bbb.ico",//卸載圖標
      "installerHeaderIcon": "./build/icons/aaa.ico", // 安裝時頭部圖標
      "createDesktopShortcut": true, // 創建桌面圖標
      "createStartMenuShortcut": true,// 創建開始菜單圖標
      "shortcutName": "xxxx", // 圖標名稱
      "include": "build/script/installer.nsh", // 包含的自定義nsis腳本
    },
    "publish": [
      {
        "provider": "generic", // 服務器提供商 也可以是GitHub等等
        "url": "http://xxxxx/" // 服務器地址
      }
    ],
    "files": [
      "dist/electron/**/*"
    ],
    "dmg": {
      "contents": [
        {
          "x": 410,
          "y": 150,
          "type": "link",
          "path": "/Applications"
        },
        {
          "x": 130,
          "y": 150,
          "type": "file"
        }
      ]
    },
    "mac": {
      "icon": "build/icons/icon.icns"
    },
    "win": {
      "icon": "build/icons/aims.ico",
      "target": [
        {
          "target": "nsis",
          "arch": [
            "ia32"
          ]
        }
      ]
    },
    "linux": {
      "icon": "build/icons"
    }
  }

命令行參數（CLI）

Commands(命令):

  electron-builder build                    構建命名                      [default]
  electron-builder install-app-deps         下載app依賴
  electron-builder node-gyp-rebuild         重建自己的本機代碼
  electron-builder create-self-signed-cert  為Windows應用程序創建自簽名代碼簽名證書
  electron-builder start                    使用electronic-webpack在開發模式下運行應用程序(須臾要electron-webpack模塊支持)

Building(構建參數):

  --mac, -m, -o, --macos   Build for macOS,                              [array]
  --linux, -l              Build for Linux                               [array]
  --win, -w, --windows     Build for Windows                             [array]
  --x64                    Build for x64 (64位安裝包)                     [boolean]
  --ia32                   Build for ia32(32位安裝包)                     [boolean]
  --armv7l                 Build for armv7l                              [boolean]
  --arm64                  Build for arm64                               [boolean]
  --dir                    Build unpacked dir. Useful to test.           [boolean]
  --prepackaged, --pd      預打包應用程序的路徑（以可分發的格式打包）
  --projectDir, --project  項目目錄的路徑。 默認為當前工作目錄。
  --config, -c             配置文件路徑。 默認為`electron-builder.yml`（或`js`，或`js5`)

Publishing(發布):

  --publish, -p  發布到GitHub Releases [choices: "onTag", "onTagOrDraft", "always", "never", undefined]

<font color="red">Deprecated(廢棄):</font>

  --draft       請改為在GitHub發布選項中設置releaseType                 [boolean]
  --prerelease  請改為在GitHub發布選項中設置releaseType                 [boolean]
  --platform    目標平臺 (請更改為選項 --mac, --win or --linux)
           [choices: "mac", "win", "linux", "darwin", "win32", "all", undefined]
  --arch        目標arch (請更改為選項 --x64 or --ia32)
                   [choices: "ia32", "x64", "armv7l", "arm64", "all", undefined]

Other(其他):

  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

Examples(例子):

  electron-builder -mwl                        為macOS，Windows和Linux構建（同時構建）
  electron-builder --linux deb tar.xz          為Linux構建deb和tar.xz
  electron-builder -c.extraMetadata.foo=bar    將package.js屬性`foo`設置為`bar`
  electron-builder --config.nsis.unicode=false 為NSIS配置unicode選項

TargetConfiguration(構建目標配置):

target:  String - 目標名稱，例如snap.
arch “x64” | “ia32” | “armv7l” | “arm64”> | “x64” | “ia32” | “armv7l” | “arm64”  -arch支持列表

感謝你能夠認真閱讀完這篇文章，希望小編分享的“electron-builder打包的示例分析”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!