跳转到主要内容

autoUpdater

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

进程：主进程

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

autoUpdater 是一个EventEmitter。

平台注意事项​

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

此外，每个平台都有一些细微的差别

macOS​

在 macOS 上，autoUpdater 模块建立在 Squirrel.Mac 之上，这意味着您无需任何特殊设置即可使其正常工作。有关服务器端要求，您可以阅读 服务器支持。请注意，应用传输安全 (ATS) 适用于更新过程中发出的所有请求。需要禁用 ATS 的应用程序可以在其应用程序的 plist 中添加 NSAllowsArbitraryLoads 键。

信息

您的应用程序必须经过签名才能在 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 为您的应用程序设置 ID，否则 Windows 将无法在任务栏中正确固定您的应用程序。

事件​

autoUpdater 对象发出以下事件

事件：‘error’​

返回

  • error 错误

在更新过程中出现错误时发出。

事件：‘checking-for-update’​

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

事件：‘update-available’​

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

事件：‘update-not-available’​

没有可用更新时发出。

事件：‘update-downloaded’​

返回

  • event Event
  • releaseNotes 字符串
  • releaseName 字符串
  • releaseDate 日期
  • updateURL 字符串

更新已下载时发出。

仅在 Windows 上提供 releaseName。

注意

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

事件：‘before-quit-for-update’​

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

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

方法​

autoUpdater 对象具有以下方法

autoUpdater.setFeedURL(options)​

  • options Object
    • url string
    • headers Record<string, string> (可选) macOS - HTTP 请求头。
    • serverType string (可选) 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()。

注意

要应用更新，调用此函数并非严格必需，因为成功下载的更新将在下次应用程序启动时始终被应用。