在多线程中调用WinForm

教你如何用ISynchronizeInvoke接口在正确的线程中进行调用；以及如何将HTML放入剪贴板以使其他程序可以使用。
by Juval Lowy and Karl E.Peterson
技术工具箱：C#, VB6, VB5, WinForms

问题：在多线程中调用Winform
我的WinForm程序中有一个用于更新主窗口的工作线程（worker thread），但文档中却提示我不能在多线程中调用这个form（为什么？），而事实上我在调用时程序常常会崩掉。请问如何从多线程中调用form中的方法呢？

解答：
每一个从Control类中派生出来的WinForm类（包括Control类）都是依靠底层Windows消息和一个消息泵循环（message pump loop）来执行的。消息循环都必须有一个相对应的线程，因为发送到一个window的消息实际上只会被发送到创建该window的线程中去。其结果是，即使提供了同步（synchronization），你也无法从多线程中调用这些处理消息的方法。大多数plumbing是掩藏起来的，因为WinForm是用代理（delegate）将消息绑定到事件处理方法中的。WinForm将Windows消息转换为一个基于代理的事件，但你还是必须注意，由于最初消息循环的缘故，只有创建该form的线程才能调用其事件处理方法。如果你在你自己的线程中调用这些方法，则它们会在该线程中处理事件，而不是在指定的线程中进行处理。你可以从任何线程中调用任何不属于消息处理的方法。

Control类（及其派生类）实现了一个定义在System.ComponentModel命名空间下的接口 -- ISynchronizeInvoke，并以此来处理多线程中调用消息处理方法的问题：

public interface ISynchronizeInvoke { object Invoke(Delegate method,object[] args); IAsyncResult BeginInvoke(Delegate method,object[] args); object EndInvoke(IAsyncResult result); bool InvokeRequired {get;} }

ISynchronizeInvoke提供了一个普通的标准机制用于在其他线程的对象中进行方法调用。例如，如果一个对象实现了ISynchronizeInvoke，那么在线程T1上的客户端可以在该对象中调用ISynchronizeInvoke的Invoke()方法。Invoke()方法的实现会阻塞（block）该线程的调用，它将调用打包发送（marshal）到 T2，并在T2中执行调用，再将返回值发送会T1，然后返回到T1的客户端。Invoke()方法以一个代理来定位该方法在T2中的调用，并以一个普通的对象数组做为其参数。

调用者还可以检查InvokeRequired属性，因为你既可以在同一线程中调用ISynchronizeInvoke也可以将它重新定位（redirect）到其他线程中去。如果InvokeRequired的返回值是false的话，则调用者可以直接调用该对象的方法。

比如，假设你想要从另一个线程中调用某个form中的Close方法，那么你可以使用预先定义好的的MethodInvoker代理，并调用Invoke方法:

Form form; /* obtain a reference to the form, then: */ ISynchronizeInvoke synchronizer; synchronizer = form; if(synchronizer.InvokeRequired) { MethodInvoker invoker = new MethodInvoker(form.Close); synchronizer.Invoke(invoker,null); } else form.Close();

ISynchronizeInvoke不仅仅用于WinForm中。例如，一个Calculator类提供了将两个数字相加的Add()方法，它就是通过ISynchronizeInvoke来实现的。用户必须确定ISynchronizeInvoke.Invoke()方法的调用是执行在正确的线程中的（见列表A）。

或许你并不想进行同步调用，因为它被打包发送到另一个线程中去了。你可以通过BeginInvoke()和EndInvoke()方法来实现它。你可以依照通用的.NET非同步编程模式（asynchronous programming model）来使用这些方法：用BeginInvoke()来发送调用，用EndInvoke()来实现等待或用于在完成时进行提示以及收集返回结果。

还值得一提的是ISynchronizeInvoke方法并非安全类型。 类型不符会导致在执行时被抛出异常，而不是编译错误。所以在使用ISynchronizeInvoke时要格外注意，因为编辑器无法检查出执行错误。

实现ISynchronizeInvoke要求你使用一个代理来在后期绑定（late binding）中动态地调用方法。每一种代理类型均提供DynamicInvoke()方法：

public object DynamicInvoke(object[] args);

理论上来说，你必须将一个方法代理放到一个需要提供对象运行的真实的线程中去，并使Invoke() 和BeginInvoke()方法中的代理中调用DynamicInvoke()方法。ISynchronizeInvoke的实现是一个非同一般的编程技巧，本文附带的源文件中包含了一个名为Synchronizer的帮助类（helper class）和一个测试程序，这个测试程序是用来论证列表A中的Calculator类是如何用Synchronizer类来实现ISynchronizeInvoke的。Synchronizer是ISynchronizeInvoke的一个普通实现，你可以使用它的派生类或者将其本身作为一个对象来使用，并将ISynchronizeInvoke实现指派给它。

