跳到主要内容

autoUpdater

使应用程序能够自动更新。

进程：主进程

另请参阅：关于如何在应用程序中实现更新的详细指南。

autoUpdater 是一个 EventEmitter。

平台注意事项​

目前，仅支持 macOS 和 Windows。Linux 上没有内置的自动更新支持，因此建议使用发行版的包管理器来更新您的应用程序。

此外，每个平台都存在一些细微的差异

macOS​

在 macOS 上，autoUpdater 模块基于 Squirrel.Mac 构建，这意味着您无需任何特殊设置即可使其工作。有关服务器端要求，您可以阅读 服务器支持。请注意，App Transport Security (ATS) 适用于作为更新过程一部分发出的所有请求。需要禁用 ATS 的应用程序可以将 NSAllowsArbitraryLoads 键添加到其应用程序的 plist 中。

信息

您的应用程序必须在 macOS 上进行签名才能进行自动更新。这是 Squirrel.Mac 的要求。

Windows​

在 Windows 上，您必须先将应用程序安装到用户的机器上才能使用 autoUpdater，因此建议您使用 electron-winstaller 或 Electron Forge 的 Squirrel.Windows maker 来生成 Windows 安装程序。

使用 Squirrel.Windows 构建的应用程序将触发 自定义启动事件，您的 Electron 应用程序必须处理这些事件以确保正确的安装和卸载。

Squirrel.Windows 应用程序在安装后会立即以 --squirrel-firstrun 参数启动。在此期间，Squirrel.Windows 将对您的应用程序获取文件锁，并且 autoUpdater 请求将失败，直到锁被释放。实际上，这意味着您在首次启动的前几秒内将无法检查更新。您可以通过在 process.argv 包含 --squirrel-firstrun 标志时不检查更新，或者在更新检查上设置 10 秒超时来解决此问题（有关更多信息，请参阅 electron/electron#7155）。

使用 Squirrel.Windows 生成的安装程序将创建一个快捷方式图标，其 应用程序用户模型 ID 格式为 com.squirrel.PACKAGE_ID.YOUR_EXE_WITHOUT_DOT_EXE，例如 com.squirrel.slack.Slack 和 com.squirrel.code.Code。您必须将相同的 ID 与 app.setAppUserModelId API 用于您的应用程序，否则 Windows 将无法在任务栏中正确固定您的应用程序。

事件​

autoUpdater 对象会发出以下事件

事件：'error'​

返回

  • error 错误

更新时发生错误时发出。

事件：'checking-for-update'​

开始检查可用更新时发出。

事件：'update-available'​

有可用更新时发出。更新会自动下载。

事件：'update-not-available'​

没有可用更新时发出。

事件：'update-downloaded'​

返回

  • event 事件
  • releaseNotes 字符串
  • releaseName 字符串
  • releaseDate 日期
  • updateURL 字符串

更新下载完成后发出。

仅在 Windows 上，releaseName 可用。

注意

并非必须处理此事件。成功下载的更新仍会在应用程序下次启动时应用。

事件：'before-quit-for-update'​

此事件在用户调用 quitAndInstall() 后发出。

调用此 API 时，before-quit 事件不会在所有窗口关闭之前发出。因此，如果您希望在进程退出时在窗口关闭之前执行操作，则应该监听此事件，同时也要监听 before-quit。

方法​

autoUpdater 对象具有以下方法

autoUpdater.setFeedURL(options)​

  • options 对象
    • url 字符串
    • headers Record<string, string> (可选) macOS - HTTP 请求头。
    • serverType 字符串 (可选) macOS - 可以是 json 或 default，有关更多信息，请参阅 Squirrel.Mac README。

设置 url 并初始化自动更新器。

autoUpdater.getFeedURL()​

返回 string - 当前的更新源 URL。

autoUpdater.checkForUpdates()​

询问服务器是否有更新。在使用此 API 之前，您必须调用 setFeedURL。

注意

如果有可用更新，它将自动下载。调用 autoUpdater.checkForUpdates() 两次将下载更新两次。

autoUpdater.quitAndInstall()​

下载更新后重启应用程序并安装。此方法应仅在 update-downloaded 事件发出后调用。

在底层，调用 autoUpdater.quitAndInstall() 将首先关闭所有应用程序窗口，并在所有窗口关闭后自动调用 app.quit()。

注意

并非必须调用此函数来应用更新，因为成功下载的更新始终会在应用程序下次启动时应用。