AutoUpdater自动更新简介

AutoUpdater.NET

Build status Donate

AutoUpdater.NET是一个类库，允许.NET开发人员轻松地将自动更新功能添加到其经典的桌面应用程序项目中。

NuGet软件包 NuGet NuGet
PM> Install-Package Autoupdater.NET.Official
怎么运行的
AutoUpdater.NET从您的服务器下载包含更新信息的XML文件。它使用此XML文件来获取有关软件最新版本的信息。如果该软件的最新版本大于安装在User PC上的当前软件版本，则AutoUpdater.NET将向用户显示更新对话框。如果用户按下更新按钮来更新软件，则它将从XML文件中提供的URL下载更新文件（安装程序）并执行刚刚下载的安装程序文件。在这之后执行更新是安装程序的工作。如果提供的是zip文件URL而不是安装程序，则AutoUpdater.NET会将zip文件的内容提取到应用程序目录中。

使用代码
XML文件
AutoUpdater.NET使用服务器上的XML文件来获取有关软件最新版本的发行信息。您需要创建如下所示的XML文件，然后将其上传到服务器。

<?xml version="1.0" encoding="UTF-8"?> 2.0.0.0 http://rbsoft.org/downloads/AutoUpdaterTest.zip https://github.com/ravibpatel/AutoUpdater.NET/releases false

There are two things you need to provide in XML file as you can see above.

version （必填）：您需要在版本标记之间提供应用程序的最新版本。版本应为XXXX格式。
url（必填）：您需要在url标签之间提供最新版本的安装程序文件或zip文件的URL。AutoUpdater.NET将下载此处提供的文件，并在用户按下“更新”按钮时进行安装。
changelog（可选）：您需要在changelog标记之间提供应用程序的更改日志的URL。如果您未提供变更日志的URL，则更新对话框将不会显示变更日志。
mandatory必填（可选）：如果您不希望用户跳过此版本，则可以将其设置为true。这将忽略“稍后提醒”和“跳过”选项，并在更新对话框中同时隐藏“跳过”和“稍后提醒”按钮。您可以提供mode属性来更改强制标志的行为。如果提供“ 1”作为mode属性的值，则它还将在更新对话框中隐藏“关闭”按钮。如果提供“ 2”作为mode属性的值，则它将跳过更新对话框，并自动开始下载和更新应用程序。
true
args（可选）：您可以在此标记之间为Installer提供命令行参数。您可以在命令行参数中包含％path％，它将由当前正在执行的应用程序所在目录的路径替换。
checksum（可选）：您可以在此标记之间提供更新文件的校验和。如果这样做，AutoUpdater.NET将在执行更新过程之前比较下载文件的校验和，以检查文件的完整性。您可以在校验和标记中提供算法属性，以指定应使用哪种算法来生成下载文件的校验和。当前，支持MD5，SHA1，SHA256，SHA384和SHA512。
更新文件校验和
添加一行使其生效
完成创建和上传XML文件后，向您的应用程序添加自动更新功能非常容易。首先，您需要在表单顶部添加以下行。
using AutoUpdaterDotNET;
现在，您只需要向主表单构造函数或Form_Load事件中添加以下行。您可以在任意位置添加此行。如果您不希望在应用程序启动时检查更新，则可以创建一个检查更新按钮，并将此行添加到Button_Click事件。

