Excel催化剂开源第8波-VSTO开发之异步调用方法

在VSTO开发过程中，因其和普通的Winform开发有点差别，具体细节笔者也说不清楚，大概是VSTO的插件是寄生在Excel中，不属于独立的进程之类的，其异步方法调用时，未能如Winform那样直接用await async异步方法就结束，仍需要再作简单的处理。

使用场景

在Excel上直接使用异步方法，貌似有上述提及的问题，不像Winform程序那样，需要Excel上调出窗体，再从窗体上作异步方法的操作，直接调用的话，遇到用户用键盘、鼠标交互Excel操作会报错。

Excel催化剂中有些操作与外部资源交互特别是外部网络访问时，若不使用异步方法，将会卡界面，用户感觉死机了一样。

使用异步方法后，可以有一些状态信息反馈给用户知道程序还在运行，是十分有必要的。

以下举例Excel催化剂批量下载文件的功能。

先按钮打开一个窗体，具体代码如下：

        private void btnBatchDownLoadFile_Click(object sender, RibbonControlEventArgs e)

        {

            try

            {

                var result = MessageBox.Show(text: "是否需要在目标内容区域上生成超链接",

                    caption: "生成超链接确认",

                    buttons: MessageBoxButtons.YesNo);

                FormDownLoadFile form = new FormDownLoadFile();

                if (result == DialogResult.Yes)

                {

                    form.IsCreateHyperLink = true;

                }

                else

                {

                    form.IsCreateHyperLink = false;

                }

                form.Show();

            }

            catch (Exception ex)

            {

                Common.OutMsgError(ex);

            }

        }

批量下载文件界面

窗体中供用户配置一些信息后，即可开始下载文件，用户点击下载后运行

        private async void btnOK_Click(object sender, EventArgs e)

        {

            var markColor = Utilities.RangeUtility.GetMarkColorToDstRange(srcDataValues);

            int totalNum = srcDataValues.Count();

            int iLoop = 0;

            int rowOffset = int.Parse(this.cmbRowOffset.Text);

            int colOffset = int.Parse(this.cmbColOffset.Text);

            foreach (var item in srcDataValues)

            {

                iLoop++;

                string srcFilePath = item.Value2.ToString();

                string dstFilePath;

                Excel.Range dstItemRange = item.Offset[rowOffset, colOffset];

                if (dstItemRange.Value2 != null)

                {

                    dstFilePath = dstItemRange.Value2.ToString();

                    //没有后缀名时，标红颜色返回让用户自行检查

                    if (string.IsNullOrEmpty(Path.GetExtension(dstFilePath)))

                    {

                        item.Interior.Color = ColorTranslator.ToOle(markColor);

                        dstItemRange.Interior.Color = ColorTranslator.ToOle(markColor);

                    }

                    else

                    {

                        WebClientEx webClient = new WebClientEx(3000);

                        Uri uri = new Uri(srcFilePath);

                        await webClient.DownloadFileTaskAsync(uri, dstFilePath);

                        //线程间操作无效: 从不是创建控件的线程访问它。 处理方法

                        Action<int, int, string> action = (i, n, s) =>

                            {

                                this.lblDownLoadInfo.Text = $"正在下载的是第【{i}】/【{n}】个文件\r\n文件名为：{s}";

                            };

                        Invoke(action,iLoop, totalNum, dstFilePath);

                        if (this.IsCreateHyperLink)

                        {

                            dstItemRange.Hyperlinks.Add(Anchor: dstItemRange, Address: dstFilePath, TextToDisplay: dstFilePath);

                        }

                    }

                }

                else//当目标单元格没有值时，标红颜色返回让用户自行检查

                {

                    item.Interior.Color = ColorTranslator.ToOle(markColor);

                    dstItemRange.Interior.Color = ColorTranslator.ToOle(markColor);

                }

            }

            MessageBox.Show("下载完成！");

            Action actionColseForm = () => { this.Close(); };

            Invoke(actionColseForm);

        }

以上的关键代码关键之处有
用webClient库来下载，普通下载可满足，重写了它的超时时间
用await 关键字实现异步方法下载。

                        WebClientEx webClient = new WebClientEx(3000);

                        Uri uri = new Uri(srcFilePath);

                        await webClient.DownloadFileTaskAsync(uri, dstFilePath);

