C#互操作性入門系列(三)：平臺(tái)調(diào)用中的數(shù)據(jù)封送處理

C#互操作系列文章：

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

2. C#互操作性入門系列(二)：使用平臺(tái)調(diào)用調(diào)用Win32 函數(shù)

3. C#互操作性入門系列(三)：平臺(tái)調(diào)用中的數(shù)據(jù)封送處理

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

本專題概要

• 數(shù)據(jù)封送介紹

• 封送Win32數(shù)據(jù)類型

• 封送字符串的處理

• 封送結(jié)構(gòu)體的處理

• 封送類的處理

• 小結(jié)

一、數(shù)據(jù)封送介紹

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

封送拆送器主要進(jìn)行3項(xiàng)任務(wù)：

1. 將數(shù)據(jù)從托管類型轉(zhuǎn)換為非托管類型，或從非托管類型轉(zhuǎn)換為托管類型

2. 將經(jīng)過類型轉(zhuǎn)換的數(shù)據(jù)從托管代碼內(nèi)存復(fù)制到非托管內(nèi)存，或從非托管內(nèi)存復(fù)制到托管內(nèi)存

3. 調(diào)用完成后，釋放封送處理過程中分配的內(nèi)存

二、封送Win32數(shù)據(jù)類型

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

2.1 可直接復(fù)制到本機(jī)結(jié)構(gòu)中的類型

由于在托管代碼和非托管代碼中，數(shù)據(jù)類型在托管內(nèi)存和非托管內(nèi)存的表示形式不一樣，因?yàn)檫@樣的原因，所以我們需要對數(shù)據(jù)進(jìn)行封送處理，以至于在托管代碼中調(diào)用非托管函數(shù)時(shí)，把正確的傳入?yún)?shù)傳遞給非托管函數(shù)和把正確的返回值返回給托管代碼中。然而，并不是所有數(shù)據(jù)類型在兩者內(nèi)存的表現(xiàn)形式不一樣的，這時(shí)候我們把在托管內(nèi)存和非托管內(nèi)存中有相同表現(xiàn)形式的數(shù)據(jù)類型稱為——可直接復(fù)制到本機(jī)結(jié)構(gòu)中的類型，這些數(shù)據(jù)類型不需要封送拆送器進(jìn)行任何特殊的處理就可以在托管和非托管代碼之間傳遞, 下面列出一些課直接復(fù)制到本機(jī)結(jié)構(gòu)中的簡單數(shù)據(jù)類型：

除了上表列出來的簡單類型之外，還有一些復(fù)制類型也屬于可直接復(fù)制到本機(jī)結(jié)構(gòu)中的數(shù)據(jù)類型：

（1） 數(shù)據(jù)元素都是可直接復(fù)制到本機(jī)結(jié)構(gòu)中的一元數(shù)組，如整數(shù)數(shù)組，浮點(diǎn)數(shù)組等

（2）只包含可直接復(fù)制到本機(jī)結(jié)構(gòu)中的格式化值類型

（3）成員變量全部都是可復(fù)制到本機(jī)結(jié)構(gòu)中的類型且作為格式化類型封送的類

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

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

.2 非直接復(fù)制到本機(jī)結(jié)構(gòu)中的類型

如果一個(gè)類型不是可直接復(fù)制到本機(jī)結(jié)構(gòu)中的類型，那么它就是非直接復(fù)制到本機(jī)結(jié)構(gòu)中的類型。由于一些類型在托管內(nèi)存和非托管內(nèi)存的表現(xiàn)形式不一樣，所以對于這種類型，封送器需要對它們進(jìn)行相應(yīng)的類型轉(zhuǎn)換之后再復(fù)制到被調(diào)用的函數(shù)中，下面列出一些非直接復(fù)制到本機(jī)結(jié)構(gòu)中的數(shù)據(jù)類型：

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

三、封送字符串的處理

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

// 托管函數(shù)中的返回值封送回托管函數(shù)的例子 
class Program  
    {  
// Win32 GetTempPath函數(shù)的定義如下：    
//DWORD WINAPI GetTempPath( 
//  _In_   DWORD nBufferLength, 
//  _Out_  LPTSTR lpBuffer 
//);    // 主要是注意如何在托管代碼中定義該函數(shù)原型               [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("調(diào)用非托管函數(shù)發(fā)生異常，異常信息為：" +win32expection.Message);  
            }  
            Console.WriteLine("調(diào)用非托管函數(shù)成功。");  
            Console.WriteLine("Temp 路徑為：" + buffer);   
            Console.Read();  
        }  
    } 

運(yùn)行結(jié)果為:

四、封送結(jié)構(gòu)體的處理

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

BOOL GetVersionEx(   
  LPOSVERSIONINFO lpVersionInformation  
);  

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

