标签：官方 [1] 回调 blog io操作 wait led 初始 pat
APM即异步编程模式的简写（Asynchronous Programming Model）。大家在写代码的时候或者查看.NET 的类库的时候肯定会经常看到和使用以BeginXXX和EndXXX类似的方法，其实你在使用这些方法的时候，你就再使用异步编程模型来编写程序。NET Framework很多类也实现了该模式，同时我们也可以自定义类来实现该模式，（也就是在自定义的类中实现返回类型为IAsyncResult接口的BeginXXX方法和EndXXX方法），另外委托类型也定义了BeginInvoke和EndInvoke方法。
下面就具体就拿FileStream类的BeginRead和EndRead方法来介绍下下异步编程模型的实现。
当需要读取文件中的内容时，我们通常会采用FileStream的同步方法Read来读取，该同步方法的定义为：
// 从文件流中读取字节块并将该数据写入给定的字节数组中 // array代表把读取的字节块写入的缓存区 // offset代表array的字节偏量，将在此处读取字节 // count 代表最多读取的字节数 public override int Read(byte[] array, int offset, int count )
该同步方法会堵塞执行的线程。可以通过BeginRead方法来实现异步编程，使读取操作不再堵塞UI线程。BeginRead方法代表异步执行Read操作，并返回实现IAsyncResult接口的对象，该对象存储着异步操作的信息，下面就看下BeginRead方法的定义，看看与同步Read的方法区别在哪里的.
// 开始异步读操作 // 前面的3个参数和同步方法代表的意思一样，这里就不说了，可以看到这里多出了2个参数 // userCallback代表当异步IO操作完成时，你希望由一个线程池线程执行的方法,该方法必须匹配AsyncCallback委托 // stateObject代表你希望转发给回调方法的一个对象的引用，在回调方法中，可以查询IAsyncResult接口的AsyncState属性来访问该对象 public override IAsyncResult BeginRead(byte[] array, int offset, int numBytes, AsyncCallback userCallback, Object stateObject )
从上面的代码中可以看出异步方法和同步方法的区别，如果你在使用该异步方法时，不希望异步操作完成后调用任何代码，你可以把userCallback参数设置为null。该异步方法子所以不会堵塞UI线程是因为调用该方法后，该方法会立即把控制权返回给调用线程(如果是UI线程来调用该方法时，即返回给UI线程)，然而同步却不是这样，同步方法是等该操作完成之后返回读取的内容之后才返回给调用线程，从而导致在操作完成之前调用线程就一直等待状态。
前面介绍完了BeginXxx方法，我们看到所有BeginXxx方法返回的都是实现了IAsyncResult接口的一个对象，并不是对应的同步方法那样直接得到结果。此时我们需要调用对应的EndXxx方法来结束异步操作，并向该方法传递IAsyncResult对象，EndXxx方法的返回类型就是和同步方法一样的。例如，FileStream的EndRead方法返回一个Int32来代表从文件流中实际读取的字节数。
// 摘要: 等待挂起的异步读取完成。 // asyncResult:对要完成的挂起异步请求的引用。 // 返回结果: 从流中读取的字节数. public virtual int EndRead(IAsyncResult asyncResult);
对于访问异步操作的结果，APM的首选方式是：
使用 AsyncCallback委托来指定操作完成时要调用的方法，在操作完成后调用的方法中调用EndXxx操作来获得异步操作的结果。
其实异步编程模型这个模式，就是微软利用委托和线程池帮助我们实现的一个模式(该模式利用一个线程池线程去执行一个操作，在FileStream类BeginRead方法中就是执行一个读取文件操作，该线程池线程会立即将控制权返回给调用线程，此时线程池线程在后台进行这个异步操作；异步操作完成之后，通过回调函数来获取异步操作返回的结果。此时就是利用委托的机制。所以说异步编程模式时利用委托和线程池线程搞出来的模式，包括后面的基于事件的异步编程和基于任务的异步编程，还有C# 5中的async和await关键字，都是利用这委托和线程池搞出来的。他们的本质其实都是一样的，只是后面提出来的使异步编程更加简单罢了。)
存储请求的状态类：
// 这个类存储请求的状态 public class RequestState { public int BufferSize = 1024; public string savepath = Environment.GetFolderPath(Environment.SpecialFolder.Desktop) + "\\TAP.docx"; public byte[] BufferRead; public HttpWebRequest request; public HttpWebResponse response; public Stream streamResponse; public FileStream filestream; public RequestState() { BufferRead = new byte[BufferSize]; request = null; streamResponse = null; if (File.Exists(savepath)) { File.Delete(savepath); } filestream = new FileStream(savepath, FileMode.OpenOrCreate); } }
主程序：
private static void Main(string[] args) { string downUrl = "http://download.microsoft.com/download/5/B/9/5B924336-AA5D-4903-95A0-56C6336E32C9/TAP.docx"; // 同步下载文件 //在下载操作完成之后我们才可以看到"Start DownLoad File......." 消息显示 DownLoadFileSync(downUrl); //异步下载文件 //在下载操作完成之前我们就可以看到"Start DownLoad File......." 消息显示 // DownloadFileAsync(downUrl); Console.WriteLine("Start DownLoad File........."); Console.ReadLine(); }
调用的是同步方法时，此时会堵塞主线程，直到文件的下载操作被完成之后主线程才继续执行后面的代码，下面是下载文件的同步方法：
private static void DownLoadFileSync(string url) { // 创建一个 RequestState 实例 RequestState req = new RequestState(); try { // 初始化一个 HttpWebRequest 对象 HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(url); // 指派 HttpWebRequest实例到requestState的request字段. req.request = myHttpWebRequest; req.response = (HttpWebResponse)myHttpWebRequest.GetResponse(); req.streamResponse = req.response.GetResponseStream(); int readSize = req.streamResponse.Read(req.BufferRead, 0, req.BufferRead.Length); while (readSize > 0) { req.filestream.Write(req.BufferRead, 0, readSize); readSize = req.streamResponse.Read(req.BufferRead, 0, req.BufferRead.Length); } Console.WriteLine("\nThe Length of the File is: {0}", req.filestream.Length); Console.WriteLine("DownLoad Completely, Download path is: {0}", req.savepath); } catch (Exception e) { Console.WriteLine("Error Message is:{0}", e.Message); } finally { req.response.Close(); req.filestream.Close(); } }
使用同步方法下载文件的运行结果为：
控制台程序演示如何使用APM来现异步编程：
private static void DownloadFileAsync(string url) { try { HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(url); RequestState requestState = new RequestState(); requestState.request = myHttpWebRequest; myHttpWebRequest.BeginGetResponse(new AsyncCallback(ResponseCallback), requestState); } catch (Exception e) { Console.WriteLine("Error Message is:{0}", e.Message); } } //每个异步操作完成时，将调用下面的方法 private static void ResponseCallback(IAsyncResult callbackresult) { // 获取 RequestState 对象 RequestState req = (RequestState)callbackresult.AsyncState; HttpWebRequest myHttpRequest = req.request; // 结束一个对英特网资源的的异步请求 req.response = (HttpWebResponse)myHttpRequest.EndGetResponse(callbackresult); //从服务器获取响应流 Stream responseStream = req.response.GetResponseStream(); req.streamResponse = responseStream; //异步读取流到字节数组 IAsyncResult asynchronousRead = responseStream.BeginRead(req.BufferRead, 0, req.BufferRead.Length, ReadCallBack, req); } // 写字节数组到 FileStream private static void ReadCallBack(IAsyncResult asyncResult) { try { // 获取 RequestState 对象 RequestState req = (RequestState)asyncResult.AsyncState; //从RequestState对象中获取 Response Stream Stream responserStream = req.streamResponse; // int readSize = responserStream.EndRead(asyncResult); if (readSize > 0) { req.filestream.Write(req.BufferRead, 0, readSize); responserStream.BeginRead(req.BufferRead, 0, req.BufferRead.Length, ReadCallBack, req);//循环调用ReadCallBack方法。 } else { Console.WriteLine("\nThe Length of the File is: {0}", req.filestream.Length); Console.WriteLine("DownLoad Completely, Download path is: {0}", req.savepath); req.response.Close(); req.filestream.Close(); } } catch (Exception e) { Console.WriteLine("Error Message is:{0}", e.Message); } }
运行结果为（从运行结果也可以看出，在主线程中调用 DownloadFileAsync(downUrl)方法时，DownloadFileAsync(downUrl)方法中的req.BeginGetResponse调用被没有阻塞调用线程(即主线程)，而是立即返回到主线程，是主线程后面的代码可以立即执行）
在前面的介绍中已经提到委托类型也会定义了BeginInvoke方法和EndInvoke方法，所以委托类型也实现了异步编程模型，所以可以使用委托的BeginInvoke和EndInvoke方法来回调同步方法从而实现异步编程。因为调用委托的BeginInvoke方法来执行一个同步方法时，此时会使用线程池线程回调这个同步方法并立即返回到调用线程中，由于耗时操作在另外一个线程上运行，所以执行BeginInvoke方法的主线程就不会被堵塞。下面实现在线程池线程中如何更新GUI线程中窗体。
// 定义用来实现异步编程的委托 private delegate string AsyncMethodCaller(string fileurl);
private void btnDownLoad_Click(object sender, EventArgs e) { AsyncMethodCaller methodCaller = new AsyncMethodCaller(DownLoadFileSync);//DownLoadFileSync为同步下载文件的方法 methodCaller.BeginInvoke(txbUrl.Text.Trim(), GetResult, null); } // 异步操作完成时执行的方法 private void GetResult(IAsyncResult result) { AsyncMethodCaller caller = (AsyncMethodCaller)((AsyncResult)result).AsyncDelegate;// 或者(AsyncMethodCaller)result.AsyncState; // 调用EndInvoke去等待异步调用完成并且获得返回值 // 如果异步调用尚未完成，则 EndInvoke 会一直阻止调用线程，直到异步调用完成
try{
string returnstring = caller.EndInvoke(result);
} catch (Exception ex){}// 然后Invoke方法来使更新GUI操作方法由GUI 线程去执行 Invoke(new MethodInvoker(delegate() { rtbState.Text = returnstring; btnDownLoad.Enabled = true; })); }
运行的结果为：
可以直接使用 TaskFactory<TResult>.FromAsync 方法
private static void ResponseCallback(IAsyncResult callbackresult) { //...... //异步读取流到字节数组 // IAsyncResult asynchronousRead = responseStream.BeginRead(req.BufferRead, 0, req.BufferRead.Length, ReadCallBack, req); Task<int> task = Task<int>.Factory.FromAsync(responseStream.BeginRead, responseStream.EndRead, req.BufferRead, 0, req.BufferRead.Length, null); ReadCallBack(task, req); } // 写字节数组到 FileStream private static void ReadCallBack(Task<int> task, RequestState req) { try { //从RequestState对象中获取 Response Stream Stream responseStream = req.streamResponse; //异步执行结果 int readSize = task.Result; if (readSize > 0) { req.filestream.Write(req.BufferRead, 0, readSize); var t = Task<int>.Factory.FromAsync(responseStream.BeginRead, responseStream.EndRead, req.BufferRead, 0, req.BufferRead.Length, null); ReadCallBack(t, req); } else { Console.WriteLine("\nThe Length of the File is: {0}", req.filestream.Length); Console.WriteLine("DownLoad Completely, Download path is: {0}", req.savepath); req.response.Close(); req.filestream.Close(); } } catch (Exception e) { Console.WriteLine("Error Message is:{0}", e.Message); } }
或者可以用一下的方法：
public static Task<int> ReadAsync(this Stream stream, byte [] buffer, int offset, int count) { if (stream == null) throw new ArgumentNullException("stream"); var tcs = new TaskCompletionSource<int>(); stream.BeginRead(buffer, offset, count, iar => { try { tcs.TrySetResult(stream.EndRead(iar)); } catch(OperationCanceledException) { tcs.TrySetCanceled(); } catch(Exception exc) { tcs.TrySetException(exc); } }, null); return tcs.Task; }
到这里本专题关于异步编程模型的介绍就结束了，异步编程模型（APM）虽然是.NET 1.0中提出来的一个模式，相对于现在来说是旧了点，并且微软现在官方也表明在最新的代码中不推荐使用该模型来实现异步的应用程序，而是推荐使用基于任务的异步编程模型来实现异步的应用程序，但是我个人认为，正是因为它是.NET 1.0中提出的来，并且现在来看确实有些旧了， 所以我们才更应该好好研究下它，因为后面提出的EAP和TAP微软做了更多的封装，是我们对异步编程的本质都不清楚的（其实它们的本质都是使用线程池和委托机制的，具体可以查看前面的相关部分），并且系统学习下异步编程，也可以让我们对新的异步编程模型的所带来的好处有更可直观的认识。在后面的一专题我将带大家全面认识下基于事件的异步编程模型（EAP）。
标签：官方 [1] 回调 blog io操作 wait led 初始 pat
原文地址：https://www.cnblogs.com/springsnow/p/9399261.html
