.NET2.0版本中基于事件的异步编程模式(EAP)_Asp.net

一、引言

apm为我们实现异步编程提供了一定的支持，同时它也存在着一些明显的问题——不支持对异步操作的取消和没有提供对进度报告的功能，对于有界面的应用程序来说，进度报告和取消操作的支持也是必不可少的。

微软在.net 2.0的时候就为我们提供了一个新的异步编程模型，也就是基于事件的异步编程模型——eap（event-based asynchronous pattern ）。

二、介绍

实现了基于事件的异步模式的类将具有一个或者多个以async为后缀的方法和对应的completed事件，并且这些类都支持异步方法的取消、进度报告和报告结果。

当我们调用实现基于事件的异步模式的类的 xxxasync方法时，即代表开始了一个异步操作，该方法调用完之后会使一个线程池线程去执行耗时的操作，所以当ui线程调用该方法时，当然也就不会堵塞ui线程了。

并且基于事件的异步模式是建立了apm的基础之上的，而apm又是建立了在委托之上的。

public static void getinfomation()
{
    webclient client = new webclient();
    uri uri = new uri("http://www.baidu.com");
    client.downloadfilecompleted += new asynccompletedeventhandler(client_downloadfilecompleted);
    client.downloadprogresschanged += new downloadprogresschangedeventhandler(client_downloadprogresscallback);
    client.downloadfileasync(uri, "serverdata.txt");
}

static void client_downloadprogresscallback(object sender, downloadprogresschangedeventargs e)
{
    // displays the operation identifier, and the transfer progress.
    console.writeline("{0}    downloaded {1} of {2} bytes. {3} % complete...", (string)e.userstate, e.bytesreceived, e.totalbytestoreceive, e.progresspercentage);
}

static void client_downloadfilecompleted(object sender, asynccompletedeventargs e)
{
    string retstr = (e.error == null ? "成功" : e.error.message);
    console.write(retstr);  //显示操作结果信息
}

三、使用backgroundworker组件进行异步编程

backgroundworker类就是用eap实现的。

backgroundworker类

公共属性

cancellationpending：获取一个值，指示应用程序是否已请求取消后台操作
isbusy：获取一个值，指示 backgroundworker 是否正在运行异步操作。
workreportsprogress：获取或设置一个值，该值指示 backgroundworker 能否报告进度更新。
workersupportscancellation：获取或设置一个值，该值指示 backgroundworker 是否支持异步取消。

公共方法

cancelasync：请求取消挂起的后台操作。
reportprogress：引发 progresschanged 事件
runworkerasync：开始执行后台操作。

公共事件

dowork：调用 runworkerasync 时发生
progresschanged：调用reportprogress时发生
runworkercompleted：当后台操作已完成、被取消或引发异常时发生。

下面向大家演示一个使用backgroundworker组件实现异步下载文件的一个小程序，该程序支持异步下载(指的就是用线程池线程要执行下载操作)，断点续传、下载取消和进度报告的功能。

事件绑定：

代码：

public int downloadsize = 0;
public string downloadpath = null;
private requeststate requeststate = null;
private long totalsize = 0;

public filedownloader()
{
    initializecomponent();

    string url = "http://download.microsoft.com/download/7/0/3/703455ee-a747-4cc8-bd3e-98a615c3aedb/dotnetfx35setup.exe";
    //string url = "http://download.microsoft.com/download/9/5/a/95a9616b-7a37-4af6-bc36-d6ea96c8daae/dotnetfx40_full_x86_x64.exe";
    txburl.text = url;
    this.btnpause.enabled = false;
    //this.status = downloadstatus.initialized;
    // get download path

    gettotalsize();
    downloadpath = environment.getfolderpath(environment.specialfolder.desktop) + "\\" + path.getfilename(this.txburl.text.trim());
    if (file.exists(downloadpath))
    {
        fileinfo fileinfo = new fileinfo(downloadpath);
        downloadsize = (int)fileinfo.length;
        progressbar1.value = (int)((float)downloadsize / (float)totalsize * 100);
    }

    // 启用支持 reportprogress and cancellation
    bgworkerfiledownload.workerreportsprogress = true;
    bgworkerfiledownload.workersupportscancellation = true;
}

//开始或恢复下载
private void btndownload_click(object sender, eventargs e)
{
    if (bgworkerfiledownload.isbusy != true)
    {
        // 启动异步操作触发dowork事件
        bgworkerfiledownload.runworkerasync();

        // 创建requeststate 实例
        requeststate = new requeststate(downloadpath);
        requeststate.filestream.seek(downloadsize, seekorigin.begin);
        this.btndownload.enabled = false;
        this.btnpause.enabled = true;
    }
    else
    {
        messagebox.show("正在执行操作，请稍后");
    }
}

