Clickonce无痛自动更新是我最喜欢使用VSTO开发并Clickonce部署的特性之一,但这个自动更新,通常会更新整个程序文件,包含所有的引用dll和一些资源文件等。
一般来说,我们更新的都是主程序,那些引用dll和资源文件,除非是发布时的版本的确更新了,才有必要更新到用户的机器上,不然动不动所有文件都一起更新,更新需要下载的文件数量也太大,等待时间也太长,最终反而变得用户体验不够完美。
资源文件的问题还比较好解决,只要不把资源文件内嵌到程序集中,然后通过手动下载或程序代码自动检测有新增或更新就下载到用户机器上(Excel催化剂原来是采用代码在程序运行时比较再自动化下载,无奈部署的是外网服务器,下载速度有限,用户反馈不友好,最后改为手动下载)。
引用的dll文件,这个就比较难搞,经过网友师傅热心指点后,最终也实现了,此篇着重分享的也是引用dll与主程序分离,实现Clickonce自动更新时不重复下载这些未改变的dll文件。
手动更新的文件大小达30多M
Excel催化剂单独更新的文件,不用Clickonce更新
可以看到引用了好多大部头的dll和资源文件,例如让Excel读写更快速的NPOI和EPPLUS库、PowerBI访问的分析服务类库等。
引用dll文件和配置文件都不作更新
引用dll并非所有都可以分离,只有强类型签名过的dll才可以分离到其他文件夹里,不放到程序文件夹里,具体原理需要自行百度了解
这个非强类型的dll不能分离,只能复制到本地为True
强类型为false时示例
强类型为true时,在属性这里将复制本地改为false,发布时就不会复制到程序文件夹
强类型为true时的示例
可以来看最终的release文件夹中的文件
已经分离了大部分引用dll的效果
代码实现
在界面上作了个按钮给用户点击来更新
private void btnUpdateSetting_Click(object sender, RibbonControlEventArgs e) { try { var result = MessageBox.Show(text: "更新过程较慢,需要耐心等待下,可能要好几分钟,期间不要操作Excel。\n选择【是】继续,选择【否】退出。", caption: "更新配置文件", buttons: MessageBoxButtons.YesNo, icon: MessageBoxIcon.Question); if (result == DialogResult.Yes) { Common.AppInteractiveSetting(false); AddinSettingUpdate.CheckWebConnectAndUpdateSettingFiles(); MessageBox.Show("更新完成,可能部分功能(自定义函数)需关闭所有Excel文件重新打开才能使用"); } } catch (Exception ex) { Common.OutMsgError(ex); } finally { Common.AppInteractiveSetting(true); } }
简单检查下网络是否可通,再进行下载。
public static void CheckWebConnectAndUpdateSettingFiles() { if (Common.CheckIsConnectInternet("http://101.132.130.88/test.html")) { string settingDir = Common.AddinsSettingDir; DownLoadResourceFile(settingDir); UDFLoad.LoadUDF(settingDir); } else { throw new Exception("网络未能连接\n此功能需要网络能访问Excel催化剂服务器网站\n服务器IP为101.132.130.88,请检查网络或咨询IT部同事。"); } }
笔者使用的是WebService的方式访问服务器的文件,和本地文件作比对,服务器新的话,下载到本地。
public static void DownLoadResourceFile(string settingDir) { string wsRootDir = @"F:\网站内容\VSTO插件\Excel催化剂附加内容\"; ServiceFileAnyc.FileAnycSoapClient client = new ServiceFileAnyc.FileAnycSoapClient(); var srcFiles = client.GetFiles(wsRootDir); foreach (var srcFile in srcFiles) { var dstFilePath = Path.Combine(Common.AddinsSettingDir, srcFile.Replace(wsRootDir, "")); string dstDir = Path.GetDirectoryName(dstFilePath); if (!Directory.Exists(dstDir)) { Directory.CreateDirectory(dstDir); } DateTime srcFileLastWriteTime = client.GetLastWriteTimeOfFile(srcFile); DateTime dstFileLastWriteTime = DateTime.MinValue; if (Path.GetDirectoryName(dstFilePath).EndsWith("xml"))//当为xml时,只需要不存在时才覆盖读写 { if (!File.Exists(dstFilePath)) { File.WriteAllBytes(dstFilePath, client.GetBytesOfFile(srcFile)); } } else { if (File.Exists(dstFilePath)) { dstFileLastWriteTime = File.GetLastWriteTime(dstFilePath); } if (dstFileLastWriteTime < srcFileLastWriteTime) { //xll文件夹里的文件不用同步,由另外的LOADUDF方法来同步 if (!Path.GetDirectoryName(dstFilePath).EndsWith("xll")) { File.WriteAllBytes(dstFilePath, client.GetBytesOfFile(srcFile)); File.SetLastWriteTime(dstFilePath, srcFileLastWriteTime); } } } } }
让引用dll可以分离的关键代码,在程序开始时订阅一下这个事件,大概意思是程序要使用某个功能时,找不到相应的引用dll,会激发这个事件,在这个事件里告诉程序应该下一步怎么办,继续找的话从哪里找就在这个事件方法中写上。
方法中第1个dll文本是我的文件夹,assemblyName 是不含文件后缀,所以要补上后面的是“.dll”
AppDomain.CurrentDomain.AssemblyResolve = CurrentDomain_AssemblyResolve; private System.Reflection.Assembly CurrentDomain_AssemblyResolve(object sender, ResolveEventArgs args) { if (args.Name != null) { string assemblyName = new AssemblyName(args.Name).Name; return System.Reflection.Assembly.LoadFrom(Path.Combine(Common.AddinsSettingDir, "dll", assemblyName ".dll")); } return null; }
结语
通过以上的处理后,会发现,Excel催化剂每次自动更新,都只更新核心的程序dll,其他文件尽可能地放到手动更新上让用户按需更新,最终实现了ClickOnce的自动更新模式下的升级瘦身工作。
ClickOnce的自动升级真的好用,让开发者聚焦在业务代码的实现,使用其现有的框架堆代码即可实现自动更新,非常值得尝试使用。