NetSparkle更新框架教程

余印榕

于 2024-08-19 10:50:41 发布

阅读量302

点赞数 3

本文链接：https://blog.csdn.net/gitblog_00683/article/details/141319719

版权

NetSparkle更新框架教程

NetSparkleNetSparkle is a C# software update framework for .NET developers compatible with .NET Core/.NET 5+, WinForms, WPF, and Avalonia; uses Ed25519 or DSA signatures! View basic usage here in the README or visit our website for code docs.项目地址:https://gitcode.com/gh_mirrors/ne/NetSparkle

项目介绍

NetSparkle是一款专为.NET开发者设计的软件更新框架，支持.NET Core, .NET 4.6.2及以上版本，包括WinForms、WPF和Avalonia界面库。它的灵感源自于Cocoa开发者的Sparkle项目及WinSparkle项目（Windows平台的实现）。NetSparkle采用MIT许可协议，允许开发者在Windows、Mac或Linux平台上轻松集成软件自动更新功能。该框架经历了多个版本迭代，如今支持自定义UI、一次性检查更新以及通过NLog进行日志记录等特性。

项目快速启动

要迅速启用NetSparkle到你的.NET项目中，请遵循以下步骤：

添加依赖

首先，确保你的开发环境已准备好Visual Studio 2010或更高版本。然后，通过NuGet包管理器添加NetSparkleUpdater核心包到你的项目：

Install-Package NetSparkleUpdater

配置NetSparkle

在你的应用程序启动时初始化NetSparkle。这通常在Program.cs中的主方法完成：

using NetSparkleUpdater;

static void Main(string[] args)
{
    var updater = new Sparkle(updaterConfig =>
    {
        updaterConfig.AppUniqueIdentifier = "com.example.myapp";
        updaterConfig.UpdateCheckInterval = TimeSpan.FromDays(1); // 每天检查一次更新
        updaterConfig.IsAutoCheckingForUpdatesEnabled = true;
        updaterConfig.UserAgent = "MyAppName Update Checker";
        updaterConfig.DisableUpdateChecksByDefault = false;
        updaterConfig.ShowReleaseNotesIfAvailable = true;
        updaterConfig.DeltaUpdatesEnabled = true; // 如果服务器提供增量更新
        updaterConfig.AppCastUrl = "https://example.com/path/to/appcast.xml"; // 更新信息XML地址
    });

    updater.CheckForUpdatesAsync(); // 异步检查更新
}

创建AppCast文件

你需要在服务器上放置一个AppCast XML文件，其中包含版本信息和下载链接：

<?xml version="1.0"?>
<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" xmlns:dc="http://purl.org/dc/elements/1.1/">
    <channel>
        <title>My App</title>
        <link>https://example.com/my-app</link>
        <description>My App description</description>
        <item>
            <title>V1.0.1 Release</title>
            <sparkle:releaseNotes><![CDATA[改善性能，修复关键bug]]></sparkle:releaseNotes>
            <enclosure url="https://example.com/downloads/v1.0.1/myapp.exe" type="application/octet-stream" sparkle:version="1.0.1"/>
        </item>
    </channel>
</rss>