C#互操作性入門系列(三)：平臺調用中的數據封送處理

C#互操作系列文章：

1. C#互操作性入門系列(一)：C#中互操作性介紹

2. C#互操作性入門系列(二)：使用平臺調用調用Win32 函數

3. C#互操作性入門系列(三)：平臺調用中的數據封送處理

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

本專題概要

• 數據封送介紹

• 封送Win32數據類型

• 封送字符串的處理

• 封送結構體的處理

• 封送類的處理

• 小結

一、數據封送介紹

看到這個專題時，大家的第一個疑問肯定是——什么是數據封送呢？(這系列專題中采用假設朋友的提問方式來解說概念，就是希望大家帶著問題去學習本專題內容，以及大家在平時的學習過程中也可以采用這個方式，個人覺得這個方式可以使自己學習效率有所提高，即使這樣在學習的過程可能會顯得慢了，但是這種方式會對你所看過的知識點會有一個更深的印象。遠比看的很快，最后卻發現記住的沒多少強，在這里分享下這個學習方式，認為可以接受的朋友可以在平時的學習中可以嘗試下的，如果覺得不好的話，相信大家肯定也會有自己更好的學習方式的。)對于這個問題的解釋是，數據封送是——在托管代碼中對非托管函數進行互操作時，需要通過方法的參數和返回值在托管內存和非托管內存之間傳遞數據的過程，數據封送處理的過程是由CLR(公共語言運行時)的封送處理服務(即封送拆送器)完成的。

封送拆送器主要進行3項任務：

1. 將數據從托管類型轉換為非托管類型，或從非托管類型轉換為托管類型

2. 將經過類型轉換的數據從托管代碼內存復制到非托管內存，或從非托管內存復制到托管內存

3. 調用完成后，釋放封送處理過程中分配的內存

二、封送Win32數據類型

對非托管代碼進行互操作時，一定會有數據的封送處理。然而封送時需要處理的數據類型分為兩種——可直接復制到本機結構中的類型(blittable)和非直接復制到本機結構中的類型(non-bittable)。下面就這兩種數據類型分別做一個介紹。

2.1 可直接復制到本機結構中的類型

由于在托管代碼和非托管代碼中，數據類型在托管內存和非托管內存的表示形式不一樣，因為這樣的原因，所以我們需要對數據進行封送處理，以至于在托管代碼中調用非托管函數時，把正確的傳入參數傳遞給非托管函數和把正確的返回值返回給托管代碼中。然而，并不是所有數據類型在兩者內存的表現形式不一樣的，這時候我們把在托管內存和非托管內存中有相同表現形式的數據類型稱為——可直接復制到本機結構中的類型，這些數據類型不需要封送拆送器進行任何特殊的處理就可以在托管和非托管代碼之間傳遞, 下面列出一些課直接復制到本機結構中的簡單數據類型：

除了上表列出來的簡單類型之外，還有一些復制類型也屬于可直接復制到本機結構中的數據類型：

（1） 數據元素都是可直接復制到本機結構中的一元數組，如整數數組，浮點數組等

（2）只包含可直接復制到本機結構中的格式化值類型

（3）成員變量全部都是可復制到本機結構中的類型且作為格式化類型封送的類

上面提到的格式化指的是——在類型定義時，成員的內存布局在聲明時就明確指定的類型。在代碼中用StructLayout屬性修飾被指定的類型，并將StructLayout的LayoutKind屬性設置為Sequential或Explicit，例如：

using System.Runtime.InteropServices;  
// 下面的結構體也屬于可直接復制到本機結構中的類型 
[StructLayout(LayoutKind.Sequential)]  
publicstruct Point {  
publicint x;  
publicint y;  
}    

.2 非直接復制到本機結構中的類型

如果一個類型不是可直接復制到本機結構中的類型，那么它就是非直接復制到本機結構中的類型。由于一些類型在托管內存和非托管內存的表現形式不一樣，所以對于這種類型，封送器需要對它們進行相應的類型轉換之后再復制到被調用的函數中，下面列出一些非直接復制到本機結構中的數據類型：

除了上表中列出的類型之外，還有很多其他類型屬于非直接復制到本機結構中的類型，例如其他指針類型和句柄類型等。理解了blittable和non-blittable類型的區別之后，就可以在互操作過程更好地處理數據的封送，下面就具體的一些數據類型的封送問題做一個簡單介紹

三、封送字符串的處理

在上一個專題中，我們已經涉及到字符串的封送問題了(上一個專題中使用了將字符串作為In參數傳遞給Win32 MessageBox 函數，具體可以查看上一個專題) 。所以在這部分將介紹——封送作為返回值的字符串,下面是一段演示代碼,代碼中主要是調用Win32 GetTempPath函數來獲得返回返回臨時路徑,此時拆送器就需要把返回的字符串封送回托管代碼中。

