• 环境变量
    • 生产环境相关变量
      • NODE_OPTIONS
      • GOOGLE_API_KEY
      • ELECTRON_NO_ASAR
      • ELECTRON_RUN_AS_NODE
      • ELECTRON_NO_ATTACH_CONSOLE Windows
      • ELECTRON_FORCE_WINDOW_MENU_BAR Linux
      • ELECTRON_TRASH Linux
    • 开发环境相关变量
      • ELECTRON_ENABLE_LOGGING
      • ELECTRON_LOG_ASAR_READS
      • ELECTRON_ENABLE_STACK_DUMPING
      • ELECTRON_DEFAULT_ERROR_MODE Windows
      • ELECTRON_OVERRIDE_DIST_PATH

    环境变量

    在不更改代码的情况下控制应用程序配置和行为。

    Electrond的某些行为受环境变量的控制, 因为它们比命令行标志和应用程序的代码更早初始化。

    POSIX shell示例:

    1. $ export ELECTRON_ENABLE_LOGGING=true
    2. $ electron

    Windows 控制台示例:

    1. > set ELECTRON_ENABLE_LOGGING=true
    2. > electron

    生产环境相关变量

    以下环境变量主要用于在打包后的Electron应用运行时使用。

    NODE_OPTIONS

    Electron includes support for a subset of Node's NODE_OPTIONS. The majority are supported with the exception of those which conflict with Chromium's use of BoringSSL.

    示例:

    1. export NODE_OPTIONS="--no-warnings --max-old-space-size=2048"

    Unsupported options are:

    1. --use-bundled-ca
    2. --force-fips
    3. --enable-fips
    4. --openssl-config
    5. --use-openssl-ca

    NODE_OPTIONS are explicitly disallowed in packaged apps.

    GOOGLE_API_KEY

    Electron包含一个硬编码的 API key用于请求谷歌的地理编码服务。 由于此 API key包含在每个版本的Electron中, 因此它通常超过其使用限额。 为了应对这一情况，您可以在环境中提供自己的 Google API key。 在打开将进行地理编码请求的任何Browser窗口之前, 请在主进程文件中放置以下代码:

    1. process.env.GOOGLE_API_KEY = 'YOUR_KEY_HERE'

    有关如何获取 Google API key的说明, 请访问 这里 。

    默认情况下, 可能不允许新生成的 Google API key进行地理编码请求。 若要启用地理编码请求, 请访问 这里 。

    ELECTRON_NO_ASAR

    禁用 ASAR 支持。仅在设置了 ELECTRON_RUN_AS_NODE变量的fork或spawn的子进程中支持此变量。

    ELECTRON_RUN_AS_NODE

    当做普通Node.js进程启动。

    ELECTRON_NO_ATTACH_CONSOLE Windows

    不附加到当前控制台会话。

    ELECTRON_FORCE_WINDOW_MENU_BAR Linux

    不使用 Linux 的全局菜单栏。

    ELECTRON_TRASH Linux

    在Linux中设置回收站的实现，默认为gio。

    Options:

    • gvfs-trash
    • trash-cli
    • kioclient5
    • kioclient

    开发环境相关变量

    以下环境变量主要用于开发和调试目的。

    ELECTRON_ENABLE_LOGGING

    将 Chrome 的内部日志打印到控制台。

    ELECTRON_LOG_ASAR_READS

    当Electron读取ASAR 文件时, 将读取偏移量和文件路径记录到系统 tmpdir。生成的文件可以提供给 ASAR 模块以优化文件排序。

    ELECTRON_ENABLE_STACK_DUMPING

    当Electron崩溃时, 将跟踪堆栈输出到控制台。

    如果 crashReporter已经启动了, 则此环境变量将不起作用。

    ELECTRON_DEFAULT_ERROR_MODE Windows

    当Electron崩溃时显示 Windows 的崩溃对话框。

    如果 crashReporter已经启动了, 则此环境变量将不起作用。

    ELECTRON_OVERRIDE_DIST_PATH

    由 electron 包运行时，该变量告知 electron命令使用指定构件代替由npm install下载的构件。 用法:

    1. export ELECTRON_OVERRIDE_DIST_PATH=/Users/username/projects/electron/out/Debug