自动升级组件 AutoUpgrade 使用指南

自动升级组件 AutoUpgrade 使用指南

AutoUpgrade 一个非常简单、轻量级的自动升级组件，以Ftp Server作为升级服务器，可自动升级其托管的Windows软件 项目地址: https://gitcode.com/gh_mirrors/aut/AutoUpgrade

项目介绍

AutoUpgrade 是一个轻量级的自动升级解决方案，专为 Windows 应用设计。它利用 FTP 服务器作为升级包的存放平台，使得托管的 Windows 软件能够实现无缝自动更新。该组件由纯 C# 编写，基于 .NET Framework 4.0，确保兼容从 XP SP3 起的各版本 Windows 系统。AutoUpgrade 包含升级核心功能库和版本信息生成工具两个关键部分，便于开发者集成到自己的应用程序中。

项目快速启动

安装与配置

1. 克隆项目：首先，通过 Git 克隆此项目到本地。

   git clone https://github.com/zenglo/AutoUpgrade.git
   

2. 环境准备：确保你的开发环境已经安装了 .NET Framework 4.0 或更高版本，并且具备FTP服务器以便存放升级包。

3. 编译与部署：打开解决方案，编译 Zl.AutoUpgrade.Core 和生成必要的升级工具 VersionInfoBuilder.exe。

示例应用

• 快速尝试升级流程:

  在你的应用中添加对 Zl.AutoUpgrade.Core.dll 的引用，并在启动时调用升级逻辑。以下是一个简化的示例：

  using Zl.AutoUpgrade;
  
  static void Main(string[] args)
  {
      try
      {
          var config = new UpgradeConfig
          {
              FtpHost = "your	ftp.server.com",
              FtpUser = "username",
              FtpPassword = "password",
              FtpOverTLS = true,
              TargetAssembly = Assembly.GetExecutingAssembly()
          };
  
          switch (AutoUpdater.TryUpgrade(config))
          {
              case UpgradeStatus.Started:
              case UpgradeStatus.UpgradeInProgress:
                  // 升级已经开始，当前执行环境将退出，升级完成后自动重启
                  return;
              case UpgradeStatus.NoNewVersion:
                  MessageBox.Show("当前已是最新版本。");
                  break;
              case UpgradeStatus.UpgradeCompleted:
                  MessageBox.Show("升级完成，可以开始使用。");
                  break;
              default:
                  break;
          }
      }
      catch (Exception ex)
      {
          MessageBox.Show($"升级时发生错误: {ex.Message}");
      }
      // 继续你的应用程序逻辑...
  }
  

FTP服务器设置

• 准备一个FTP服务器，创建一个帐户仅供升级使用，并将生成的升级包以及由 VersionInfoBuilder.exe 生成的版本信息文件上传至FTP服务器指定目录。

应用案例和最佳实践

• 最佳实践：建议在每次启动应用程序时检查更新，但避免频繁打扰用户。可以通过后台线程执行检查，仅当检测到可用更新时通知用户或者自动进行静默更新。
• 定时检查：可通过计划任务或后台服务定时执行升级检查逻辑，保持应用始终是最新的状态。
• 用户体验：确保升级过程中提供清晰的反馈，例如升级进度条或状态消息，以提升用户感知。

典型生态项目

由于本项目专注于软件的自动升级能力，它本身不直接构成一个生态系统。然而，在实际应用中，AutoUpgrade 可与其他监控和自动化部署工具结合，如Jenkins、GitLab CI/CD等，构建起更全面的持续集成和持续部署（CI/CD）生态系统。通过这样的整合，开发者能够自动化整个软件的构建、测试、部署到自动更新的全过程，大大提高了软件发布的效率和可靠性。

---

本指南旨在提供快速入门与基础使用方法，对于更复杂的应用场景，建议深入研究项目文档及源码。

AutoUpgrade 一个非常简单、轻量级的自动升级组件，以Ftp Server作为升级服务器，可自动升级其托管的Windows软件 项目地址: https://gitcode.com/gh_mirrors/aut/AutoUpgrade