// 托管函數中的返回值封送回托管函數的例子 
class Program  
    {  
// Win32 GetTempPath函數的定義如下：    
//DWORD WINAPI GetTempPath( 
//  _In_   DWORD nBufferLength, 
//  _Out_  LPTSTR lpBuffer 
//);    // 主要是注意如何在托管代碼中定義該函數原型               [DllImport("Kernel32.dll", CharSet = CharSet.Unicode, SetLastError=true)] 
publicstaticexternuint GetTempPath(int bufferLength, StringBuilder buffer);  
staticvoid Main(string[] args)  
        {  
            StringBuilder buffer = new StringBuilder(300);  
uint tempPath=GetTempPath(300, buffer);  
string path = buffer.ToString();  
if (tempPath == 0)  
            {  
int errorcode =Marshal.GetLastWin32Error();  
                Win32Exception win32expection = new Win32Exception(errorcode);  
                Console.WriteLine("調用非托管函數發生異常，異常信息為：" +win32expection.Message);  
            }  
            Console.WriteLine("調用非托管函數成功。");  
            Console.WriteLine("Temp 路徑為：" + buffer);   
            Console.Read();  
        }  
    } 

運行結果為:

四、封送結構體的處理

在我們實際調用Win32 API函數時，經常需要封送結構體和類等復制類型，下面就以Win32 函數GetVersionEx為例子來演示如何對作為參數的結構體進行封送處理。為了在托管代碼中調用非托管代碼,首先我們就要知道非托管函數的定義,下面是GetVersionEx非托管定義(更多關于該函數的信息可以參看MSDN鏈接:http://msdn.microsoft.com/en-us/library/ms885648.aspx )：

BOOL GetVersionEx(   
  LPOSVERSIONINFO lpVersionInformation  
);  

參數lpVersionInformation是一個指向 OSVERSIONINFO結構體的指針類型,所以我們在托管代碼中為函數GetVersionEx函數之前，必須知道 OSVERSIONINFO結構體的非托管定義，然后再在托管代碼中定義一個等價的結構體類型作為參數。以下是OSVERSIONINFO結構體的非托管定義：

typedefstruct  _OSVERSIONINFO{  
DWORD dwOSVersionInfoSize;       //在使用GetVersionEx之前要將此初始化為結構的大小 
DWORD dwMajorVersion;               //系統主版本號 
DWORD dwMinorVersion;               //系統次版本號 
DWORD dwBuildNumber;               //系統構建號 
DWORD dwPlatformId;                  //系統支持的平臺 
TCHAR szCSDVersion[128];          //系統補丁包的名稱 
WORD wServicePackMajor;            //系統補丁包的主版本 
WORD wServicePackMinor;            //系統補丁包的次版本 
WORD wSuiteMask;                      //標識系統上的程序組 
BYTE wProductType;                    //標識系統類型 
BYTE wReserved;                         //保留,未使用 
} OSVERSIONINFO; 

知道了OSVERSIONINFO結構體在非托管代碼中的定義之后, 現在我們就需要在托管代碼中定義一個等價的結構，并且要保證兩個結構體在內存中的布局相同。托管代碼中的結構體定義如下：

// 因為Win32 GetVersionEx函數參數lpVersionInformation是一個指向 OSVERSIONINFO的數據結構 
// 所以托管代碼中定義個結構體，把結構體對象作為非托管函數參數 
        [StructLayout(LayoutKind.Sequential,CharSet=CharSet.Unicode)]  
publicstruct OSVersionInfo  
        {  
public UInt32 OSVersionInfoSize; // 結構的大小，在調用方法前要初始化該字段 
public UInt32 MajorVersion; // 系統主版本號 
public UInt32 MinorVersion; // 系統此版本號 
public UInt32 BuildNumber;  // 系統構建號 
public UInt32 PlatformId;  // 系統支持的平臺 
// 此屬性用于表示將其封送成內聯數組 
            [MarshalAs(UnmanagedType.ByValTStr,SizeConst=128)]  
publicstring CSDVersion; // 系統補丁包的名稱 
public UInt16 ServicePackMajor; // 系統補丁包的主版本 
public UInt16 ServicePackMinor;  // 系統補丁包的次版本 
public UInt16 SuiteMask;   //標識系統上的程序組 
public Byte ProductType;    //標識系統類型 
public Byte Reserved;  //保留,未使用 
        } 

從上面的定義可以看出, 托管代碼中定義的結構體有以下三個方面與非托管代碼中的結構體是相同的:

• 字段聲明的順序

• 字段的類型

• 字段在內存中的大小

并且在上面結構體的定義中,我們使用到了 StructLayout 屬性，該屬性屬于System.Runtime.InteropServices命名空間(所以在使用平臺調用技術必須添加這個額外的命名空間)。這個類的作用就是允許開發人員顯式指定結構體或類中數據字段的內存布局,為了保證結構體中的數據字段在內存中的順序與定義時一致,所以指定為 LayoutKind.Sequential（該枚舉也是默認值)。 下面就具體看看在托管代碼中調用的代碼：

