C# 互操作性入門系列(四)：在C# 中調用COM組件

本文轉載自：https://www.cnblogs.com/zhili/archive/2013/01/27/COMInterop.html

本專題概要：

• 引言
• 如何在C#中調用COM組件——訪問Office 互操作對象
• 在C# 中調用COM組件的實現原理剖析
• 錯誤處理
• 小結

 

一、引言

　　COM（Component Object Modele,組件對象模型）是微軟以前推崇的一個開發技術，所以現在微軟的很多產品都用到了COM組件，如Office,IE 等。然而如果.NET 平台下的程序想訪問COM組件的方式來實現某個功能怎么辦呢？ 正是由於開發人員有這個需求，所以微軟在.NET FrameWork中為COM和托管代碼之間進行互操作提供了支持，這種互操作性的技術就是COM Interop。 但是COM Interop(COm互操作)這項技術，不僅支持在托管代碼中使用COM對象，並且也支持在COM中使用托管對象，本專題只針對在.NET中調用COM對象來介紹，由於COM技術現在用的不多，所以如何在COM中使用托管對象將不會在本系列中做出介紹，如果有需要的朋友可以參看MSDN的相關鏈接： http://msdn.microsoft.com/zh-cn/library/3y76b69k(v=vs.100).aspx。

下面就從一個具體的實例來看看在.NET 中是如何調用COM組件的。

二、如何在C#中調用COM組件——訪問Office 互操作對象

　　因為Office產品中使用了很多COM組件，下面就演示通過調用Office中的COM對象來創建Word文檔並保存創建的文檔到文件目錄下的例子（在新建的控制台程序里添加”Microsoft.Office.Interop.Word 14.0.0.0 “ 這個引用，14.0.0.0版本是對應於Office 2010的一個互操作程序集， 12.0.0.0版本則是對應於Office 2007的互操作程序集，如果你電腦中只安裝了Office 2007的話，就只能找到 12.0.0.0的版本的，如果安裝了Office 2010的話，就可以同時找到這兩個版本。）。具體代碼如下：

using System;
// 添加額外的命名空間
using Microsoft.Office.Interop.Word;

namespace COM互操作性
{
    class Program
    {
        static void Main(string[] args)
        {
            // 調用COM對象來創建Word文檔
            CreateWordDocument();
        }

        private static void CreateWordDocument()
        {
            // 啟動Word並使Word可見
            Application wordApp = new Application() { Visible = true };

            // 新建Word文檔
            wordApp.Documents.Add();
            Document wordDoc = wordApp.ActiveDocument;
            Paragraph para = wordDoc.Paragraphs.Add();
            para.Range.Text = "歡迎你，進入Learning Hard博客";

            // 保存文檔
            object filename = @"D:\learninghard.doc";
            wordDoc.SaveAs2(filename);

            // 關閉Word
            wordDoc.Close();
            wordApp.Application.Quit();
        }
    }
}

運行結果為:

此時在所指定的文件目錄中就可以看到你剛才創建的Word文檔了。通過COM互操作的技術我們可以Office的自動化操作。

三、在C# 中調用COM組件的實現原理剖析

　　通過上面的例子，大家可以看出在.NET 中調用COM組件是非常方便和簡單的，以至於我們根本不能明白它背后的原理的，下面就介紹在托管代碼中調用COM組件的實現原理和需要的步驟。

要運行上面的程序必須添加一個互操作程序集——“Microsoft.Office.Interop.Word 14.0.0.0”，大家可以通過下面的步驟來添加這個程序集：

•  請在“解決方案資源管理器”中，右擊“引用”文件夾，然后單擊“添加引用”。 
• 在“.NET”選項卡上，選中最新版本的 Microsoft.Office.Interop.Word。  例如，“Microsoft.Office.Interop.Excel 14.0.0.0”。  單擊“確定”。

　　通過上面添加引用的步驟可以看出，Microsoft.Office.Interop.Word.dll 是一個.NET程序集，而不是COM組件，這時候朋友們肯定有這樣的疑問——不是調用COM組件的嗎？怎么在托管代碼中調用.NET 程序集的？這樣怎么能算是在.NET下調用COM組件的演示了？ 然而事實是—— Microsoft.Office.Interop.Word.dll 確實是一個.NET程序集，並且它也叫做COM組件的互操作程序集，這個程序集中包含了COM組件中定義的類型的元數據， 托管代碼通過調用互操作程序集中公開的接口或對象來間接地調用COM對象和接口的。由於托管代碼中不能直接使用COM對象和接口，所以托管代碼對COM對象的調用時是通過CLR的 COM Interop 層作為代理完成的，這個代理就是RCW（即Runtime Callable Wrapper,運行時可調用包裝），所以對COM對象的調用，都是通過RCW來完成的，RCW做的工作主要有激活COM對象和在托管代碼和非托管代碼之間進行數據封送處理（從這里可以看出，RCW就是 .NET平台和COM組件之間的一個代理，微軟的很多技術都使用了代理的，例如WCF技術——我們在代碼中創建的對象其實只是服務的一個代理，通過代理對象來訪問真真的對象的服務，即方法。講到代理的技術，C#中的委托也是代理的一種實現，此時又想到了23中設計模式中的——代理模式，然而生活中也不乏代理的例子，租房中介，代理服務器等）。下面通過一個圖來演示下 在.NET中調用COM組件的原理：