typedefstruct  _OSVERSIONINFO{  
DWORD dwOSVersionInfoSize;       //在使用GetVersionEx之前要將此初始化為結(jié)構(gòu)的大小 
DWORD dwMajorVersion;               //系統(tǒng)主版本號(hào) 
DWORD dwMinorVersion;               //系統(tǒng)次版本號(hào) 
DWORD dwBuildNumber;               //系統(tǒng)構(gòu)建號(hào) 
DWORD dwPlatformId;                  //系統(tǒng)支持的平臺(tái) 
TCHAR szCSDVersion[128];          //系統(tǒng)補(bǔ)丁包的名稱 
WORD wServicePackMajor;            //系統(tǒng)補(bǔ)丁包的主版本 
WORD wServicePackMinor;            //系統(tǒng)補(bǔ)丁包的次版本 
WORD wSuiteMask;                      //標(biāo)識(shí)系統(tǒng)上的程序組 
BYTE wProductType;                    //標(biāo)識(shí)系統(tǒng)類型 
BYTE wReserved;                         //保留,未使用 
} OSVERSIONINFO; 

知道了OSVERSIONINFO結(jié)構(gòu)體在非托管代碼中的定義之后, 現(xiàn)在我們就需要在托管代碼中定義一個(gè)等價(jià)的結(jié)構(gòu)，并且要保證兩個(gè)結(jié)構(gòu)體在內(nèi)存中的布局相同。托管代碼中的結(jié)構(gòu)體定義如下：

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

從上面的定義可以看出, 托管代碼中定義的結(jié)構(gòu)體有以下三個(gè)方面與非托管代碼中的結(jié)構(gòu)體是相同的:

• 字段聲明的順序

• 字段的類型

• 字段在內(nèi)存中的大小

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

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

運(yùn)行結(jié)果為:

附上微軟操作系統(tǒng)名和版本號(hào)的對應(yīng)關(guān)系,大家可以參考下面的表對上面代碼進(jìn)行其他的討論:

五、封送類的處理

下面直接通過GetVersionEx函數(shù)進(jìn)行封送類的處理的例子，具體代碼如下：

using System;  
using System.ComponentModel;  
using System.Runtime.InteropServices;  
namespace 封送類的處理  
{  
class Program  
    {  
// 對GetVersionEx進(jìn)行托管定義 
// 由于類的定義中CSDVersion為String類型，String是非直接復(fù)制到本機(jī)結(jié)構(gòu)類型， 
// 所以封送拆送器需要進(jìn)行復(fù)制操作。 
// 為了是非托管代碼能夠獲得在托管代碼中對象設(shè)置的初始值(指的是OSVersionInfoSize字段，調(diào)用函數(shù)前首先初始化該值), 
// 所以必須加上[In]屬性；函數(shù)返回時(shí)，為了將結(jié)果復(fù)制到托管對象中，必須同時(shí)加上 [Out]屬性 
// 這里不能是用ref關(guān)鍵字，因?yàn)?OsVersionInfo是類類型，本來就是引用類型，如果加ref 關(guān)鍵字就是傳入的為指針的指針了，這樣就會(huì)導(dǎo)致調(diào)用失敗        [DllImport("Kernel32", CharSet = CharSet.Unicode, EntryPoint = "GetVersionEx")] 
privatestaticextern Boolean GetVersionEx_Struct([In, Out]  OSVersionInfo osVersionInfo);  
// 獲得操作系統(tǒng)信息 
privatestaticstring GetOSVersion()  
        {  
// 定義一個(gè)字符串存儲(chǔ)操作系統(tǒng)信息 
string versionName = string.Empty;  
// 初始化一個(gè)類對象 
            OSVersionInfo osVersionInformation = new OSVersionInfo();  
// 調(diào)用Win32函數(shù) 
            Boolean result = GetVersionEx_Struct(osVersionInformation);  
if (!result)  
            {  
// 如果調(diào)用失敗，獲得最后的錯(cuò)誤碼 
int errorcode = Marshal.GetLastWin32Error();  
                Win32Exception win32Exc = new Win32Exception(errorcode);  
                Console.WriteLine("調(diào)用失敗的錯(cuò)誤信息為： " + win32Exc.Message);  
// 調(diào)用失敗時(shí)返回為空字符串 
returnstring.Empty;  
            }  
else
            {  
                Console.WriteLine("調(diào)用成功");  
switch (osVersionInformation.MajorVersion)  
                {  
// 這里僅僅討論 主版本號(hào)為6的情況，其他情況是一樣討論的 
case 6:  
switch (osVersionInformation.MinorVersion)  
                        {  
case 0:  
if (osVersionInformation.ProductType == (Byte)0)  
                                {  
                                    versionName = " Microsoft Windows Vista";  
                                }  
else
                                {  
                                    versionName = "Microsoft Windows Server 2008"; // 服務(wù)器版本 
                                }  
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 = "未知的操作系統(tǒng)";  
break;  
                }  
return versionName;  
            }  
        }  
staticvoid Main(string[] args)  
        {  
string OS = GetOSVersion();  
            Console.WriteLine("當(dāng)前電腦安裝的操作系統(tǒng)為：{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;  
// 此屬性用于表示將其封送成內(nèi)聯(lián)數(shù)組 
        [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;  
    }  
} 

運(yùn)行結(jié)果還是和上面使用結(jié)構(gòu)體定義的一樣,還是附上下圖吧:

六、小結(jié)

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