Com.Scm.Upgrade 1.2.4

Upgrade.Net

基于 .NET 开发的应用程序升级程序，支持控制台和 WPF 两种版本，提供完整的下载、备份、解压、启动流程，支持自定义升级步骤配置。

项目简介

Upgrade.Net 是一个轻量级的 Windows 应用程序升级解决方案，支持从远程服务器下载更新包并自动完成版本升级。项目采用模块化设计，核心逻辑独立为类库，支持控制台和 WPF 两种版本：

• Upgrade.Net：核心类库，包含升级配置、步骤执行、操作定义等核心逻辑
• Upgrade.Cmd：控制台版本，适合后台静默升级场景
• Upgrade.Wpf：WPF 界面版本，提供可视化升级进度和用户交互

功能特性

• 自定义升级步骤：支持通过 JSON 配置文件定义动态升级步骤序列
• 17种操作类型：下载、上传、命令执行、启动程序、压缩、解压、移动、复制、创建、删除、更名等
• 等待时间：每个步骤可配置等待时间，支持倒计时显示
• 重试机制：支持配置重试次数和重试延迟
• 自动启动：支持升级完成后自动启动主程序，支持 dotnet 命令启动
• 进度显示：实时显示下载、备份、解压进度和状态信息
• 暂停/取消：WPF 版本支持下载暂停、继续、取消功能
• 配置文件：支持 JSON 格式的升级配置文件
• 视图接口：通过 UpgradeView 接口实现控制台和 WPF 版本的视图复用

界面截图

版本	界面截图
WPF 版本
WPF 版本
WPF 版本
控制台版本
控制台版本
控制台版本

软件架构

核心类库 (Upgrade.Net)

• 目标框架：.NET 10.0
• 输出类型：类库
• 核心组件：
  • Upgrade：升级核心逻辑，动态步骤执行引擎
  • UpgradeView：视图接口，实现控制台和 WPF 视图复用
  • UpgradeConfig：升级配置管理类
  • StepConfig：步骤配置类及静态工厂方法
  • UpgradeAction：升级操作类（策略模式）
  • UpgradeOption：操作类型枚举（17种）
  • UpgradeResult：操作执行结果
  • StepStatus：步骤状态枚举

控制台版本 (Upgrade.Cmd)

• 目标框架：.NET 10.0
• 输出类型：控制台应用程序
• 网络请求：HttpClient（静态复用）
• 数据交换：Newtonsoft.Json
• 核心文件：UpgradeCommand.cs（实现 UpgradeView 接口）

WPF 版本 (Upgrade.Wpf)

• 目标框架：.NET 10.0-windows
• 输出类型：WPF 桌面应用程序
• 架构模式：MVVM
• 网络请求：HttpClient（静态复用）
• 数据交换：Newtonsoft.Json
• 界面风格：中国蓝主题，无边框窗口设计
• 核心组件：UpgradeWindowViewModel（实现 UpgradeView 接口）

核心模块

配置文件说明

upgrade.json

{
  "icon": "your_icon.ico",
  "title": "your_app_title",
  "oldVersion": "1.0.0",
  "newVersion": "2.0.0",
  "autoStart": true,
  "autoClose": false,
  "showSteps": true,
  "logToFile": false,
  "appInfo": "应用描述信息，支持较长文本自动滚动",
  "verInfo": "版本升级说明，支持较长文本自动滚动",
  "steps": [
    {
      "title": "下载更新包",
      "description": "从服务器下载最新版本更新包",
      "option": "Download",
      "url": "https://example.com/upgrade.zip",
      "file": "upgrade.zip",
      "waitTime": 5
    },
    {
      "title": "上传日志文件",
      "description": "将应用日志上传到服务器",
      "option": "Upload",
      "url": "https://example.com/api/upload",
      "file": "app.log",
      "waitTime": 0
    },
    {
      "title": "备份现有文件",
      "description": "备份当前安装目录下的所有文件",
      "option": "Zip",
      "source": "your_app_install_path",
      "destination": "backup.zip",
      "waitTime": 0
    },
    {
      "title": "解压更新包",
      "description": "将更新包解压到安装目录",
      "option": "Unzip",
      "source": "upgrade.zip",
      "destination": "your_app_install_path",
      "overwrite": true,
      "waitTime": 0
    },
    {
      "title": "清理临时文件",
      "description": "删除下载的临时文件",
      "option": "DeleteDoc",
      "path": "upgrade.zip",
      "waitTime": 0
    },
    {
      "title": "启动应用程序",
      "description": "启动升级后的应用程序（不等待执行完成）",
      "option": "Launch",
      "command": "dotnet MyApp.dll",
      "args": "--environment Production",
      "waitTime": 0
    }
  ]
}