　　關於通過Tlblmp.exe工具來生成互操作程序集步驟，這里我就不多詳細訴說了，大家可以參考MSDN中這個工具詳細使用說明 ：http://msdn.microsoft.com/zh-cn/library/tt0cf3sx(v=VS.80).aspx 。

　　然而我們也可以使用Visual Studio中內置的支持來完成為COM類型庫創建互操作程序集的工作，我們只需要在VS中為.NET 項目添加對應的COM組件的引用，此時VS就會自動將COM類型庫中的COM類型庫轉化為程序集中的元數據，並在項目的Bin目錄下生成對於的互操作程序集，所以在VS中添加COM引用，其實最后程序中引用的是互操作程序集，然后通過RCW來對COM組件進行調用。 然而對於Office中的Microsoft.Office.Interop.Wordd.dll，這個程序集也是互操作程序集，但是它又是主互操作程序集，即PIA(Primary Interop Assemblies)。主互操作程序集是一個由供應商提供的唯一的程序集，為了生成主互操作程序集，可以在使用TlbImp命令是打開 /primary 選項。看到這里，朋友們肯定有這樣的疑問：PIA與普通程序集到底有什么區別呢？——區別就是PIA除了包含了COM組件定義的數據類型外，還包含了一些特殊的信息，如公鑰，COM類型庫的提供者等信息。然而 為什么需要主互操作程序集的呢 ？ 對於這個問題的答案就是——主互操作程序集可以幫助我們解決部署程序時，引用互操作程序集版本不一致的問題。(如果開發人員會為一個COM組件類型庫生成多個互操作程序集，項目中引用的互操作程序集版本與部署時的互操作程序集版本不一致的問題，有了互操作程序集時，我們可以直接引用官方提供主互操作程序集。)

四、錯誤處理

 知道了如何調用COM組件之后，大家或許會問：如果調用COM對象的方法失敗時怎么去獲取失敗的信息呢？對於這個疑問，錯誤的處理的方法和我們平常托管代碼中的處理方式是一樣的，下面就具體看看是如何獲取錯誤信息的，下面這段代碼的功能是——打開一個現有的Word文檔並插入相應的文本，當指定的Word文檔不存在時，此時就會出現調用COM對象的Open方法失敗的情況，具體代碼如下：

using System;
using Microsoft.Office.Interop.Word;
using System.IO;
using System.Runtime.InteropServices;

namespace COM互操作中的錯誤處理
{
    class Program
    {
        static void Main(string[] args)
        {
           // 打開存在的文檔插入文本
            string wordPath = @"D:\test.docx";
            OpenWordDocument(wordPath);
            Console.Read();
        }

        // 向現有文檔插入文本
        private static void OpenWordDocument(string wordPath)
        {
            // 啟動Word 應用程序
            Application wordApp = new Application() { Visible = true };
            Document wordDoc=null;
            try
            {
                // 如果文檔不存在時，就會出現調用COM對象失敗的情況
                // 打開Word文檔
                wordDoc = wordApp.Documents.Open(wordPath);
                // 向Word中插入文本
                Range wordRange = wordDoc.Range(0, 0);
                wordRange.Text = "這是插入的文本";

                // 保存文檔
                wordDoc.Save();
            }
            catch(Exception ex)
            {          
                // 獲得異常相對應的HRESULT值
                // 因為COM中根據方法返回的HRESULT來判斷調用是否成功的
                int HResult = Marshal.GetHRForException(ex);
                // 設置控制台的前景色，即輸出文本的顏色
                Console.ForegroundColor = ConsoleColor.Red;
                // 下面把HRESULT值以16進制輸出
                Console.WriteLine("調用拋出異常，異常類型為：{0}, HRESULT= 0x{1:x}", ex.GetType().Name, HResult);
                Console.WriteLine("異常信息為：" + ex.Message.Replace('\r', ' '));
            }
            finally
            {
                // 關閉文檔並
                if (wordDoc != null)
                {
                    wordDoc.Close();
                }
                // 退出Word程序
                wordApp.Quit();
            }
        }
    }
}

如果我們D盤中不存在一個 test.docx文檔時，此時代碼就會進入catch塊，輸出異常信息，運行結果為：

　　從上面的結果我們看到了一個 HRESULT值，這個值真是COM代碼中返回返回的。在COM中，COM方法通過返回 HRESULT 來報告錯誤；.NET 方法則通過引發異常來報告錯誤，為了方便地在托管代碼中獲得COM代碼中出現的錯誤和異常信息，CLR提供了兩者之間的轉換，每一個代表錯誤發生的HRESULT都會被映射到.NET Framework中的一個異常類，對於具體的映射關系可以參考MSDN中 的文章： http://msdn.microsoft.com/zh-cn/library/9ztbc5s1(VS.80).aspx ，我這里就不具體用表格列出來的。 如果某個HRESULR不能被映射到等效的.NET Framework 異常類時，那么就會被映射到COMException異常類， 我們可以通過 Marshal類的GetHRForException方法來獲得異常類對應的HRESULT值（該方法的使用在上面代碼中已經貼出）

五、小結

　　關於在.NET中調用COM組件的介紹就到這里的，即使我們在.NET中調用COM對象的方法是非常的簡單和方便，但是理解CLR 為我們背后完成的工作到底有哪些和理解托管代碼中調用COM組件原理也是相當有必要的。因為理解了調用的原理之后，當我們出現問題的時候就可以很快找到解決方案並解決它，不會覺得無從下手，這樣就可以幫助我們提供解決問題的能力。