// 暂停下载
private void btnpause_click(object sender, eventargs e)
{
    if (bgworkerfiledownload.isbusy && bgworkerfiledownload.workersupportscancellation == true)
    {
        // 终止异步操作触发runworkercompleted事件
        bgworkerfiledownload.cancelasync();
    }
}

#region backgroundworker event

// 1、当调用runworkerasync方法时触发
private void bgworkerfiledownload_dowork(object sender, doworkeventargs e)
{
    //获取事件源
    backgroundworker bgworker = sender as backgroundworker;
    try
    {
        // 执行下载操作
        // 初始化一个httpwebrequest对象
        httpwebrequest myhttpwebrequest = (httpwebrequest)webrequest.create(txburl.text.trim());

        // 如果文件已下载了一部分，
        // 服务器应该从downloadsize开始发送数据到http实体中数据的末尾。
        if (downloadsize != 0)
        {
            myhttpwebrequest.addrange(downloadsize);
        }

        // 指定一个 httpwebrequest 实例到request字段.
        requeststate.request = myhttpwebrequest;
        requeststate.response = (httpwebresponse)myhttpwebrequest.getresponse();
        requeststate.streamresponse = requeststate.response.getresponsestream();
        int readsize = 0;
        while (true)
        {
            if (bgworker.cancellationpending == true)
            {
                e.cancel = true;
                break;
            }

            readsize = requeststate.streamresponse.read(requeststate.bufferread, 0, requeststate.bufferread.length);
            if (readsize > 0)
            {
                downloadsize += readsize;
                int percentcomplete = (int)((float)downloadsize / (float)totalsize * 100);
                requeststate.filestream.write(requeststate.bufferread, 0, readsize);

                // 报告进度，引发progresschanged事件的发生
                bgworker.reportprogress(percentcomplete);
            }
            else
            {
                break;
            }
        }
    }
    catch
    {
        throw;
    }
}

//  2、当调用reportprogress方法时触发
private void bgworkerfiledownload_progresschanged(object sender, progresschangedeventargs e)
{
    this.progressbar1.value = e.progresspercentage;
}

// 3、当后台操作完成，取消或者有错误时触发
private void bgworkerfiledownload_runworkercompleted(object sender, runworkercompletedeventargs e)
{
    if (e.error != null)
    {
        messagebox.show(e.error.message);
        requeststate.response.close();
    }
    else if (e.cancelled)
    {
        messagebox.show(string.format("下载暂停，下载的文件地址为：{0}\n 已经下载的字节数为: {1}字节", downloadpath, downloadsize));
        requeststate.response.close();
        requeststate.filestream.close();

        this.btndownload.enabled = true;
        this.btnpause.enabled = false;
    }
    else
    {
        messagebox.show(string.format("下载已完成，下载的文件地址为：{0}，文件的总字节数为: {1}字节", downloadpath, totalsize));

        this.btndownload.enabled = false;
        this.btnpause.enabled = false;
        requeststate.response.close();
        requeststate.filestream.close();
    }
}

#endregion backgroundworker event

// 获取文件总大小
private void gettotalsize()
{
    httpwebrequest myhttpwebrequest = (httpwebrequest)webrequest.create(txburl.text.trim());
    httpwebresponse response = (httpwebresponse)myhttpwebrequest.getresponse();
    totalsize = response.contentlength;
    response.close();
}
}

// 此类存储请求的状态
public class requeststate
{
 public int buffersize = 2048;

 public byte[] bufferread;
 public httpwebrequest request;
 public httpwebresponse response;
 public stream streamresponse;

 public filestream filestream;

 public requeststate(string downloadpath)
 {
    bufferread = new byte[buffersize];
    request = null;
    streamresponse = null;
    filestream = new filestream(downloadpath, filemode.openorcreate);
 }

运行程序点击"下载"按钮然后再点击"暂停"后的结果：

当暂停下载后，我们还可以点 ”下载“按钮继续下载该文件，此时并不会从开开始下载，而会接着上次的下载继续下载。

这个实现主要是通过addrange方法来实现的，该方法是指出向服务器请求文件的大小，上面代码中通过传入downloadsize来告诉服务器，这次我需要的内容不是从开头开始的，而是从已经下载的文件字节数开始到该文件的总的字节结尾，这样就就实现了断点续传的功能了，使户暂停下载不至于之前下载的都白费了。程序的运行结果为：