应网友要求，结合参考实现（BankBranchWorkbench）写一篇关于 SCSF 内部工作原理的文章，需要读者有 SCSF 基础。基本概念和基本理念后面相关文章介绍。

SCSF 自动为我们建立了 Shell 项目。该项目的 ShellApplication 是SCSF 应用的入口程序，该类继承自 SmartClientApplication<TWorkItem, TShell> ，TWorkItem 是要指定的 root workitem ，TShell 是主窗体。

该类的 Main 方法通过 new ShellApplication().Run(); 启动应用。Run（） 在父类 CabApplication 中实现，定义了 SCSF 的启动流程：1 public void Run()
2 {
3     RegisterUnhandledExceptionHandler();
4     Builder builder = CreateBuilder();
5     AddBuilderStrategies(builder);
6     CreateRootWorkItem(builder);
7 
8     IVisualizer visualizer = CreateVisualizer();
9     if (visualizer != null)
10         visualizer.Initialize(rootWorkItem, builder);
11 
12     AddRequiredServices();
13     AddConfiguredServices();
14     AddServices();
15     AuthenticateUser();
16     ProcessShellAssembly();
17     rootWorkItem.BuildUp();
18     LoadModules();
19     rootWorkItem.FinishInitialization();
20 
21     rootWorkItem.Run();
22     Start();
23 
24     rootWorkItem.Dispose();
25     if (visualizer != null)
26         visualizer.Dispose();
27 }
28 

其中核心流程有：

1. 首先创建 Builder builder = CreateBuilder(); 

CreaterBuilder（）方法注册了 RootWorkItemInitializationStrategy ，EventBrokerStrategy，CommandStrategy，ObjectBuiltNotificationStrategy 总共四个策略，同时还添加了三个 Policy ：SingletonPolicy，BuilderTraceSourcePolicy，ObjectBuiltNotificationPolicy 。

CreaterBuilder（） 一般使用 builder.Strategies.AddNew 方法利用 ObjectBuilder 构建策略对象 （例如：builder.Strategies.AddNew<EventBrokerStrategy>(BuilderStage.Initialization)）。

2. 子类可以通过重写 protected virtual void AddBuilderStrategies(Builder builder) 来给 ObjectBuilder 添加其他构建策略（在构建对象或者销毁对象时执行的操作）。

3. 初始化 RootWorkItem

这些准备工作做完后，第一件事是创建 RootWorkItem 。RootWorkItem 是通过 CreateRootWorkItem(builder) 完成的，以前面创建的 builder 作为参数：protected internal void InitializeRootWorkItem(Builder builder)。

InitializeRootWorkItem 中首先初始化 RootWorkItem 相关的 Builder 和 Locator （这两个都是 ObjectBuilder 的组件，用与对象创建和依赖注入）: this.builder = builder;
this.locator = new Locator();

其次对 rootWorkItem 进行初始化，主要执行以下三个方法：

InitializeFields()：设置或初始化 ObjectBuilder 相关的对象： Builder，Locator，ObjectBuiltNotificationPolicy，还有 workItem 的状态。

InitializeState()：通过 Guid 生成本 workItem 实例的 ID （ID = Guid.NewGuid().ToString();）；

InitializeCollectionFacades()：初始化管理 SCSF 核心组件的对象管理集合： ServiceCollection，commandCollection，workItemCollection，workspaceCollection，itemsCollection，smartPartCollection，eventTopicCollection，uiExtensionSiteCollection 。

RootWorkItem 构建完成后有一个可选的过程是创建 IVisualizer （用于在运行时查看 WorkItem 的状态）：1 IVisualizer visualizer = CreateVisualizer();
2 if (visualizer != null)
3     visualizer.Initialize(rootWorkItem, builder);

4. 添加服务：

AddRequiredServices() 方法添加的服务有：TraceSourceCatalogService，WorkItemExtensionService，WorkItemTypeCatalogService，SimpleWorkItemActivationService，WindowsPrincipalAuthenticationService，ModuleLoaderService，FileCatalogModuleEnumerator，DataProtectionCryptographyService，CommandAdapterMapService，UIElementAdapterFactoryCatalog 。

AddConfiguredServices() 添加在配置文件中配置的服务，也就是运行我们通过配置的方式决定在 SCSF 框架启动时加载额外服务（Services）。

AddServices() 在 CabApplication 中是一个空的虚拟方法，允许我们创建 CabApplication 的子类来重写该方法以添加需要的 Services 。

5. 验证用户

通过获取在启动过程中注册的 IAuthenticationService 服务来进行用户验证（ObjectBuilder 的具体应用）： 1 private void AuthenticateUser()
2 {
3     IAuthenticationService auth = rootWorkItem.Services.Get<IAuthenticationService>(true);
4     auth.Authenticate();
5 }