using System;  
using System.ComponentModel;  
using System.Runtime.InteropServices;  
namespace 封送結構體的處理  
{  
class Program  
    {  
// 對GetVersionEx進行托管定義 
// 為了傳遞指向結構體的指針并將初始化的信息傳遞給非托管代碼，需要用ref關鍵字修飾參數        // 這里不能使用out關鍵字，如果使用了out關鍵字，CLR就不會對參數進行初始化操作，這樣就會導致調用失敗        [DllImport("Kernel32",CharSet=CharSet.Unicode,EntryPoint="GetVersionEx")] 
privatestaticextern Boolean GetVersionEx_Struct(ref  OSVersionInfo osVersionInfo);  
// 因為Win32 GetVersionEx函數參數lpVersionInformation是一個指向 OSVERSIONINFO的數據結構 
// 所以托管代碼中定義個結構體，把結構體對象作為非托管函數參數 
        [StructLayout(LayoutKind.Sequential,CharSet=CharSet.Unicode)]  
publicstruct OSVersionInfo  
        {  
public UInt32 OSVersionInfoSize; // 結構的大小，在調用方法前要初始化該字段 
public UInt32 MajorVersion; // 系統主版本號 
public UInt32 MinorVersion; // 系統此版本號 
public UInt32 BuildNumber;  // 系統構建號 
public UInt32 PlatformId;  // 系統支持的平臺 
// 此屬性用于表示將其封送成內聯數組 
            [MarshalAs(UnmanagedType.ByValTStr,SizeConst=128)]  
publicstring CSDVersion; // 系統補丁包的名稱 
public UInt16 ServicePackMajor; // 系統補丁包的主版本 
public UInt16 ServicePackMinor;  // 系統補丁包的次版本 
public UInt16 SuiteMask;   //標識系統上的程序組 
public Byte ProductType;    //標識系統類型 
public Byte Reserved;  //保留,未使用 
        }  
// 獲得操作系統信息 
privatestaticstring GetOSVersion()  
        {  
// 定義一個字符串存儲版本信息 
string versionName = string.Empty;  
// 初始化一個結構體對象 
            OSVersionInfo osVersionInformation = new OSVersionInfo();  
// 調用GetVersionEx 方法前，必須用SizeOf方法設置結構體中OSVersionInfoSize 成員 
            osVersionInformation.OSVersionInfoSize = (UInt32)Marshal.SizeOf(typeof(OSVersionInfo));  
// 調用Win32函數 
            Boolean result = GetVersionEx_Struct(ref osVersionInformation);  
if (!result)  
            {  
// 如果調用失敗，獲得最后的錯誤碼 
int errorcode = Marshal.GetLastWin32Error();  
                Win32Exception win32Exc = new Win32Exception(errorcode);  
                Console.WriteLine("調用失敗的錯誤信息為： " + win32Exc.Message);  
// 調用失敗時返回為空字符串 
returnstring.Empty;  
            }  
else
            {  
                Console.WriteLine("調用成功");  
switch (osVersionInformation.MajorVersion)  
                {  
// 這里僅僅討論 主版本號為6的情況，其他情況是一樣討論的 
case 6:  
switch (osVersionInformation.MinorVersion)  
                        {  
case 0:  
if (osVersionInformation.ProductType == (Byte)0)  
                                {  
                                    versionName = " Microsoft Windows Vista";  
                                }  
else
                                {  
                                    versionName = "Microsoft Windows Server 2008"; // 服務器版本 
                                }  
break;  
case 1:  
if (osVersionInformation.ProductType == (Byte)0)  
                                {  
                                    versionName = " Microsoft Windows 7";  
                                }  
else
                                {  
                                    versionName = "Microsoft Windows Server 2008 R2";  
                                }  
break;  
case 2:  
                                versionName = "Microsoft Windows 8";  
break;  
                        }  
break;  
default:  
                        versionName = "未知的操作系統";  
break;  
                }  
return versionName;  
            }  
        }  
staticvoid Main(string[] args)  
        {  
string OS=GetOSVersion();  
            Console.WriteLine("當前電腦安裝的操作系統為：{0}", OS);  
            Console.Read();  
        }  
    }  
} 