配置字段说明

基础配置

步骤配置 (steps)

每个步骤包含以下属性：

UpgradeOption 操作类型说明

完整示例配置

以下是包含所有操作类型的完整配置示例：

{
  "icon": "logo.ico",
  "title": "应用升级程序",
  "oldVersion": "1.0.0",
  "newVersion": "2.0.0",
  "autoStart": true,
  "autoClose": false,
  "showSteps": true,
  "logToFile": true,
  "appInfo": "这是一个基于 .NET 开发的应用程序升级工具，支持自定义升级步骤配置。",
  "verInfo": "版本 2.0.0 更新说明：\n1. 新增自定义步骤功能\n2. 支持17种操作类型（新增上传功能）\n3. 添加重试机制\n4. 优化界面布局\n5. option字段支持字符串枚举名称\n6. 新增logToFile配置属性，支持日志记录到文件",
  "steps": [
    {
      "title": "创建临时目录",
      "description": "创建升级临时目录",
      "option": "CreateDir",
      "path": "D:\\MyApp\\temp",
      "waitTime": 0
    },
    {
      "title": "下载更新包",
      "description": "从服务器下载最新版本更新包",
      "option": "Download",
      "url": "https://example.com/upgrade.zip",
      "file": "D:\\MyApp\\temp\\upgrade.zip",
      "waitTime": 2
    },
    {
      "title": "备份现有文件",
      "description": "备份当前安装目录下的所有文件",
      "option": "Zip",
      "source": "D:\\MyApp",
      "destination": "D:\\MyApp\\backup\\backup_20240101.zip",
      "waitTime": 3
    },
    {
      "title": "解压更新包",
      "description": "将更新包解压到安装目录",
      "option": "Unzip",
      "source": "D:\\MyApp\\temp\\upgrade.zip",
      "destination": "D:\\MyApp",
      "overwrite": true,
      "waitTime": 0
    },
    {
      "title": "复制配置文件",
      "description": "复制额外的配置文件",
      "option": "CopyDoc",
      "source": "D:\\MyApp\\temp\\appsettings.json",
      "destination": "D:\\MyApp\\appsettings.json",
      "overwrite": false,
      "waitTime": 0
    },
    {
      "title": "复制插件目录",
      "description": "复制插件目录到安装目录",
      "option": "CopyDir",
      "source": "D:\\MyApp\\temp\\Plugins",
      "destination": "D:\\MyApp\\Plugins",
      "overwrite": true,
      "waitTime": 0
    },
    {
      "title": "移动数据目录",
      "description": "移动数据目录到新位置",
      "option": "MoveDir",
      "source": "D:\\MyApp\\data_old",
      "destination": "D:\\MyApp\\data",
      "overwrite": true,
      "waitTime": 0
    },
    {
      "title": "移动旧日志文件",
      "description": "移动旧日志文件到备份目录",
      "option": "MoveDoc",
      "source": "D:\\MyApp\\app.log",
      "destination": "D:\\MyApp\\backup\\app.log",
      "overwrite": true,
      "waitTime": 0
    },
    {
      "title": "创建配置文件",
      "description": "创建新的配置文件",
      "option": "CreateDoc",
      "path": "D:\\MyApp\\new_config.json",
      "overwrite": true,
      "waitTime": 0
    },
    {
      "title": "更名旧文件",
      "description": "更名旧版本日志文件",
      "option": "RenameDoc",
      "oldName": "D:\\MyApp\\logs\\app.log",
      "newName": "D:\\MyApp\\logs\\app_old.log",
      "waitTime": 0
    },
    {
      "title": "更名旧目录",
      "description": "更名旧版本目录",
      "option": "RenameDir",
      "oldName": "D:\\MyApp\\bin_old",
      "newName": "D:\\MyApp\\bin_backup",
      "waitTime": 0
    },
    {
      "title": "执行安装脚本",
      "description": "执行安装后脚本（等待完成）",
      "option": "Command",
      "command": "powershell",
      "args": "-ExecutionPolicy Bypass -File install.ps1",
      "retryCount": 2,
      "retryDelay": 2000,
      "waitTime": 5
    },
    {
      "title": "清理临时文件",
      "description": "删除下载的临时文件",
      "option": "DeleteDoc",
      "path": "D:\\MyApp\\temp\\upgrade.zip",
      "waitTime": 0
    },
    {
      "title": "删除临时目录",
      "description": "删除升级临时目录",
      "option": "DeleteDir",
      "path": "D:\\MyApp\\temp",
      "waitTime": 0
    },
    {
      "title": "启动应用程序",
      "description": "启动升级后的应用程序（不等待执行完成）",
      "option": "Launch",
      "command": "dotnet MyApp.dll",
      "args": "--environment Production",
      "waitTime": 0
    }
  ]
}

