更新应用

## 使用 update.electronjs.org {#using-updateelectronjsorg}

Electron 团队维护着 [update.electronjs.org][]，这是一个免费且开源的
Web 服务，Electron 应用可以使用它进行自我更新。该服务面向
满足以下条件的 Electron 应用：

- 应用运行在 macOS 或 Windows 上
- 应用拥有公开的 GitHub 仓库
- 构建产物已发布到 [GitHub Releases][gh-releases]
- 构建产物已[代码签名](code-signing.md) **（仅限 macOS）**

使用该服务最简单的方式是安装 [update-electron-app][]，
这是一个已预配置用于 update.electronjs.org 的 Node.js 模块。

使用你选择的 Node.js 包管理器安装该模块：

```sh npm2yarn
npm install update-electron-app

默认情况下，该模块会在应用启动时检查更新，然后每十
分钟检查一次。当发现更新时，它会在后台自动下载。
下载完成后，会显示一个对话框，允许用户重启应用。

如果你需要自定义配置，可以
[向 update-electron-app 传递选项][update-electron-app]
或
[直接使用更新服务][update.electronjs.org]。

## 使用其他更新服务 {#using-other-update-services}

如果你正在开发一个私有的 Electron 应用，或者你并未
将版本发布到 GitHub Releases，则可能需要运行你自己的
更新服务器。

### 步骤 1：部署更新服务器 {#step-1-deploying-an-update-server}

根据你的需求，你可以从以下选项中选择：

- [Hazel][hazel] – 面向私有或开源应用的更新服务器，可以
  免费部署在 [Vercel][vercel] 上。它从 [GitHub Releases][gh-releases]
  拉取，并利用 GitHub CDN 的能力。
- [Nuts][nuts] – 同样使用 [GitHub Releases][gh-releases]，但会将应用
  更新缓存到磁盘，并支持私有仓库。
- [electron-release-server][electron-release-server] – 提供用于
  处理版本发布的仪表板，并且不要求版本必须源自 GitHub。
- [Nucleus][nucleus] – 由 Atlassian 维护的面向 Electron 应用的完整更新服务器。支持多个应用和通道；使用静态文件存储
  来最小化服务器成本。

部署好更新服务器后，你可以在应用代码中添加相应逻辑，以通过 Electron 的 [autoUpdater](../api/auto-updater.md) 模块接收并
应用更新。

### 步骤 2：在应用中接收更新 {#step-2-receiving-updates-in-your-app}

首先，在主进程代码中导入所需模块。以下代码可能
因不同的服务器软件而异，但在使用 [Hazel][hazel] 时，其工作方式与上述描述一致。



:::warning 检查你的执行环境！

请确保下面的代码只会在你的打包应用中执行，而不在开发环境中执行。
你可以使用 [app.isPackaged](../api/app.md#appispackaged-readonly) API 来检查环境。

:::

```js title='main.js'
const { app, autoUpdater, dialog } = require('electron')

const server = 'https://your-deployment-url.com'
const url = `${server}/update/${process.platform}/${app.getVersion()}`

autoUpdater.setFeedURL({ url })

setInterval(() => {
  autoUpdater.checkForUpdates()
}, 60000)

同时确保错误[被处理](../api/auto-updater.md#event-error)。下面是一个将它们记录到 `stderr` 的示例：

```js title="main.js"
autoUpdater.on('error', (message) => {
  console.error('There was a problem updating the application')
  console.error(message)
})

const { app, autoUpdater } = require('electron')

const server = 'https://your-deployment-url.com'
// e.g. for Windows and app version 1.2.3
// https://your-deployment-url.com/update/win32/1.2.3
const url = `${server}/update/${process.platform}/${app.getVersion()}`

autoUpdater.setFeedURL({ url })

B0892F3C7AC91D72A6271FF36905FEF8FE993520 https://your-static.storage/your-app-1.2.3-full.nupkg 103298365

{
    "url": "https://your-static.storage/your-app-1.2.3-darwin.zip",
    "name": "1.2.3",
    "notes": "These are some release notes innit",
    "pub_date": "2024-09-18T12:29:53+01:00"
}