跳至主要內容

進階安裝說明

若要安裝預先建置的 Electron 二進制檔案,請使用 npm。較佳的方法是將 Electron 安裝為應用程式中的開發依賴項

npm install electron --save-dev

請參閱 Electron 版本控制文件,以瞭解如何在應用程式中管理 Electron 版本。

臨時執行 Electron

如果您情況緊急,且不想在本地專案中使用 npm install,您也可以使用 npm 捆綁的 npx 命令執行器來臨時執行 Electron

npx electron .

上述命令將使用 Electron 執行當前工作目錄。請注意,您的應用程式中的任何依賴項都不會被安裝。

自訂

如果您想要變更下載的架構 (例如,在 x64 電腦上使用 ia32),您可以在使用 npm install 時使用 --arch 旗標,或設定 npm_config_arch 環境變數

npm install --arch=ia32 electron

除了變更架構之外,您也可以使用 --platform 旗標來指定平台 (例如,win32linux 等)

npm install --platform=win32 electron

Proxy

如果您需要使用 HTTP proxy,您需要將 ELECTRON_GET_USE_PROXY 變數設定為任何值,此外還需要根據您的主機系統的 Node 版本設定其他環境變數

自訂鏡像和快取

在安裝期間,electron 模組將呼叫 @electron/get,以下載適用於您的平台的預先建置 Electron 二進制檔案。它將透過聯絡 GitHub 的發布下載頁面 (https://github.com/electron/electron/releases/tag/v$VERSION,其中 $VERSION 是 Electron 的確切版本) 來完成此操作。

如果您無法存取 GitHub,或需要提供自訂組建,您可以透過提供鏡像或現有快取目錄來完成此操作。

鏡像

您可以使用環境變數來覆寫基礎 URL、尋找 Electron 二進制檔案的路徑以及二進制檔案名稱。@electron/get 使用的 URL 組成如下

url = ELECTRON_MIRROR + ELECTRON_CUSTOM_DIR + '/' + ELECTRON_CUSTOM_FILENAME

例如,若要使用中國 CDN 鏡像

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

預設情況下,ELECTRON_CUSTOM_DIR 設定為 v$VERSION。若要變更格式,請使用 {{ version }} 預留位置。例如,version-{{ version }} 解析為 version-5.0.0{{ version }} 解析為 5.0.0,而 v{{ version }} 等同於預設值。作為更具體的範例,若要使用中國非 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 等 URL 下載。

如果您的鏡像提供的 Artifact 的校驗和與官方 Electron 發布版不同,您可能需要直接設定 electron_use_remote_checksums=1,或在 .npmrc 檔案中設定它,以強制 Electron 使用遠端 SHASUMS256.txt 檔案來驗證校驗和,而不是使用嵌入的校驗和。

快取

或者,您可以覆寫本機快取。@electron/get 會在本機目錄中快取下載的二進制檔案,以避免佔用您的網路資源。您可以使用該快取資料夾來提供 Electron 的自訂組建,或完全避免與網路連線。

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

在一直使用較舊版本 Electron 的環境中,您可能會在 ~/.electron 中找到快取。

您也可以透過提供 electron_config_cache 環境變數來覆寫本機快取位置。

快取包含版本的官方 zip 檔案以及校驗和,並儲存為 [checksum]/[filename]。典型的快取可能如下所示

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

略過二進制檔案下載

在底層,Electron 的 JavaScript API 會繫結至包含其實作的二進制檔案。由於此二進制檔案對於任何 Electron 應用程式的功能都至關重要,因此每次您從 npm 登錄檔安裝 electron 時,都會在 postinstall 步驟中預設下載它。

但是,如果您想要安裝專案的依賴項,但不需要使用 Electron 功能,您可以設定 ELECTRON_SKIP_BINARY_DOWNLOAD 環境變數,以防止下載二進制檔案。例如,當在持續整合環境中執行模擬 electron 模組的單元測試時,此功能可能會很有用。

ELECTRON_SKIP_BINARY_DOWNLOAD=1 npm install

疑難排解

執行 npm install electron 時,有些使用者偶爾會遇到安裝錯誤。

在幾乎所有情況下,這些錯誤都是網路問題造成的,而不是 electron npm 套件的實際問題。諸如 ELIFECYCLEEAI_AGAINECONNRESETETIMEDOUT 之類的錯誤都表示存在這類網路問題。最佳的解決方案是嘗試切換網路,或稍等片刻然後再次嘗試安裝。

如果透過 npm 安裝失敗,您也可以嘗試直接從 electron/electron/releases 下載 Electron。

如果安裝失敗並出現 EACCESS 錯誤,您可能需要修正您的 npm 權限

如果上述錯誤持續發生,則可能需要將 unsafe-perm 旗標設定為 true

sudo npm install electron --unsafe-perm=true

在較慢的網路上,建議使用 --verbose 旗標,以顯示下載進度

npm install --verbose electron

如果您需要強制重新下載資產和 SHASUM 檔案,請將 force_no_cache 環境變數設定為 true