使用说明

详细文档

完整的使用说明请参考 DOCS/使用说明.md，包含：

• 核心概念详解
• 配置文件完整说明
• 代码集成示例
• 升级流程详解
• 高级特性（重试机制、等待时间、错误处理等）

配置升级信息

1. 编辑 upgrade.json 配置文件
2. 设置基础配置项（icon、title、installPath 等）
3. 根据需要配置 steps 数组，定义升级步骤序列
4. 每个步骤选择合适的 option 操作类型，并提供相应参数

运行升级程序

控制台版本

cd Upgrade.Net
dotnet run

WPF 版本

cd Upgrade.Wpf
dotnet run

升级流程

动态步骤执行流程

升级程序会按照 steps 数组定义的顺序依次执行每个步骤：

1. 解析配置文件，加载 steps 数组
2. 遍历每个步骤，根据 option 创建对应的 UpgradeAction
3. 执行步骤的 Execute 方法
4. 如果 waitTime > 0，显示倒计时提示
5. 如果 retryCount > 0 且执行失败，进行重试
6. 根据 continueOnError 决定是否继续执行后续步骤
7. 所有步骤执行完成后，根据 autoStart 和 autoClose 配置决定是否启动应用和关闭程序

步骤执行状态

每个步骤执行时会显示以下状态：

项目结构

Upgrade.Net/
├── Upgrade.Net/              # 核心类库
│   ├── Config/
│   │   ├── UpgradeConfig.cs  # 升级配置管理类
│   │   └── StepConfig.cs     # 步骤配置类及静态工厂方法
│   ├── Resources/
│   │   ├── logo.ico          # 程序图标
│   │   └── logo128.png       # 图标文件（NuGet包图标）
│   ├── Upgrade.cs            # 升级核心逻辑（动态步骤执行引擎）
│   ├── UpgradeView.cs        # 视图接口（实现控制台/WPF复用）
│   ├── UpgradeAction.cs      # 升级操作类（策略模式）
│   ├── UpgradeOption.cs      # 操作类型枚举（17种）
│   ├── UpgradeResult.cs      # 操作执行结果类
│   ├── StepStatus.cs         # 步骤状态枚举
│   ├── app_offline.htm       # 应用离线页面模板
│   └── Upgrade.Net.csproj    # 类库项目文件
├── Upgrade.Cmd/              # 控制台版本
│   ├── Resources/
│   │   └── logo.ico          # 程序图标
│   ├── Program.cs            # 程序入口
│   ├── UpgradeCommand.cs     # 控制台视图实现（实现UpgradeView接口）
│   ├── Upgrade.json          # 配置文件
│   ├── Upgrade.Cmd.csproj    # 项目文件
│   ├── build.bat             # Windows构建脚本
│   ├── build.ps1             # PowerShell构建脚本
│   └── build.sh              # Linux构建脚本
├── Upgrade.Wpf/              # WPF 版本
│   ├── Dvo/
│   │   ├── StepItemDvo.cs    # 步骤列表项数据模型
│   │   ├── ScmDvo.cs         # 数据绑定对象
│   │   └── RelayCommand.cs   # 命令绑定实现
│   ├── Resources/
│   │   └── logo.ico          # 程序图标
│   ├── App.xaml              # 应用程序入口（资源字典）
│   ├── App.xaml.cs           # 应用程序代码
│   ├── UpgradeWindow.xaml    # 升级窗口
│   ├── UpgradeWindow.xaml.cs # 升级窗口代码
│   ├── UpgradeWindowViewModel.cs # 升级窗口ViewModel（实现UpgradeView接口）
│   ├── Upgrade.json          # 配置文件
│   ├── Upgrade.Wpf.csproj    # 项目文件
│   ├── build.bat             # Windows构建脚本
│   ├── build.ps1             # PowerShell构建脚本
│   └── build.sh              # Linux构建脚本
├── release/                  # 发布版本目录
├── screenshots/              # 界面截图目录
├── .gitignore
├── LICENSE
├── README.md
├── README.en.md
└── Upgrade.Net.slnx          # 解决方案文件

技术要求

• .NET 10.0+
• Windows 7 及以上操作系统
• 支持控制台编码：GBK/UTF-8

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

许可证

本项目遵循 MIT 许可证。