運行結果為:

附上微軟操作系統名和版本號的對應關系,大家可以參考下面的表對上面代碼進行其他的討論:

五、封送類的處理

下面直接通過GetVersionEx函數進行封送類的處理的例子，具體代碼如下：

using System;  
using System.ComponentModel;  
using System.Runtime.InteropServices;  
namespace 封送類的處理  
{  
class Program  
    {  
// 對GetVersionEx進行托管定義 
// 由于類的定義中CSDVersion為String類型，String是非直接復制到本機結構類型， 
// 所以封送拆送器需要進行復制操作。 
// 為了是非托管代碼能夠獲得在托管代碼中對象設置的初始值(指的是OSVersionInfoSize字段，調用函數前首先初始化該值), 
// 所以必須加上[In]屬性；函數返回時，為了將結果復制到托管對象中，必須同時加上 [Out]屬性 
// 這里不能是用ref關鍵字，因為 OsVersionInfo是類類型，本來就是引用類型，如果加ref 關鍵字就是傳入的為指針的指針了，這樣就會導致調用失敗        [DllImport("Kernel32", CharSet = CharSet.Unicode, EntryPoint = "GetVersionEx")] 
privatestaticextern Boolean GetVersionEx_Struct([In, Out]  OSVersionInfo osVersionInfo);  
// 獲得操作系統信息 
privatestaticstring GetOSVersion()  
        {  
// 定義一個字符串存儲操作系統信息 
string versionName = string.Empty;  
// 初始化一個類對象 
            OSVersionInfo osVersionInformation = new OSVersionInfo();  
// 調用Win32函數 
            Boolean result = GetVersionEx_Struct(osVersionInformation);  
if (!result)  
            {  
// 如果調用失敗，獲得最后的錯誤碼 
int errorcode = Marshal.GetLastWin32Error();  
                Win32Exception win32Exc = new Win32Exception(errorcode);  
                Console.WriteLine("調用失敗的錯誤信息為： " + win32Exc.Message);  
// 調用失敗時返回為空字符串 
returnstring.Empty;  
            }  
else
            {  
                Console.WriteLine("調用成功");  
switch (osVersionInformation.MajorVersion)  
                {  
// 這里僅僅討論 主版本號為6的情況，其他情況是一樣討論的 
case 6:  
switch (osVersionInformation.MinorVersion)  
                        {  
case 0:  
if (osVersionInformation.ProductType == (Byte)0)  
                                {  
                                    versionName = " Microsoft Windows Vista";  
                                }  
else
                                {  
                                    versionName = "Microsoft Windows Server 2008"; // 服務器版本 
                                }  
break;  
case 1:  
if (osVersionInformation.ProductType == (Byte)0)  
                                {  
                                    versionName = " Microsoft Windows 7";  
                                }  
else
                                {  
                                    versionName = "Microsoft Windows Server 2008 R2";  
                                }  
break;  
case 2:  
                                versionName = "Microsoft Windows 8";  
break;  
                        }  
break;  
default:  
                        versionName = "未知的操作系統";  
break;  
                }  
return versionName;  
            }  
        }  
staticvoid Main(string[] args)  
        {  
string OS = GetOSVersion();  
            Console.WriteLine("當前電腦安裝的操作系統為：{0}", OS);  
            Console.Read();  
        }  
    }  
    [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]  
publicclass OSVersionInfo  
    {  
public UInt32 OSVersionInfoSize = (UInt32)Marshal.SizeOf(typeof(OSVersionInfo));  
public UInt32 MajorVersion = 0;  
public UInt32 MinorVersion = 0;  
public UInt32 BuildNumber = 0;  
public UInt32 PlatformId = 0;  
// 此屬性用于表示將其封送成內聯數組 
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]  
publicstring CSDVersion = null;  
public UInt16 ServicePackMajor = 0;  
public UInt16 ServicePackMinor = 0;  
public UInt16 SuiteMask = 0;  
public Byte ProductType = 0;  
public Byte Reserved;  
    }  
} 

運行結果還是和上面使用結構體定義的一樣,還是附上下圖吧:

六、小結

本專題主要介紹了幾種類型的數據封送處理, 對于封送處理的一句話概括就是——保證托管代碼中定義的數據在內存中的布局與非托管代碼中的內存布局相同，專題中也列出了一些簡單類型在非托管代碼和托管代碼中定義的對應關系，對于一些沒有列出來的指針類型或回調函數等可以使用萬能的IntPtr類型在托管代碼中定義.然而本專題只是對數據封送做一個入門的介紹, 要真真掌握數據封送處理還要考慮很多其他的因素,這個就需要大家在平時工作中積累的。