6. 处理 Shell 程序集（可执行的 Shell Assembly） 1 private void ProcessShellAssembly()
2 {
3     IModuleLoaderService loader = rootWorkItem.Services.Get<IModuleLoaderService>(true);
4     Assembly assembly = Assembly.GetEntryAssembly();
5 
6     if (assembly != null)
7         loader.Load(rootWorkItem, assembly);
8 }
9 

通过 ObjectBuilder 获取已注册的 IModuleLoaderService （默认的是 Microsoft.Practices.CompositeUI.Services.ModuleLoaderService），调用 ModuleLoaderService 的 Load 方法来通过SCSF Attribute（反射和特性）结合 ObjectBuilder 来加载 SCSF 核心组件，包括 Services、 Command 、 SmartParts、UIElement、workspace、Event Broker、State 等，这些属性（Attribute）主要有：ServiceAttribute，ServiceDependencyAttribute，SmartPartAttribute，CommandHandlerAttribute，EventPublicationAttribute，EventSubscriptionAttribute，ModuleDependencyAttribute，StateChangedAttribute，RootWorkItemExtensionAttribute，OptionalDependencyAttribute，TraceSourceAttribute，ComponentDependencyAttribute，WorkItemExtensionAttribute ，以后有时间会专门介绍这些属性的使用。

7. 构建 RootWorkItem （rootWorkItem.BuildUp()）

RootWorkItem 通过 builder.BuildUp(locator, type, temporaryID, this, policies) 方法使用 ObjectBuilder 进行构建，前面介绍过 CabApplication 在 CreaterBuilder（） 中注册了构建策略 RootWorkItemInitializationStrategy： builder.Strategies.Add(new RootWorkItemInitializationStrategy(this.OnRootWorkItemInitialized), BuilderStage.Initialization)，该语句表明在创建 RootWorkItem 时 ObjectBuilder 会执行该策略并调用本类（CabApplication 或者重载的子类）的 OnRootWorkItemInitialized 方法：protected virtual void OnRootWorkItemInitialized()。CabShellApplication （CabApplication 的子类） 重写了该方法： 1 protected sealed override void OnRootWorkItemInitialized()
2 {
3     BeforeShellCreated();
4     shell = RootWorkItem.Items.AddNew<TShell>();
5     AfterShellCreated();
6 }

其中 RootWorkItem.Items.AddNew<TShell>() 语句创建了新的 TShell 主窗体对象（通过 ObjectBuilder 构建）并加入到 RootWorkItem 的 Items 集合中。

8. 通过配置加载模块（LoadModules()）

RootWorkItem 构建完成后，SCSF 会根据 IModuleEnumerator 服务来枚举可以加载的模块（确定需要加载哪些模块），SCSF 中提供了两个 IModuleEnumerator 服务：FileCatalogModuleEnumerator（在配置文件中指明要加载哪些模块，默认的配置文件是 ProfileCatalog.xml ）和 ReflectionModuleEnumerator（利用反射和 ModuleAttribute 来确定需要加载哪些模块）。同时 SCSF 的Package Guidance 为我们提供了一个 XmlStreamDependentModuleEnumerator ，用于从 Xml Stream 中确定需要加载哪些模块，这个可以用在通过 Web Service 将服务器上的配置发送到客户端的情况。

典型的配置文件示例 ProfileCatalog.xml ：<SolutionProfile xmlns="http://schemas.microsoft.com/pag/cab-profile/2.0%22>
  <Section Name="Infrastructure">
    <Modules>
        <ModuleInfo AssemblyFile="GlobalBank.Support.Module.dll" /> 
        <ModuleInfo AssemblyFile="GlobalBank.Infrastructure.Module.dll" />
    </Modules>
  </Section>
  <Section Name="BranchSystems">
    <Dependencies>
      <Dependency Name="Infrastructure" />
    </Dependencies>
    <Modules>
      <ModuleInfo AssemblyFile="GlobalBank.BranchSystems.Layout.dll" Name="BranchSystems.Layout"/>
      <ModuleInfo AssemblyFile="GlobalBank.BranchSystems.Module.dll">
        <Dependencies>
          <Dependency Name="BranchSystems.Layout" />
        </Dependencies>
        <Roles>
          <Role Allow="Greeter"/>
          <Role Allow="Officer"/>
          <Role Allow="BranchManager"/>
        </Roles>
      </ModuleInfo>
    </Modules>
  </Section>
  <Section Name="LinesOfBusiness">
    <Dependencies>
      <Dependency Name="Infrastructure" />
      <Dependency Name="BranchSystems" />
    </Dependencies>
    <Modules>
      <ModuleInfo AssemblyFile="GlobalBank.BasicAccounts.Module.dll">
        <Roles>
          <Role Allow="Officer"/>
          <Role Allow="BranchManager"/>
        </Roles>
      </ModuleInfo>
      <ModuleInfo AssemblyFile="GlobalBank.CreditCardAccounts.Module.dll">
        <Roles>
          <Role Allow="Officer"/>
          <Role Allow="BranchManager"/>
        </Roles>
      </ModuleInfo>
    </Modules>
  </Section>
</SolutionProfile> 

