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"//图标路径 
    }  
  }

在設定檔中加入以上的文件之後就可以打包出來簡單的資料夾，資料夾絕對不是我們想要的東西。下一步我們來繼續講別的配置。

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]

Deprecated(廢棄):

  --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是一個簡單又強大的函式庫。反正我很服

以上是electron-builder打包的詳細介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！