在C++中使用C#編寫的類

     在那篇《在C#中使用C++編寫的類》中我介紹了如何在C#中使用C++編寫的類。可是由於C#在使用者介面設計、資料庫儲存和XML檔案讀取等方面的優勢，有時候也會出現要在C++中使用C#編寫的類的情況。下面就用一個完整的執行個體來說明怎樣在C++中使用C#編寫的類。
    比如說，現在有一個用C#編寫的DLL工程CsharpDll裡面有一個Person類：

1. // Person.cs
3. using System;
5. namespace CsharpDll
6. {
7.     public class Person
8.     {
9.         public Person()
10.         {
11.             Name = "No Name";
12.             Sex = 'N';
13.             Age = 0;
15.             m_strLastError = "No Error";
16.         }
18.         public Person(string strName, char cSex, int iAge)
19.         {
20.             m_strLastError = "No Error";
22.             Name = strName;
23.             Sex = cSex;
24.             Age = iAge;
25.         }
27.         public string Name
28.         {
29.             get
30.             {
31.                 return m_strName;
32.             }
34.             set
35.             {
36.                 if ((String.IsNullOrEmpty(value)) || (value.Length > 127))
37.                 {
38.                     m_strName = "No Name";
40.                     m_strLastError = "The length of the input name is out of range.";
42.                     return;
43.                 }
45.                 m_strName = value;
46.             }
47.         }
49.         public char Sex
50.         {
51.             get
52.             {
53.                 return m_cSex;
54.             }
56.             set
57.             {
58.                 if ((value != 'F') && (value != 'M') && (value != 'm') && (value != 'f'))
59.                 {
60.                     m_cSex = 'N';
62.                     m_strLastError = "The input sex is out of [F/M].";
64.                     return;
65.                 }
67.                 m_cSex = value;
68.             }
69.         }
71.         public int Age
72.         {
73.             get
74.             {
75.                 return m_iAge;
76.             }
78.             set
79.             {
80.                 if ((value < 0) || (value > 150))
81.                 {
82.                     m_iAge = 0;
84.                     m_strLastError = "The input age is out of range.";
86.                     return;
87.                 }
89.                 m_iAge = value;
90.             }
91.         }
93.         public string LastError
94.         {
95.             get
96.             {
97.                 return m_strLastError;
98.             }
99.         }
101.         private string m_strName;
102.         private char m_cSex;
103.         private int m_iAge;
104.         private string m_strLastError;
105.     }
106. }

    如果需要在C++中使用這個C#編寫的Person類，就需要用託管C++來對這個C#進行封裝，將它封裝成一個C++能用的類。
    首先，要建立一個託管C++的DLL工程ManageCppDll。並且，要添加對CsharpDll.dll的引用。然後對C#類所有的公有屬性和方法進行封裝。下面是具體的代碼：