确定要加载那些模块后，就会执行上面 “6. 处理 Shell 程序集”中的过程，利用注册的 IModuleLoaderService 加载模块。SCSF 规定每个 Module 程序集都有一个继承自 ModuleInit 的子类，IModuleLoaderService  会在加载完该 Module 后自动调用其 void Load() 方法，这里是 SCSF 为我们通过的接入点，我们应该在 void Load() 方法中初始化本模块。具体应该初始化什么以后介绍。 

9. 完成对 RootWorkItem 的创建（rootWorkItem.FinishInitialization()）
主要是处理 workItem 扩展（以后介绍），并触发创建完成事件：1 protected internal void FinishInitialization()
2 {
3     IWorkItemExtensionService extensionsService = Services.Get<IWorkItemExtensionService>();
4     if (extensionsService != null)
5         extensionsService.InitializeExtensions(this);
6 
7     OnInitialized();
8 }
9 

同时 WorkItem 的 public void InitializeWorkItem() 是一个注入方法，有[InjectionMethod]属性标记，该方法执行时除了执行上面 rootworkItem中的初始化过程外，还会调用 InitializeServices 方法，该方法在 CabApplication 中是空方法，CabApplication 子类可以重写 protected virtual void InitializeServices() 方法，用于在 WorkItem 初始化时加载其他需要的服务。

10. 执行 rootWorkItem 的 run 方法 rootWorkItem.Run();

WorkItem 的 Run 方法直接调用 protected virtual void OnRunStarted() 方法：1 public void Run()
2 {
3     OnRunStarted();
4 }

OnRunStarted 方法触发 RunStarted 事件（public event EventHandler RunStarted） 1 protected virtual void OnRunStarted()
2 {
3     if (this.RunStarted != null)
4     {
5         this.RunStarted(this, EventArgs.Empty);
6     }
7 
8     if (traceSource != null)
9         traceSource.TraceInformation(String.Format(
10             CultureInfo.CurrentCulture,
11                   Properties.Resources.TraceWorkItemRunStarted, ID));
12 }
13 

因此我们可以通过注册 RunStarted 事件或者在 WorkItem 子类中重写 OnRunStarted() 虚方法以便在 SCSF 启动过程中执行自己的操作，这是 SCSF 的又一扩展点。

11. 启动应用 Start()

CabApplication 中的 Start 是一个抽象方法：protected abstract void Start();

子类 FormShellApplication（public abstract class FormShellApplication<TWorkItem, TShell> : WindowsFormsApplication<TWorkItem, TShell>） 重写了Start ： 1 protected override void Start()
2 {
3     Application.Run(Shell);
4 }
很简单，这时主窗体就显示出来了，以后的整个操作就是通过用户交互来触发了。

Visual Studio 2005 集成了单元测试框架(Team Test)，正好公司规范开发流程，需要提交Unit Test Log，以前都是用Nunit作单元测试，现在既然VS有了自己的UT类，就打算尝试一下，感觉和Nunit用起来差不多，没怎么深入，只是简单总结一下。
VSTS的单元测试（主要是Microsoft.VisualStudio.TestTools.UnitTesting）它支持：
                                          1. 生成测试代码框架；
                                          2. 在IDE中运行测试；
                                          3. 支持从数据库中加载数据的测试；
                                          4. 测试运行完成后，进行代码分析覆盖。

使用VSTS写单元测试的步骤如下：
                                                  1. 创建测试；
                                                  2. 编写测试；
                                                  3. 运行测试；
                                                  4. 代码覆盖。

1.  创建测试

打开解决方案中的.cs类文件(如：StudentManager)，在其中的一个方法(如：AddStudent() )上右击，选择“创建单元测试”命令。

在弹出的“创建单元测试”对话框中的“输出项目”下拉框中选择“创建新的Visual C# 测试项目”，单击“确定”按钮，并在“新建测试项目”对话框中输入测试项目的名称(如：MySchoolTest)，单击“创建”按钮后，就看见在原有的解决方案中生成了一个新的项目“MySchoolTest”。

测试项目创建成功后，会同时生成4个与测试相关的文件：

AuthoringTest.txt                  提供创建测试的说明，包括向项目增加其他测试的说明；

StudentManagerTest.cs         包含AddStudent()的测试，以及测试初始化和测试清除的方法；

MySchoolPro.vsmdi                测试管理文件；

localtestrun.testrunconfig      本地测试运行配置文件。

2.  编写测试

创建测试完毕后，VSTS 为我们自动生成的只是一个测试框架，默认代码中Assert.Inconclusive 表明这是一个未经验证的单元测试。

打开生成的测试文件“StudentManagerTest.cs”，    如示例1：

• 步驟一：
  建立“windows控制項程式庫”工程，
• 步驟二：
  在我們這個例子中用不到帶界面的com控件所以我們將界面的size屬性設置為 0, 0
  我們要用C＃寫COM組件必須要實現  public interface IObjectSafety接口因為這是。IObjectSafety接口，把ActiveX控件标记为安全的ActiveX控件。每個接口需要一個GUID特性。要生成變個唯一的Guid，需要運行guidgen.exe工具軟體，要選擇第四項“Registry Format”.