若代码需要重新访问窗体控件，需要用Action委托来处理下。

                        //线程间操作无效: 从不是创建控件的线程访问它。 处理方法

                        Action<int, int, string> action = (i, n, s) =>

                            {

                                this.lblDownLoadInfo.Text = $"正在下载的是第【{i}】/【{n}】个文件\r\n文件名为：{s}";

                            };

同样地下载结束后，关闭窗体，也需要重新用委托的方式来关闭。

            Action actionColseForm = () => { this.Close(); };

            Invoke(actionColseForm);

结语

异步方法调用这东西，笔者也是新手，里面的原理也不甚完全知晓，也只是百度回来的代码能够运行起来的水平。但此篇代码还是可以给大家带来一些实质性的帮助，需要使用时，得胜一下代码即可。

因为VSTO的特殊性，可能这些问题，在专业程序猿群体中，不会遇到，但在VSTO开发群体中，这里的确是个大坑，希望给大家填补此坑后，大家可以更顺畅地写出更好的代码。

技术交流QQ群

QQ群名：Excel催化剂开源讨论群， QQ群号：788145319

Excel催化剂开源讨论群二维码

关于Excel催化剂

Excel催化剂先是一微信公众号的名称，后来顺其名称，正式推出了Excel插件，插件将持续性地更新，更新的周期视本人的时间而定争取一周能够上线一个大功能模块。Excel催化剂插件承诺个人用户永久性免费使用！

Excel催化剂插件使用最新的布署技术，实现一次安装，日后所有更新自动更新完成，无需重复关注更新动态，手动下载安装包重新安装，只需一次安装即可随时保持最新版本！

Excel催化剂插件下载链接：https://pan.baidu.com/s/1Iz2_NZJ8v7C9eqhNjdnP3Q

联系作者

公众号

取名催化剂，因Excel本身的强大，并非所有人能够立马享受到，大部分人还是在被Excel软件所虐的阶段，就是头脑里很清晰想达到的效果，而且高手们也已经实现出来，就是自己怎么弄都弄不出来，或者更糟的是还不知道Excel能够做什么而停留在不断地重复、机械、手工地在做着数据，耗费着无数的青春年华岁月。所以催生了是否可以作为一种媒介，让广大的Excel用户们可以瞬间点燃Excel的爆点，无需苦苦地挣扎地没日没夜的技巧学习、高级复杂函数的烧脑，最终走向了从入门到放弃的道路。

最后Excel功能强大，其实还需树立一个观点，不是所有事情都要交给Excel去完成，也不是所有事情Excel都是十分胜任的，外面的世界仍然是一个广阔的世界，Excel只是其中一枚耀眼的明星，还有其他更多同样精彩强大的技术、工具等。*Excel催化剂也将借力这些其他技术，让Excel能够发挥更强大的爆发！

关于Excel催化剂作者

姓名：李伟坚，从事数据分析工作多年（BI方向），一名同样在路上的学习者。
服务过行业：零售特别是鞋服类的零售行业，电商（淘宝、天猫、京东、唯品会）

技术路线从一名普通用户，通过Excel软件的学习，从此走向数据世界，非科班IT专业人士。
历经重重难关，终于在数据的道路上达到技术平原期，学习众多的知识不再太吃力，同时也形成了自己的一套数据解决方案（数据采集、数据加工清洗、数据多维建模、数据报表展示等）。

擅长技术领域：Excel等Office家族软件、VBA&VSTO的二次开发、Sqlserver数据库技术、Sqlserver的商业智能BI技术、Powerbi技术、云服务器布署技术等等。

2018年开始职业生涯作了重大调整，从原来的正职工作，转为自由职业者，暂无固定收入，暂对前面道路不太明朗，苦重新回到正职工作，对Excel催化剂的运营和开发必定受到很大的影响（正职工作时间内不可能维护也不可能随便把工作时间内的成果公布于外，工作外的时间也十分有限，因已而立之年，家庭责任重大）。

和广大拥护者一同期盼：Excel催化剂一直能运行下去，我所惠及的群体们能够给予支持（多留言鼓励下、转发下朋友圈推荐、小额打赏下和最重点的可以和所在公司及同行推荐推荐，让我的技术可以在贵司发挥价值，实现双赢（初步设想可以数据顾问的方式或一些小型项目开发的方式合作）。