Electron 安裝指導(dǎo)

要安裝預(yù)編譯的 Electron 二進制文件，請使用 ?npm?。 首選方法是在你的應(yīng)用程序中安裝 Electron 作為開發(fā)依賴：

npm install electron --save-dev

查看 Electron 版本管理 獲取如何在你的應(yīng)用中管理Electron的相關(guān)信息。

運行 Electron ad-hoc

如果你不想在本地工程上使用 npm install 同時又沒用其它選擇時，你也可以使用 npm 捆綁的 npx 命令來運行 Electron ad-hoc：

npx electron .

上面的命令會在當(dāng)前工作目錄下運行Electron。 需要注意的是，你的應(yīng)用中的任何依賴將不會被安裝。

自定義

如果想修改下載安裝的位版本(例如, 在x64機器上安裝ia32位版本), 你可以使用npm install中的--arch標(biāo)記，或者設(shè)置npm_config_arch 環(huán)境變量:

npm install --arch=ia32 electron

此外, 您還可以使用 --platform 來指定開發(fā)平臺 (例如, win32、linux 等):

npm install --platform=win32 electron

代理

如果您需要使用 HTTP 代理，您需要設(shè)置 ELECTRON_GET_USE_PROXY 變量為 任何值。 附加額外的環(huán)境變量，取決于您的主機系統(tǒng)Node版本：

• Node10及以上
• Node10前

自定義鏡像和緩存

在安裝過程中，electron 模塊會通過 electron-download 為您的平臺下載 Electron 的預(yù)編譯二進制文件。 這將通過訪問 GitHub 的發(fā)布下載頁面來完成 (https://github.com/electron/electron/releases/tag/v$VERSION, 這里的 $VERSION 是 Electron 的確切版本).

如果您無法訪問GitHub，或者您需要提供自定義構(gòu)建，則可以通過提供鏡像或現(xiàn)有的緩存目錄來實現(xiàn)。

鏡像

您可以使用環(huán)境變量來覆蓋基本 URL，查找 Electron 二進制文件的路徑以及二進制文件名。 electron/get 使用的網(wǎng)址組成如下：

url = ELECTRON_MIRROR + ELECTRON_CUSTOM_DIR + '/' + ELECTRON_CUSTOM_FILENAME

例如，使用一個中國的鏡像：

ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"

默認(rèn)情況下，ELECTRON_CUSTTOM_DIR被設(shè)置為 v$VERSION。 要更改格式，請使用 {{ version }} 占位符。 例如，version-{{ version }} 被解析為 version-5.0.0, {{ version }} 被解析為 5.0.0， v{{ version }} 與默認(rèn)值等價。 更具體的例子，使用中國非CDN鏡像：

ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"
ELECTRON_CUSTOM_DIR="{{ version }}"

上述配置將從類似于 https://npmmirror.com/mirrors/electron/8.0.0/electron-v8.0.0-linux-x64.zip 這樣的網(wǎng)址下載。

如果您的鏡像在官方 Electron 版本中提供不同校驗和，你可能必須將 electron_use_remote_checksums=1 設(shè)置為 Electron 使用遠程 SHASUMS256.txt 文件來驗證校驗和 而不是嵌入校驗和。

緩存

或者，您可以覆蓋本地緩存。 electron-download 會將下載的二進制文件緩存在本地目錄中，不會增加網(wǎng)絡(luò)負(fù)擔(dān)。 您可以使用該緩存文件夾來提供 Electron 的定制版本，或者避免進行網(wǎng)絡(luò)連接。

• Linux: $XDG_CACHE_HOME or ~/.cache/electron/
• macOS: ~/Library/Caches/electron/
• Windows: $LOCALAPPDATA/electron/Cache or ~/AppData/Local/electron/Cache/

在使用舊版本 Electron 的環(huán)境中，您也可以在~/.electron中找到緩存。

您也可以通過提供一個 electron_config_cache 環(huán)境變量來覆蓋本地緩存位置。

緩存中包含了不同版本的官方 zip 文件以及校驗信息，以 [checksum]/[filename] 格式存儲。 典型的緩存可能看起來像這樣：

├── a91b089b5dc5b1279966511344b805ec84869b6cd60af44f800b363bba25b915
│   └── electron-v15.3.1-darwin-x64.zip

跳過二進制包下載

在底層, Electron 的 JavaScript API 綁定了包含默認(rèn)實現(xiàn)的二進制文件。 由于此二進制文件對于任何 Electron 應(yīng)用的功能都至關(guān)重要，因此每次當(dāng)你從 npm 注冊表安裝 electron 時，默認(rèn)情況下都會在 postinstall 步驟中下載該二進制文件。

但是，如果你想要安裝你的項目依賴，但不需要使用 Electron 功能。 你可以設(shè)置 ELECTRON_SKIP_BINARY_DOWNLOAD 環(huán)境變量來阻止二進制文件被下載。 例如，在運行模擬 electron 模塊的單元測試時，此功能在連續(xù)集成環(huán)境中很有用。

ELECTRON_SKIP_BINARY_DOWNLOAD=1 npm install

ELECTRON_SKIP_BINARY_DOWNLOAD=1 yarn install

故障排查

在運行 npm install electron 時，有些用戶會偶爾遇到安裝問題。

在大多數(shù)情況下，這些錯誤都是由網(wǎng)絡(luò)問題導(dǎo)致，而不是因為 electron npm 包的問題。 如 ELIFECYCLE、EAI_AGAIN、ECONNRESET 和 ETIMEDOUT 等錯誤都是此類網(wǎng)絡(luò)問題的標(biāo)志。 最佳的解決方法是嘗試切換網(wǎng)絡(luò)，或是稍后再嘗試安裝。

如果通過 npm 安裝失敗，你也可以嘗試通過從 electron/electron/release 直接下載 Electron

如果安裝失敗并報錯EACCESS，您可能需要修復(fù)npm權(quán)限。

如果上述報錯持續(xù)出現(xiàn)，unsafe-perm 標(biāo)志可能需要被設(shè)置為 true:

sudo npm install electron --unsafe-perm=true

在較慢的網(wǎng)絡(luò)上, 最好使用 --verbose 標(biāo)志來顯示下載進度:

npm install --verbose electron

如果需要強制重新下載文件, 并且 SHASUM 文件將 force_no_cache 環(huán)境變量設(shè)置為 true。