• 我們還有定義一個接口如下
  [Guid("1B1DFAE7-FC2E-4f05-BC5A-5267408EF2A9")]
   public interface IOLpt1
   {
    [DispId(1)] bool WriteCommand(string com,string flag);
    [DispId(2)] void WhenLoad();
   }
  功能是提供一個其他語言利用我們所寫的方法的接口。如果不用接口的話其他語言將無法使用我們在程序裡面定義的方法（我在其他的地方也看到過不用接口的例子，不知道為什麼，在我的電腦上如果不用接口編譯隻後將看不到我定義的方法）。這個接口定義了兩個方法分別是 bool WriteCommand(string com,string flag); 和 void WhenLoad();
  第一個方法是將命令寫入到並口，第二個方法是當控件啟動的時候讀取Access的命令的內碼並存如到數組中。這裡我們隻介紹如何寫COM組件，其他的將不涉及。
  定義類 UserControl1 繼承 System.Windows.Forms.UserControl 實現接口IOLpt1於IObjectSafety
  
   [Guid("AC8C1E64-B501-4f8b-A026-B4F1D8EF7DF2")]
   [ ClassInterfaceAttribute(ClassInterfaceType.AutoDual) ]
   public class UserControl1 : System.Windows.Forms.UserControl,IOLpt1,IObjectSafety
• 步驟三
  我們還要給我們的控件一個強名。強名需要用sn.exe來得到 命令格式
  sn -k myKey.snk 將得到的強名文件myKey.snk復制到你的工程的目錄下，並在我們的工程文件 AssemblyInfo.cs裡面的[assembly: AssemblyKeyFile("")]項中加入你的強名的絕對路徑F:\webpriteCon\PrintExe\mykey.snk
  例如：[assembly: AssemblyKeyFile("F:\\webpriteCon\\PrintExe\\mykey.snk")]
• 步驟四
  如圖：shuxing 
  將建置項裡面的「注冊COM組件Interop」項設置為true然後編譯隻後就可以注冊到其他的機器讓別的語言進行引用了。
• 下面是詳細代碼。
• 我將陸續寫出如何將COM組件發布成ActiveX控件。

using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing;
using System.Data;
using System.Windows.Forms;
using System.Runtime.InteropServices;
using System.Data.OleDb;