AutoUpdater.Start(“http://rbsoft.org/updates/AutoUpdaterTest.xml”);
AutoUpdater类的Start方法将您上载到服务器的XML文件的URL作为参数。

AutoUpdater.Start should be called from UI thread.
当前版本检测
AutoUpdater.NET使用程序集版本来确定应用程序的当前版本。您可以通过转到项目的“属性”来更新它，如以下屏幕截图所示。

如何更改.NET应用程序的程序集版本？

XML文件中指定的版本应高于程序集版本以触发更新。

如果要提供自己的程序集，则可以通过提供Start方法的第二个参数来实现，如下所示。

AutoUpdater.Start(“http://rbsoft.org/updates/AutoUpdaterTest.xml”, myAssembly);

配置选项
使用FTP下载更新文件和XML
如果您想使用ftp XML URL来检查更新或下载更新文件，则可以使用替代的Start方法为您提供FTP凭据，如下所示。

AutoUpdater.Start(“ftp://rbsoft.org/updates/AutoUpdaterTest.xml”, new NetworkCredential(“FtpUserName”, “FtpPassword”));

如果您在XML文件中使用FTP下载URL，则此处提供的凭据将用于验证请求。
禁用跳过按钮
如果您不想在“更新”表单上显示“跳过”按钮，则只需在上面的代码中添加以下行即可。

AutoUpdater.ShowSkipButton = false;
禁用稍后提醒按钮
如果您不想在“更新”表单上显示“稍后提醒”按钮，则只需在上面的代码行中添加以下内容即可。

AutoUpdater.ShowRemindLaterButton = false;
忽略以前的“稍后提醒”或“跳过设置”
如果要忽略先前设置的“稍后提醒”和“跳过”设置，则可以将“强制”属性设置为true。它还将隐藏“跳过并稍后提醒”按钮。如果在代码中将Mandatory设置为true，则XML文件中的Mandatory值将被忽略。

AutoUpdater.Mandatory = true;
强制更新
您可以通过将Mandatory属性设置为true并将UpdateMode设置为Mode.Forced或值来启用强制更新Mode.ForcedDownload。Mode.Forced选项将在标准更新对话框中隐藏“稍后提醒”，“跳过”和“关闭”按钮。Mode.ForcedDownload选项将跳过标准更新对话框，并开始下载和更新应用程序，而无需用户交互。Mode.ForceDownload选项还将忽略OpenDownloadPage标志的值。

AutoUpdater.Mandatory = true;
AutoUpdater.UpdateMode = Mode.Forced;

基本认证
您可以提供XML的基本身份验证，更新文件和更改日志，如下面的代码所示
BasicAuthentication basicAuthentication = new BasicAuthentication(“myUserName”, “myPassword”);
AutoUpdater.BasicAuthXML = AutoUpdater.BasicAuthDownload = AutoUpdater.BasicAuthChangeLog = basicAuthentication;

为http Web请求设置User-Agent
设置要用于HTTP Web请求的User-Agent字符串，以便您可以在Web服务器请求日志中区分它们。

AutoUpdater.HttpUserAgent = “AutoUpdater”;
启用错误报告
您可以通过添加以下代码来打开错误报告。如果这样做，AutoUpdater.NET将显示错误消息，没有可用的更新或者无法从Web服务器获取XML文件。

AutoUpdater.ReportErrors = true;
在没有管理员权限的情况下运行更新过程
如果您的应用程序不需要管理员权限来替换旧版本，则可以将RunUpdateAsAdmin设置为false。

AutoUpdater.RunUpdateAsAdmin = false;
打开下载页面
如果您不想下载该应用程序的最新版本，而只想打开XML文件的url标签之间的URL，则需要在上面的代码中添加以下行。
AutoUpdater.OpenDownloadPage = true;
如果您想在用户下载最新版本的应用程序之前向他们显示一些信息，则这种情况非常有用。

稍后提醒
如果您不希望用户在按下更新对话框的“稍后提醒”按钮时选择“稍后提醒”时间，则需要使用上述代码添加以下行。

AutoUpdater.LetUserSelectRemindLater = false;
AutoUpdater.RemindLaterTimeSpan = RemindLaterFormat.Days;
AutoUpdater.RemindLaterAt = 2;
在上面的示例中，当用户按下更新对话框的“稍后提醒”按钮时，它将在两天后提醒用户进行更新。

代理服务器
如果您的XML和Update文件只能从某些代理服务器使用，则可以使用以下设置来告诉AutoUpdater.NET使用该代理。当前，如果您的Changelog URL也仅限于代理服务器，则应从XML文件中省略changelog标记，因为使用代理服务器不支持它。

var proxy = new WebProxy(“ProxyIP:ProxyPort”, true)
{
Credentials = new NetworkCredential(“ProxyUserName”, “ProxyPassword”)
};
AutoUpdater.Proxy = proxy;

自动更新程序。代理 = 代理 ;
指定下载更新文件的位置
您可以通过分配DownloadPath字段来指定要在何处下载更新文件，如下所示。它也将用于ZipExtractor。

AutoUpdater.DownloadPath = Environment.CurrentDirectory;
指定UpdateForm的大小
您可以使用以下代码指定更新表单的大小。

AutoUpdater.UpdateFormSize = new System.Drawing.Size(800, 600);
经常检查更新
您可以在Timer中调用Start方法来频繁检查更新。

WinForms

System.Timers.Timer timer = new System.Timers.Timer
{
Interval = 2 * 60 * 1000,
SynchronizingObject = this
};
timer.Elapsed += delegate
{
AutoUpdater.Start(“http://rbsoft.org/updates/AutoUpdaterTest.xml”);
};
timer.Start();
WPF
DispatcherTimer timer = new DispatcherTimer {Interval = TimeSpan.FromMinutes(2)};
timer.Tick += delegate
{
AutoUpdater.Start(“http://rbsoft.org/updates/AutoUpdaterTestWPF.xml”);
};
timer.Start();
手动处理应用程序退出逻辑
如果您想自己处理应用程序退出逻辑，则可以使用如下所示的ApplicationExitEvent。如果您想在关闭应用程序之前做一些事情，这将非常有用。

AutoUpdater.ApplicationExitEvent += AutoUpdater_ApplicationExitEvent;

private void AutoUpdater_ApplicationExitEvent()
{
Text = @“Closing application…”;
Thread.Sleep(5000);
Application.Exit();
}

手动处理更新
有时，作为开发人员，您需要类似地维护整个应用程序的外观，或者只需要在更新之前做一些事情即可。在这种情况下，您可以通过订阅事件来手动处理更新。您可以通过在上面的代码中添加以下行来实现。

AutoUpdater.CheckForUpdateEvent += AutoUpdaterOnCheckForUpdateEvent;

private void AutoUpdaterOnCheckForUpdateEvent(UpdateInfoEventArgs args)
{
if (args != null)
{
if (args.IsUpdateAvailable)
{
DialogResult dialogResult;
if (args.Mandatory)
{
dialogResult =
MessageBox.Show(
$@“There is new version {args.CurrentVersion} available. You are using version {args.InstalledVersion}. This is required update. Press Ok to begin updating the application.”, @“Update Available”,
MessageBoxButtons.OK,
MessageBoxIcon.Information);
}
else
{
dialogResult =
MessageBox.Show(
$@“There is new version {args.CurrentVersion} available. You are using version {
args.InstalledVersion
}. Do you want to update the application now?”, @“Update Available”,
MessageBoxButtons.YesNo,
MessageBoxIcon.Information);
}

        //如果要显示标准更新对话框，请取消注释以下行。
        // AutoUpdater.ShowUpdateForm（）;

        if (dialogResult.Equals(DialogResult.Yes) || dialogResult.Equals(DialogResult.OK))
        {
            try
            {
                if (AutoUpdater.DownloadUpdate())
                {
                    Application.Exit();
                }
            }
            catch (Exception exception)
            {
                MessageBox.Show(exception.Message, exception.GetType().ToString(), MessageBoxButtons.OK,
                    MessageBoxIcon.Error);
            }
        }
    }
    else
    {
        MessageBox.Show(@"There is no update available please try again later.", @"No update available",
            MessageBoxButtons.OK, MessageBoxIcon.Information);
    }
}
else
{
    MessageBox.Show(
            @"There is a problem reaching update server please check your internet connection and try again later.",
            @"Update check failed", MessageBoxButtons.OK, MessageBoxIcon.Error);
}

}
当您执行此操作时，它将在调用AutoUpdater.Start方法时执行上述事件中的代码，而不是显示更新对话框。UpdateInfoEventArgs对象包含有关更新所需的所有信息。如果其为null，则意味着AutoUpdater.NET无法访问服务器上的XML文件。UpdateInfoEventArgs具有有关更新的以下信息。

IsUpdateAvailable（布尔）：如果有更新可用，则返回true，否则返回false。
DownloadURL（字符串）：更新文件的下载URL。
ChangelogURL（字符串）：指定新更新中更改的网页的URL。
CurrentVersion（版本）：可下载的应用程序的最新版本。
InstalledVersion（版本）：当前在用户PC上安装的应用程序的版本。
Mandatory（布尔）：显示更新是必需的还是可选的。
手动处理解析逻辑
如果要使用其他格式而不是XML作为AppCast文件，则需要通过订阅ParseUpdateInfoEvent来处理解析逻辑。您可以按照以下步骤进行操作。

AutoUpdater.ParseUpdateInfoEvent += AutoUpdaterOnParseUpdateInfoEvent;
AutoUpdater.Start(“http://rbsoft.org/updates/AutoUpdaterTest.json”);

private void AutoUpdaterOnParseUpdateInfoEvent(ParseUpdateInfoEventArgs args)
}@TOC

欢迎使用Markdown编辑器

你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

新的改变

我们对Markdown编辑器进行了一些功能拓展与语法支持，除了标准的Markdown编辑器功能，我们增加了如下几点新功能，帮助你用它写博客：

1. 全新的界面设计 ，将会带来全新的写作体验；
2. 在创作中心设置你喜爱的代码高亮样式，Markdown 将代码片显示选择的高亮样式 进行展示；
3. 增加了 图片拖拽 功能，你可以将本地的图片直接拖拽到编辑区域直接展示；
4. 全新的 KaTeX数学公式 语法；
5. 增加了支持甘特图的mermaid语法¹ 功能；
6. 增加了 多屏幕编辑 Markdown文章功能；
7. 增加了 焦点写作模式、预览模式、简洁写作模式、左右区域同步滚轮设置 等功能，功能按钮位于编辑区域与预览区域中间；
8. 增加了 检查列表 功能。

功能快捷键

撤销：Ctrl/Command + Z
重做：Ctrl/Command + Y
加粗：Ctrl/Command + B
斜体：Ctrl/Command + I
标题：Ctrl/Command + Shift + H
无序列表：Ctrl/Command + Shift + U
有序列表：Ctrl/Command + Shift + O
检查列表：Ctrl/Command + Shift + C
插入代码：Ctrl/Command + Shift + K
插入链接：Ctrl/Command + Shift + L
插入图片：Ctrl/Command + Shift + G
查找：Ctrl/Command + F
替换：Ctrl/Command + G

合理的创建标题，有助于目录的生成

直接输入1次#，并按下space后，将生成1级标题。
输入2次#，并按下space后，将生成2级标题。
以此类推，我们支持6级标题。有助于使用TOC语法后生成一个完美的目录。

如何改变文本的样式

强调文本 强调文本

加粗文本 加粗文本

标记文本

删除文本

引用文本

H₂O is是液体。

2¹⁰ 运算结果是 1024.

插入链接与图片

链接: link.

图片:

带尺寸的图片:

居中的图片:

居中并且带尺寸的图片:

当然，我们为了让用户更加便捷，我们增加了图片拖拽功能。

如何插入一段漂亮的代码片

去博客设置页面，选择一款你喜欢的代码片高亮样式，下面展示同样高亮的 代码片.

// An highlighted block
var foo = 'bar';

生成一个适合你的列表

• 项目
  • 项目
    • 项目

1. 项目1
2. 项目2
3. 项目3

• 计划任务
• 完成任务

创建一个表格

一个简单的表格是这么创建的：

项目	Value
电脑	$1600
手机	$12
导管	$1

设定内容居中、居左、居右

使用:---------:居中
使用:----------居左
使用----------:居右

第一列	第二列	第三列
第一列文本居中	第二列文本居右	第三列文本居左

SmartyPants

SmartyPants将ASCII标点字符转换为“智能”印刷标点HTML实体。例如：

TYPE	ASCII	HTML
Single backticks	'Isn't this fun?'	‘Isn’t this fun?’
Quotes	"Isn't this fun?"	“Isn’t this fun?”
Dashes	-- is en-dash, --- is em-dash	– is en-dash, — is em-dash

创建一个自定义列表

Markdown

Text-to- HTML conversion tool

Authors

John

Luke

如何创建一个注脚

一个具有注脚的文本。²

注释也是必不可少的

Markdown将文本转换为 HTML。

KaTeX数学公式

您可以使用渲染LaTeX数学表达式 KaTeX:

Gamma公式展示 $\Gamma (n)=(n-1)!\forall n\in \mathbb{N}$ 是通过欧拉积分

$$\Gamma (z)={\int }_0^{\infty }{t}^{z-1}{e}^{-t}dt.$$

你可以找到更多关于的信息 LaTeX 数学表达式here.

新的甘特图功能，丰富你的文章

• 关于 甘特图 语法，参考 这儿,

UML 图表

可以使用UML图表进行渲染。 Mermaid. 例如下面产生的一个序列图：

这将产生一个流程图。:

• 关于 Mermaid 语法，参考 这儿,

FLowchart流程图

我们依旧会支持flowchart的流程图：

• 关于 Flowchart流程图 语法，参考 这儿.

导出与导入

导出

如果你想尝试使用此编辑器, 你可以在此篇文章任意编辑。当你完成了一篇文章的写作, 在上方工具栏找到 文章导出 ，生成一个.md文件或者.html文件进行本地保存。

导入

如果你想加载一篇你写过的.md文件，在上方工具栏可以选择导入功能进行对应扩展名的文件导入，
继续你的创作。

---

1. mermaid语法说明 ↩︎

2. 注脚的解释 ↩︎