更新 Electron 应用程序 - 使用 `update-electron-app`

更新 Electron 应用程序 - 使用 update-electron-app

项目地址:https://gitcode.com/gh_mirrors/up/update-electron-app

1. 项目目录结构及介绍

在 update-electron-app 项目中，主要的目录和文件包括：

.
├── package.json        # 项目包文件，包含项目信息和依赖
├── src                 # 主要的源代码目录
│   ├── main.js         # 主进程（后台）脚本
│   └── renderer.js     # 渲染进程（前端）脚本
└── update-electron-app # 包含自动更新逻辑的模块

• package.json: 定义了项目的元数据，如项目名、版本号以及依赖。
• src/main.js: 应用的主进程代码，通常用于初始化和管理应用程序的行为，包括设置自动更新。
• src/renderer.js: 渲染进程代码，负责 UI 和用户的交互。

2. 项目启动文件介绍

main.js

主进程文件是应用的核心部分，一般用于处理系统级任务和跨窗口通信。在 update-electron-app 中，main.js 的主要功能可能是初始化自动更新机制，例如：

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

app.whenReady().then(() => {
  // 初始化自动更新模块
  updateElectronApp()

  // 其他主进程操作...
})

renderer.js

渲染进程文件处理用户界面和视图组件。虽然 update-electron-app 模块主要在主进程中使用，但在渲染进程中可能需要显示更新提示或处理用户反馈。

const { remote } = require('electron')
const { autoUpdater } = remote

// 在渲染进程中监听自动更新事件
autoUpdater.on('update-available', () => {
  // 显示更新可用的通知
})

autoUpdater.on('update-downloaded', () => {
  // 提示用户安装更新
})

3. 项目的配置文件介绍

update-electron-app 配置主要是在调用模块时通过参数传递的。这通常涉及到选择更新源、更新间隔和日志记录等选项。例如：

const { updateElectronApp, UpdateSourceType } = require('update-electron-app')

// 使用 update-electron-org 服务
updateElectronApp([
  updateSource: [
    type: UpdateSourceType.ElectronPublicUpdateService,
    repo: 'your-github-username/your-repo',
  ],
  updateInterval: '1 hour',
  logger: require('electron-log'),
])

// 或者使用静态存储（如 S3）
updateElectronApp([
  updateSource: [
    type: UpdateSourceType.StaticStorage,
    baseUrl: `https://your-bucket.s3.amazonaws.com/your-app-updates/${process.platform}/${process.arch}`,
  ],
])

在这个配置中：

• updateSource.type：指定更新服务类型，可以是 ElectronPublicUpdateService（官方 GitHub 更新服务）或 StaticStorage（自托管静态文件）。
• updateSource.repo 或 baseUrl：根据更新源类型，提供相应的仓库URL或基础URL。
• updateInterval：设置检查更新的频率。
• logger：可选的日志模块，用于记录自动更新过程中的信息。

请注意，具体的配置项可能还需要根据你的应用程序和部署策略进行调整。详细信息应参考官方文档以获取最新和完整的配置说明。

update-electron-app 🌲 A drop-in module that adds autoUpdating capabilities to Electron apps 项目地址: https://gitcode.com/gh_mirrors/up/update-electron-app