namespace PrintExe
{
 /*必須要實現IObjectSafety接口，
  * 把ActiveX控件標記為安全的ActiveX控件。
  * IObjectSafety 的實現方式如下
  */
 [Guid("10615515-3979-4f87-A0C9-F786F050AE8B"),InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
 public interface IObjectSafety
 {
  // methods
  [DispId(1)] void GetInterfacceSafyOptions(
   System.Int32 riid,
   out System.Int32 pdwSupportedOptions,
   out System.Int32 pdwEnabledOptions);
  [DispId(2)] void SetInterfaceSafetyOptions(
   System.Int32 riid,
   System.Int32 dwOptionsSetMask,
   System.Int32 dwEnabledOptions);
 }

 [Guid("1B1DFAE7-FC2E-4f05-BC5A-5267408EF2A9")]
 public interface IOLpt1
 {

  [DispId(1)] bool WriteCommand(string com,string flag);
  [DispId(2)] void WhenLoad();
 }

 [Guid("AC8C1E64-B501-4f8b-A026-B4F1D8EF7DF2")]
 [ ClassInterfaceAttribute(ClassInterfaceType.AutoDual) ]
 public class UserControl1 : System.Windows.Forms.UserControl,IOLpt1,IObjectSafety
 {
  string sqlStr;
  static string connStr = @"Jet OLEDB:Global Partial Bulk Ops=2;Jet OLEDB:Registry Path=;Jet OLEDB:Database Locking Mode=1;Data Source='C:\\printTypeDB.mdb';Mode=Share Deny None;Jet OLEDB:Engine Type=5;Provider='Microsoft.Jet.OLEDB.4.0';Jet OLEDB:System database=;Jet OLEDB:SFP=False;persist security info=False;Extended Properties=;Jet OLEDB:Compact Without Replica Repair=False;Jet OLEDB:Encrypt Database=False;Jet OLEDB:Create System Database=False;Jet OLEDB:Don't Copy Locale on Compact=False;User ID=Admin;Jet OLEDB:Global Bulk Transactions=1";

  OleDbConnection myConn = new OleDbConnection(connStr);
  OleDbCommand myComm;
  OleDbDataReader myDr;
  public string comlist="";
  string[,] myArray;

  private System.ComponentModel.Container components = null;

  public UserControl1()
  {
   InitializeComponent();
  }
  protected override void Dispose( bool disposing )
  {
   if( disposing )
   {
    if( components != null )
     components.Dispose();
   }
   base.Dispose( disposing );
  }

  #region 元件設計工具產生的程式碼
  /// <summary>
  /// 此為設計工具支援所必須的方法 - 請勿使用程式碼編輯器修改
  /// 這個方法的內容。
  /// </summary>
  private void InitializeComponent()
  {
   //
   // UserControl1
   //
   this.Name = "UserControl1";
   this.Size = new System.Drawing.Size(0, 0);

  }
  #endregion

  #region IOLpt1 成員

  public bool WriteCommand(string com,string flag)
  {
   //MessageBox.Show("WriteCommand方法已經運行","Error");
   //com為指令碼 str為要列印字符串
   ExeFunction ef = new ExeFunction();
   string[] str = com.Split(new Char[]{'~'});
   //開始將textBox中的外碼取出找到數組中對應的指令碼組成完整的指令
   string Instruction = "";
   string outI = str[0].Trim();
   if(outI!="SET")
   {
    for(int i = 0;i<myArray.Length/5;i++)
    {
     if(myArray[i,0].Trim() == outI)
     {
      char temp1 = Convert.ToChar(Convert.ToInt32(myArray[i,1].Trim()));
      char temp2='1';

      Instruction = temp1.ToString();

      if(myArray[i,2].Trim() != "")
      {
       temp2 = Convert.ToChar(Convert.ToInt32(myArray[i,2].Trim()));
       Instruction += temp1.ToString();
      }

      if(myArray[i,3].Trim() != "")
       Instruction += myArray[i,3].Trim();
     
      Instruction += str[1] + Convert.ToChar(Convert.ToInt32(myArray[i,4].Trim()));
      comlist += Instruction + "~";
      if(flag == "0") //則將指令預存起來
       return true;      
      //MessageBox.Show("方法已經運行完畢","Error");
     }
    }
    if(comlist!="")
    {
     string[] str1 = comlist.Split(new Char[]{'~'});
     comlist="";
     for(int j=0;j<str1.Length-1;j++)
     {
      byte[] buffer = System.Text.Encoding.Default.GetBytes(str1[j]);
      ef.StartP(buffer);
     }
    }
   }else if(outI == "SET") //如果為SET則為設置本機收銀機
   {
    sqlStr = "update printTypeSet set Flag = false";
    myComm = new OleDbCommand(sqlStr,myConn);
    myConn.Open();
    myDr = myComm.ExecuteReader();
    myDr.Close();
    sqlStr = "update printTypeSet set Flag = true where PrintType='" + str[1].Trim() + "'";
    myComm = new OleDbCommand(sqlStr,myConn);
    int i = myComm.ExecuteNonQuery();
    myDr.Close();
    myConn.Close();
    if(i>0)
     MessageBox.Show("設定成功！","OK");
    else
     MessageBox.Show("沒有合適的型號！","OK");
   }
   return true;
  }

  public void WhenLoad()
  {
   //MessageBox.Show("WhenLoad方法已經運行","Error");
   int i = 0;
   //先取得資料的行數
   //將資料取出放入到數組裡面
   try
   {
    sqlStr = "SELECT count(*) FROM printTypeSet WHERE Flag = true";
    myComm = new OleDbCommand(sqlStr,myConn);
    myConn.Open();
    myDr = myComm.ExecuteReader();
    if(myDr.HasRows)
    {
     while(myDr.Read())
     {
      i = (int)myDr[0];
     }
    }
    myDr.Close();
    myArray = new string[i,5];
    sqlStr = "SELECT Instruction,FirstI,SecondI,Parameter,EndI FROM printTypeSet WHERE Flag = true";
    myComm = new OleDbCommand(sqlStr,myConn);
    myDr = myComm.ExecuteReader();
    i = 0;
    if(myDr.HasRows)
    {
     while(myDr.Read())
     {
      myArray[i,0] = myDr[0].ToString();
      myArray[i,1] = myDr[1].ToString();
      myArray[i,2] = myDr[2].ToString();
      myArray[i,3] = myDr[3].ToString();
      myArray[i,4] = myDr[4].ToString();
      i++;
     }
    }
    myDr.Close();
   }
   catch(Exception ex)
   {
    MessageBox.Show("WhenLoad方法運行錯誤" + ex.ToString(),"Error");
   }
   finally
   {
    myConn.Close();
    //MessageBox.Show("方法已經運行完畢","Error");
   }
  }

  #endregion

  #region IObjectSafety 成員

  public void GetInterfacceSafyOptions(Int32 riid, out Int32 pdwSupportedOptions, out Int32 pdwEnabledOptions)
  {
   // TODO:  加入 UserControl1.GetInterfacceSafyOptions 實作
   pdwSupportedOptions = new Int32 ();
   pdwEnabledOptions = new Int32 ();
  }

  public void SetInterfaceSafetyOptions(Int32 riid, Int32 dwOptionsSetMask, Int32 dwEnabledOptions)
  {
   // TODO:  加入 UserControl1.SetInterfaceSafetyOptions 實作
  }

  #endregion
 }
}

　　模式概述

　　支持基于事件的异步模式的类会有若干个 MethodNameAsync 方法表示开始异步操作，并有对应的 MethodNameCompleted 事件。类里面还可能会有 CancelAsync或 MethodNameAsyncCancel 方法用于取消异步操作，并可以有　ProgressChanged 或 MethodNameProgressChanged事件来跟踪执行进度。下面分别作一下解释

　　MethodNameAsync 方法可以有两个重载：单调用和多调用，多调用有一个额外的状态对象参数　userState。userState 参数用来区分各次异步操作，使得我们可以多次调用多调用形式的方法而不需要等待任何异步操作的完成（在学习 IAsyncResult 模式时我把状态对象仅仅当成传给回调方法的一个条件来用，可能在使用模式时这么做并没有什么关系，但在实现模式时不把状态对象用作异常调用的唯一标识而另作他用就值得商榷了）。而单调用形式的方法如果在前一个调用尚未完成时调用将会抛出 InvalidOperationException 异常

　　如果有多个异步方法，则应使用 CancelAsync 方法来取消挂起的操作，并可使用 userState 来取消指定的挂起任务。如果只有一个异步方法则可以使用 MethodNameAsyncCancel 方法

　　另外 MSDN 上说：一次只支持一个挂起的操作的方法（如 Method1Async(string param)）是不可取消的。这句话我还没有理解，不可能说是单调用的异步方法就不能取消吧，BackgroundWorker 上都是这样做的 先不管了，接着看ProgressChanged 事件。它有一个 ProgressChangedEventArgs 参数，事件处理程序通过检查该参数的 ProgressPercentage属性来获取任务完成的百分比。如果有多个异步操作挂起，也可以通过检查参数的UserState 属性来分辨操作。如果需要用 ProgressChanged 事件来报告增量结果，则可以把结果保存在派生自 ProgressChangedEventArgs 的类中，并在事件处理程序中使用

　　BackgroundWorker

　　BackgroundWorker 很好的符合了事件异步操作模式。它有两个重载版本的 RunWorkerAsync 方法（均为单调用形式）和 RunWorkerCompleted 事件，并有 CancelAsync 方法以及 ProcessChanged 事件。不同的是 BackgroundWorker增加了 DoWork 事件，在 RunWorkerAsync 方法调用时发生，以达到将实际执行的开始方法与 BackgroundWorker 分离的目的。还需要提一下的是 WorkerReportsProcess 属性和ReportProcess 方法，前者指示能否报告进度更新，后者引发 ProcessChanged 事件，它们会在接下来的 Demo 里用到

　　尝试

　　因为平时经常要处理几十兆的文本文件，这个 Demo 就做一个读取文件并显示进度的控制台程序。先看类名和字段

　　class BackgroundWorkerDemo
　　 {
　　　　 private BackgroundWorker m_bw;
　　　　 string m_FilePath;
　　 }

　　构造函数接收文件路径为参数，设置文件路径并初始化 BackgroundWorker

　　public BackgroundWorkerDemo(string filePath)
　　　　 {
　　　　　　 m_FilePath = filePath;
　　m_bw = new BackgroundWorker();
　　　　　　 m_bw.WorkerReportsProgress = true;
　　　　　　 m_bw.DoWork += new DoWorkEventHandler(BackgroundWorker_DoWork);
　　　　　　 m_bw.ProgressChanged += new ProgressChangedEventHandler(BackgroundWorker_ProgressChanged);
　　　　　　 m_bw.RunWorkerCompleted += new RunWorkerCompletedEventHandler(BackgroundWorker_RunWorkerCompleted);
　　　　 }

　　接下来看这三个事件的处理程序。每一个事件都有各自的 EventArgs 参数类型，都很简单就不多说了

第一个 BackgroundWorker_DoWork 方法写得我有些郁闷。我在方法里取文件长度，先是直接取 StreamReader.BaseStream.Length 或 FileInfo.Length ，结果却导致很多文件读不到 100% 就结束了，不得已改成先把整个文件读一次得到字符串的长度。这样的方法当然性能不好了，主要是因为自己对 IO 一直就不够清楚，等下一个主题重新认识下 IO 再回头过来改吧。也望有经验的朋友赐教，感激不尽　　/**//// <summary>
　　　　 /// DoWork event process method
　　　　 /// </summary>
　　　　 /// <param name="sender"></param>
　　　　 /// <param name="e"></param>
　　　　 private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
　　　　 {
　　　　　　 long length;
　　　　　　 using (StreamReader sr = new StreamReader(m_FilePath))
　　　　　　 {
　　　　　　　　 // Get file length
　　　　　　　　 length = sr.ReadToEnd().Length;
　　　　　　 }
　　using (StreamReader sr = new StreamReader(m_FilePath))
　　　　　　 {
　　　　　　　　 long onePercentOfLength = length / 100;
　　　　　　　　 long currentPosition = 0;
　　　　　　　　 int i = 0;
　　while (!sr.EndOfStream)
　　　　　　　　 {
　　　　　　　　　　 sr.Read();
　　　　　　　　　　 currentPosition ++;
　　// Produce ProcessChanged event in each percent reading
　　　　　　　　　　 while (currentPosition > onePercentOfLength * i)
　　　　　　　　　　 {
　　　　　　　　　　　　 ((BackgroundWorker)sender).ReportProgress(i++);
　　　　　　　　　　 }
　　　　　　　　 }
　　// e.Result will be used in RunWorkerCompleted event process method
　　　　　　　　 e.Result = currentPosition;
　　　　　　 }
　　　　 }
　　BackgroundWorker_ProgressChanged 方法，简单输出当前进度
　　/**//// <summary>
　　　　 /// ProgressChanged event process method
　　　　 /// </summary>
　　　　 /// <param name="sender"></param>
　　　　 /// <param name="e"></param>
　　　　 private void BackgroundWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
　　　　 {
　　　　　　 Console.WriteLine("Reading percents: " + e.ProgressPercentage + "%");
　　　　 }

　　BackgroundWorker_RunWorkerCompleted 方法，输出结果。这里要注意如果 RunWorkerCompletedEventArgs 参数的 Error 属性不为空则读取其他属性会产生异常，然后如果 Cancelled 属性为 true 则读取 Result 属性也会产生异常，因此必须依次判断各属性的值

　/**//// <summary>
　　　　 /// RunWorkerCompleted event process method
　　　　 /// </summary>
　　　　 /// <param name="sender"></param>
　　　　 /// <param name="e"></param>
　　　　 private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
　　　　 {
　　　　　　 if (e.Error != null)
　　　　　　 {
　　　　　　　　 Console.WriteLine("Error occurs: " + e.Error.Message);
　　　　　　 }
　　　　　　 else if(e.Cancelled)
　　　　　　 {
　　　　　　　　 Console.WriteLine("Work cancelled");
　　　　　　 }
　　　　　　 else
　　　　　　 {
　　　　　　　　 Console.WriteLine("Read finished, the file length is: " + e.Result);
　　　　　　 }
　　　　 }

　　向外提供一个入口方法

　　/**//// <summary>
　　　　 /// Test portal
　　　　 /// </summary>
　　　　 public void ReadAsync()
　　　　 {
　　　　　　 if (File.Exists(m_FilePath))
　　　　　　 {
　　　　　　　　 Console.WriteLine("Begin read");
　　　　　　　　 m_bw.RunWorkerAsync();
　　　　　　 }
　　　　　　 else
　　　　　　 {
　　　　　　　　 throw new FileNotFoundException("Can't find file: " + m_FilePath);
　　　　　　 }
　　　　 }

　　最后是 Main 方法，比昨天有了小小的改变，用 Console.ReadLine 代替了 Thread.Sleep 来达到阻止主线程退出的目的

　　class BackgroundWorkerTest
　　 {
　　　　 static void Main(string[] args)
　　　　 {
　　　　　　 Console.Write("Input file path: ");
　　　　　　 string filePath = Console.ReadLine();
　　BackgroundWorkerDemo demo = new BackgroundWorkerDemo(filePath);
　　　　　　 demo.ReadAsync();
　　// Thread waiting
　　　　　　 Console.ReadLine();
　　　　 }
　　 }

　　其他

　　回顾一下我用委托实现 IAsyncResult 模式的 Demo ，与用 BackgroundWorker 实现的基于事件的异步模式很相似吧。而且应用程序可以通过委托的 BeginInvoke 和 EndInvoke 方法来异步执行现有的同步方法而不需要作额外的修改，BackgroundWorker 也差不多是一样。我把这两者看成实现对应异步操作模式的范本，在性能要求不是很高的一些异步操作场合，用好委托和 BackgroundWorker 就可以简单有效的完成开发了

　　概述

　　IAsyncResult 异步设计模式通过名为 BeginOperationName 和 EndOperationName 的两个方法来实现原同步方法的异步调用，如 FileStream 类提供了 BeginRead 和 EndRead 方法来从文件异步读取字节，它们是 Read 方法的异步版本

　　Begin 方法包含同步方法签名中的任何参数，此外还包含另外两个参数：一个AsyncCallback 委托和一个用户定义的状态对象。委托用来调用回调方法，状态对象是用来向回调方法传递状态信息。该方法返回一个实现 IAsyncResult 接口的对象

　　End 方法用于结束异步操作并返回结果，因此包含同步方法签名中的 ref 和 out 参数，返回值类型也与同步方法相同。该方法还包括一个 IAsyncResult 参数，用于获取异步操作是否完成的信息，当然在使用时就必须传入对应的 Begin 方法返回的对象实例

　　开始异步操作后如果要阻止应用程序，可以直接调用 End 方法，这会阻止应用程序直到异步操作完成后再继续执行。也可以使用 IAsyncResult 的 AsyncWaitHandle 属性，调用其中的WaitOne等方法来阻塞线程。这两种方法的区别不大，只是前者必须一直等待而后者可以设置等待超时

　　如果不阻止应用程序，则可以通过轮循 IAsyncResult 的 IsCompleted 状态来判断操作是否完成，或使用 AsyncCallback 委托来结束异步操作。AsyncCallback 委托包含一个 IAsyncResult 的签名，回调方法内部再调用 End 方法来获取操作执行结果

　　尝试

　　先来熟悉一下今天的主角，IAsyncResult 接口

public interface IAsyncResult
{
object AsyncState { get; }
WaitHandle AsyncWaitHandle { get; }
bool CompletedSynchronously { get; }
bool IsCompleted { get; }
}
            

　　我用一个 AsyncDemo 类作为异步方法的提供者，后面的程序都会调用它。内部很简单，构造函数接收一个字符串作为 name ，Run 方法输出 "My name is " + name ，而异步方法直接用委托的 BeginInvoke 和 EndInvoke 方法实现

public class AsyncDemo
{
// Use in asynchronous methods
private delegate string runDelegate();
private string m_Name;
private runDelegate m_Delegate;
public AsyncDemo(string name)
{
m_Name = name;
m_Delegate = new runDelegate(Run);
}
/**////
/// Synchronous method
///
///
public string Run()
{
return "My name is " + m_Name;
}
/**////
/// Asynchronous begin method
///
///
///
///
public IAsyncResult BeginRun(AsyncCallback callBack, Object stateObject)
{
try
{
return m_Delegate.BeginInvoke(callBack, stateObject);
}
catch(Exception e)
{
// Hide inside method invoking stack
throw e;
}
}
/**////
/// Asynchronous end method
///
///
///
public string EndRun(IAsyncResult ar)
{
if (ar == null)
throw new NullReferenceException("Arggument ar can't be null");
try
{
return m_Delegate.EndInvoke(ar);
}
catch (Exception e)
{
// Hide inside method invoking stack
throw e;
}
}
            } 

　　首先是 Begin 之后直接调用 End 方法，当然中间也可以做其他的操作

class AsyncTest
{
static void Main(string[] args)
{
AsyncDemo demo = new AsyncDemo("jiangnii");
// Execute begin method
IAsyncResult ar = demo.BeginRun(null, null);
// You can do other things here
// Use end method to block thread until the operation is complete
string demoName = demo.EndRun(ar);
Console.WriteLine(demoName);
}
            } 

　　也可以用 IAsyncResult 的 AsyncWaitHandle 属性，我在这里设置为1秒超时

class AsyncTest
{
static void Main(string[] args)
{
AsyncDemo demo = new AsyncDemo("jiangnii");
// Execute begin method
IAsyncResult ar = demo.BeginRun(null, null);
// You can do other things here
// Use AsyncWaitHandle.WaitOne method to block thread for 1 second at most
ar.AsyncWaitHandle.WaitOne(1000, false);
if (ar.IsCompleted)
{
// Still need use end method to get result, 
// but this time it will return immediately
string demoName = demo.EndRun(ar);
Console.WriteLine(demoName);
}
else
{
Console.WriteLine("Sorry, can't get demoName, the time is over");
}
}
            } 

　　不中断的轮循，每次循环输出一个 "."

class AsyncTest
{
static void Main(string[] args)
{
AsyncDemo demo = new AsyncDemo("jiangnii");
// Execute begin method
IAsyncResult ar = demo.BeginRun(null, null);
Console.Write("Waiting..");
while (!ar.IsCompleted)
{
Console.Write(".");
// You can do other things here
}
Console.WriteLine();
// Still need use end method to get result, 
// but this time it will return immediately
string demoName = demo.EndRun(ar);
Console.WriteLine(demoName);
}
            } 

　　最后是使用回调方法并加上状态对象，状态对象被作为 IAsyncResult 参数的 AsyncState 属性被传给回调方法。回调方法执行前不能让主线程退出，我这里只是简单的让其休眠了1秒。另一个与之前不同的地方是 AsyncDemo 对象被定义成了类的静态字段，以便回调方法使用

 class AsyncTest
{
static AsyncDemo demo = new AsyncDemo("jiangnii");
static void Main(string[] args)
{
// State object
bool state = false;
// Execute begin method
IAsyncResult ar = demo.BeginRun(new AsyncCallback(outPut), state);
// You can do other thins here
// Wait until callback finished
System.Threading.Thread.Sleep(1000);
}
// Callback method
static void outPut(IAsyncResult ar)
{
bool state = (bool)ar.AsyncState;
string demoName = demo.EndRun(ar);
if (state)
{
Console.WriteLine(demoName);
}
else
{
Console.WriteLine(demoName + ", isn't it?");
}
}
            } 

　　其他

　　对于一个已经实现了 BeginOperationName 和 EndOperationName 方法的对象，我们可以直接用上述方式调用，但对于只有同步方法的对象，我们要对其进行异步调用也不需要增加对应的异步方法，而只需定义一个委托并使用其 BeginInvoke 和 EndInvoke 方法就可以了