1. // ManageCppDll.h
3. #pragma once
5. #ifndef LX_DLL_CLASS_EXPORTS
6.     #define LX_DLL_CLASS __declspec(dllexport)
7. #else
8.     #define LX_DLL_CLASS __declspec(dllimport)
9. #endif
11. class LX_DLL_CLASS CPerson
12. {
13. public:
14.     CPerson();
15.     CPerson(const wchar_t *pName, const wchar_t cSex, int iAge);
17.     ~CPerson();
19.     void SetName(const wchar_t *pName);
20.     wchar_t * GetName();
22.     void SetSex(const wchar_t cSex);
23.     wchar_t GetSex();
25.     void SetAge(int iAge);
26.     int GetAge();
28.     wchar_t * GetLastError();
30. private:
31.     // 用一個void指標指向Person的對象
32.     // 所有公有成員函數的實現都是通過這個對象來實現
33.     void *m_pImp;
35.     wchar_t m_szName[128];
36.     wchar_t m_szLastError[128];
37. };
39. // ManageCppDll.cpp
41. #include "stdafx.h"
43. #include "ManageCppDll.h"
45. #include <vcclr.h>
46. #include <string.h>
47. #include <stdlib.h>
49. using namespace System;
50. using namespace System::Runtime::InteropServices;
52. using namespace CsharpDll;
54. // 將GCHandle轉換成為void指標
55. #define __GCHANDLE_TO_VOIDPTR(x) ((GCHandle::operator System::IntPtr(x)).ToPointer())
56. // 將void指標轉換為GCHandle
57. #define __VOIDPTR_TO_GCHANDLE(x) (GCHandle::operator GCHandle(System::IntPtr(x)))
59. // 輔助函數
60. // 將void指標指向的對象轉換成為Person對象
61. inline Person ^ GetImpObj(void *pHandle)
62. {
63.     Person ^ person = nullptr;
65.     if (pHandle != NULL)
66.     {
67.         person = static_cast<Person^>(__VOIDPTR_TO_GCHANDLE(pHandle).Target);
68.     }
70.     return person;
71. }
73. CPerson::CPerson()
74. {
75.     m_pImp = NULL;
77.     Person ^ person = gcnew Person();
79.     // 建立GCHandle並將它轉換成void指標儲存到成員變數中
80.     GCHandle handle = GCHandle::Alloc(person);
81.     m_pImp = __GCHANDLE_TO_VOIDPTR(handle); 
82. }
84. CPerson::CPerson(const wchar_t *pName, const wchar_t cSex, int iAge)
85. {
86.     m_pImp = NULL;
88.     Person ^ person = gcnew Person();
89.     person->Name = gcnew String(pName);
90.     person->Sex = cSex;
91.     person->Age = iAge;
93.     GCHandle handle = GCHandle::Alloc(person);
94.     m_pImp = __GCHANDLE_TO_VOIDPTR(handle);
95. }
97. CPerson::~CPerson()
98. {
99.     if (m_pImp == NULL)
100.         return;
102.     // 釋放GCHandle
103.     GCHandle handle = __VOIDPTR_TO_GCHANDLE(m_pImp);
104.     handle.Free();
106.     m_pImp = NULL;
107. }
109. void CPerson::SetName(const wchar_t *pName)
110. {
111.     // 將void指標轉換成Person指標
112.     // 並用該指標調用相應的公有屬性或方法
113.     Person ^ person = GetImpObj(m_pImp);
114.     person->Name = gcnew String(pName);
115. }
117. wchar_t * CPerson::GetName()
118. {
119.     Person ^ person = GetImpObj(m_pImp);
121.     // 將C#返回的字串轉換為wchat_t*指標能指向的地址
122.     wchar_t * pName = static_cast<wchar_t*>(Marshal::StringToHGlobalUni(person->Name).ToPointer());
123.     wcscpy_s(m_szName, pName);
124.     Marshal::FreeHGlobal(System::IntPtr(pName)); // 釋放記憶體
126.     return m_szName;
127. }
129. void CPerson::SetSex(const wchar_t cSex)
130. {
131.     Person ^ person = GetImpObj(m_pImp);
132.     person->Sex = cSex;
133. }
135. wchar_t CPerson::GetSex()
136. {
137.     Person ^ person = GetImpObj(m_pImp);
139.     return person->Sex;
140. }
142. void CPerson::SetAge(int iAge)
143. {
144.     Person ^ person = GetImpObj(m_pImp);
145.     person->Age = iAge;
146. }
148. int CPerson::GetAge()
149. {
150.     Person ^ person = GetImpObj(m_pImp);
152.     return person->Age;
153. }
155. wchar_t * CPerson::GetLastError()
156. {
157.     Person ^ person = GetImpObj(m_pImp);
159.     wchar_t * pLastError = static_cast<wchar_t*>(Marshal::StringToHGlobalUni(person->LastError).ToPointer());
160.     wcscpy_s(m_szLastError, pLastError);
161.     Marshal::FreeHGlobal(System::IntPtr(pLastError));
163.     return m_szLastError;
164. }

    現在對上面代碼中所用到的一些相關背景知識進行一下介紹。
    GCHandle結構提供從非託管記憶體訪問託管對象的方法。
    GCHandle.Alloc方法(Object)為指定的對象分配Normal控制代碼。它保護對象不被記憶體回收。當不再需要GCHandle時，必須通過Free將其釋放。Normal控制代碼類型表示不透明控制代碼，這意味著無法通過此控制代碼解析固定對象的地址。可以使用此類型跟蹤對象，並防止它被記憶體回收行程回收。當非託管用戶端持有對託管對象的唯一引用（從記憶體回收行程檢測不到該引用）時，此枚舉成員很有用。
    上面的代碼中，在類CPerson的建構函式中用GCHandle為C#類Person的對象分配一個控制代碼，並將該控制代碼轉換為void指標存放在成員變數中，以保證這個對象不會被記憶體回收行程回收。然後在類CPerson的解構函式中釋放這個控制代碼，將C#類Person的對象的回收權交給系統。
    Marshal類提供了一個方法集，這些方法用於分配非託管記憶體、複製非託管記憶體塊、將託管類型轉換為非託管類型，此外還提供了在與Unmanaged 程式碼互動時使用的其他雜項方法。
    Marshal..::.StringToHGlobalUni方法向非託管記憶體複製託管String的內容。StringToHGlobalUni對於自訂封送處理或者在混合託管和Unmanaged 程式碼時很有用。由於該方法分配字串所需的非託管記憶體，因此應始終通過調用FreeHGlobal釋放記憶體。
    （更多關於上面介紹的背景知識可以搜尋MSDN。說實在的MSDN真是一個寶庫！VS能在Windows平台開發中取得絕大多數的份額，除了因為它和Windows都是微軟開發的之外，MSDN的完備性功不可沒！）
    通過上面的方法，就把一個C#編寫的類Person用託管C++給封裝成了一個C++可以使用的CPerson類。我們可以在C++的工程中像使用一般的C++類一樣使用類CPerson。比如下面的代碼。

1. CPerson person(_T("StarLee"), 'M', 28);
3. person.SetName(_T("StarLee"));
4. person.SetSex('M');
5. person.SetAge(28);
7. wcout << "Name: " << person.GetName() << " Sex: " << person.GetSex() << " Age: " << person.GetAge() << endl;
8. wcout << "Error: " << person.GetLastError() << endl;

    這裡的方法跟《在C#中使用C++編寫的類》一樣，都是借用託管C++這個橋樑來溝通C++編寫的類和C#編寫的類，使在C++中使用C#編寫的類和在C#中使用C++編寫的類成為現實。