用来实现Synchronizer的一个重要元素是使用一个名为WorkerThread的嵌套类（nested class）。WorkerThread中有一个工作项目（work item）查询。WorkItem类中包含方法代理和参数。Invoke()和BeginInvoke()用来将一个工作项目实例加入到查询里。WorkerThread新建一个.NET worker线程，它负责监测工作项目的查询任务。查询到项目之后，worker会读取它们，然后调用DynamicInvoke()方法。 —J.L.

问题：处理HTML文档和剪贴板（clipboard）
我的程序需要将HTML文档放进剪贴板中，但我不知道要怎样处理才能使其他程序也能使用它。我查看了一些关于HTML Clipboard Format (CF_HTML)的参考说明，但我还是找不到准确的定义。请问我该如何操作？

解答：
使用带有Windows 剪贴板的CF_HTML Clipboard Format的确容易让人搞胡涂，一部分是因为它不是clipboard format中自带的剪贴板；它是一个注册格式（registered format），所以不是一个常量，因为它的值会因为系统的不同而产生变化。你可以通过一个简单的API调用 -- RegisterClipboardFormat来获得一个注册剪贴板格式的值。这个函数的首次调用会通过一个给定的字符串来执行，它返回一个范围在C000-FFFF之间的唯一值。每一个在系统上处理的后续调用（subsequent call）会返回同样的值。用于这种格式中的关键字符串就是“HTML Format”：

Private Declare Function _ RegisterClipboardFormat _ Lib "user32" _ Alias "RegisterClipboardFormatA" _ (ByVal lpString As String) As Long Dim CF_HTML As Long Const RegHtml As String = "HTML Format" CF_HTML = _ RegisterClipboardFormat(RegHtml)

你必须首先构建一个描述性的header，并在将HTML数据放入剪贴板之前先把它放到数据中。这个header会给其他程序提供描述版本信息、HTML起始数据的偏移量（offset），以及有关实际选择范围（actual selection）起始地方的信息。用户可能会选择的HTML文档的一部分甚至只是一个元素（比如一个table中的几行）作为一个选择区域。页面的其他部分，比如内联样式定义（inline style definitions）则可能会被要求进行完全渲染（render）。你不仅需要将最初所选择的HTML区域放入剪贴板，而且还需要放入一个header，它看起来就像是这样：

Version:1.0 StartHTML:000000258 EndHTML:000001491 StartFragment:000001172 EndFragment:000001411

应用程序通过StartFragment和EndFragment属性来决定哪些数据需要粘贴，这些数据或许会（也可能不会）用剩下的HTML对所选择的部分进行格式安排。你必须将HTML注释放入数据中以便将来对所选部分进行识别。很明显，你必须在构建最后的header之前完成它，否则偏移量会有变化。一个用于所选数据的opening/closing注释标签分别是“ ”和“ ”（见列表1）。

在这里我无法对这个header的各个方面都进行详细的介绍，所以我只能讲解一些要点，你可以参考范例代码以及进行更深入的了解（见资源）。你必须记住几个要点。Header中的偏移量是以零为基准的，因此你必须以此来调节你的字符串操作程序（string-manipulation routine ）。而且，如果你不仅需要读取而且需要编写header，你则必须了解字符数（number of digits ）（比如Internet Explorer [IE] 是9，Word是10）。

最后，如果你只是将CF_HTML放入剪贴板，那么诸如Word和FrontPage等程序就处理不了了。你必须同时给剪贴板提供一个格式化的HTML的纯文本编译（plain-text rendition）以实现你所希望的结果。许多用来执行HTML-to-text转换的工具或是macho可能都需要执行自带的剖析器。但是Windows程序员是不需要对HTML进行手动解析的。你可以用OS来取代这个日常任务：

Public Function Html2Text(ByVal Data _ As String) As String Dim obj As Object On Error Resume Next Set obj = _ CreateObject("htmlfile") obj.Open obj.Write Data Html2Text = obj.Body.InnerText End Function

升级IE并不是解析HTML最快的方法，但却是相当好用的方法。 —K.E.P.

关于作者:
Juval Lowy是位经验丰富的软件架构师，并且是IDesign的负责人。这是一家专门从事.NET设计和.NET移植的咨询和培训公司。作为Microsoft在硅谷的地区主管，Juval负责帮助将.NET运用到企业中。Juval著有COM and .NET Component Services（O’Reilly）一书，你可以通过 www.idesign.net与他联系。
Karl E. Peterson是一家区域运输规划代理的GIS分析员，也是Visual Studio 杂志技术评论者和社论顾问，以及Microsoft MVP和几个VSM论坛板块的版主。想要看到更多Karl写的的VB代码实例，你可以浏览 www.mvps.org/vb网站。