在C#中使用C++编写的类

Posted 2020-08-07 strangeman

 现在在Windows下的应用程序开发，VS.Net占据了绝大多数的份额。因此很多以前搞VC++开发的人都转向用更强大的VS.Net。在这种情况下，有很多开发人员就面临了如何在C#中使用C++开发好的类的问题。下面就用一个完整的实例来详细说明怎样用托管C++封装一个C++类以提供给C#使用。
    比如，现在有一个工程名为NativeCppDll的由C++编写的DLL，里面输出了一个CPerson类。下面是具体的代码：

// NativeCppDll.h
#pragma once
#ifndef LX_DLL_CLASS_EXPORTS
    #define LX_DLL_CLASS __declspec(dllexport)
#else
    #define LX_DLL_CLASS __declspec(dllimport)
#endif
class LX_DLL_CLASS CPerson
{
public:
    CPerson();
    CPerson(const wchar_t *pName, const wchar_t cSex, int iAge);
    void SetName(const wchar_t *pName);
    wchar_t * GetName();
    void SetSex(const wchar_t cSex);
    wchar_t GetSex();
    void SetAge(int iAge);
    int GetAge();
    wchar_t * GetLastError();
private:
    wchar_t m_szName[128];
    wchar_t m_cSex;
    int m_iAge;
    wchar_t m_szLastError[128];
    void ShowError();
};
// NativeCppDll.cpp
#include "stdafx.h"
#include "NativeCppDll.h"
#include <iostream>
#include <tchar.h>
using namespace std;
CPerson::CPerson()
{
    wcscpy_s(m_szName, _T("No Name"));
    m_cSex = ‘N‘;
    m_iAge = 0;
    wcscpy_s(m_szLastError, _T("No Error"));
}
CPerson::CPerson(const wchar_t *pName, const wchar_t cSex, int iAge)
{
    wcscpy_s(m_szLastError, _T("No Error"));
    SetName(pName);
    SetSex(cSex);
    SetAge(iAge);
}
void CPerson::SetName(const wchar_t *pName)
{
    if ((pName == NULL) || (wcslen(pName) == 0) || (wcslen(pName) > 127))
    {
        wcscpy_s(m_szName, _T("No Name"));
        wcscpy_s(m_szLastError, _T("The length of the input name is out of range."));
        ShowError();
        return;
    }
    wcscpy_s(m_szName, pName);
}
wchar_t * CPerson::GetName()
{
    return m_szName;
}
void CPerson::SetSex(const wchar_t cSex)
{
    if ((cSex != ‘F‘) && (cSex != ‘M‘) && (cSex != ‘m‘) && (cSex != ‘f‘))
    {
        m_cSex = ‘N‘;
        wcscpy_s(m_szLastError, _T("The input sex is out of [F/M]."));
        ShowError();
        
        return;
    }
    m_cSex = cSex;
}
wchar_t CPerson::GetSex()
{
    return m_cSex;
}
void CPerson::SetAge(int iAge)
{
    if ((iAge < 0) || (iAge > 150))
    {
        m_iAge = 0;
        wcscpy_s(m_szLastError, _T("The input age is out of range."));
        ShowError();
        return;
    }
    m_iAge = iAge;
}
int CPerson::GetAge()
{
    return m_iAge;
}
wchar_t * CPerson::GetLastError()
{
    return m_szLastError;
}
void CPerson::ShowError()
{
    cerr << m_szLastError << endl;
}
    这是一个很典型的由C++开发的DLL，输出一个完整的C++类。如果现在要求开发一个C#工程，需要用到这个DLL中输出的C++类CPerson，该怎么办呢？针对这个例子来说，类CPerson非常小，可以用C#重新写一个跟这个C++类一样的类。可是，如果需要的C++类很大，或者很多的时候，重写工程将非常庞大。而且这样没有对现有的代码进行重用，浪费了现有资源，开发起来费时费力。
    当然，还是有方法解决这个问题的。那就是用托管C++将C++类给封装一下，然后再提供给C#来使用。下面就用代码来详细说明怎样用托管C++来封装上面的那个C++类。
    首先，要创建一个托管C++的DLL工程ManageCppDll，然后在里面添加下面的代码：   

// ManageCppDll.h
#pragma once
#define LX_DLL_CLASS_EXPORTS
#include "../NativeCppDll/NativeCppDll.h"
using namespace System;
namespace ManageCppDll 
{
    public ref class Person
    {
    // 包装所有类CPerson的公有成员函数
    public:
        Person();
        Person(String ^ strName, Char cSex, int iAge);
        ~Person();
        property String ^ Name
        {
            void set(String ^ strName);
            String ^ get();
        }
        property Char Sex
        {
            void set(Char cSex);
            Char get();
        }
        property int Age
        {
            void set(int iAge);
            int get();
        }
        String ^ GetLastError();
    private:
        // 类CPerson的指针，用来调用类CPerson的成员函数
        CPerson *m_pImp;
    };
};
    从这个头文件就能看出来，这是对C++类CPerson的包装。类Person的所有公有成员函数都跟C++类CPerson一样，只不过成员函数的参数和返回值就改成了托管C++的类型，这也是让类Person能在C#中使用的首要条件。当然只需要对公有成员函数进行封装，对于保护成员函数和私有成员函数则不必做任何封装。
    类Person仅有一个私有的成员变量：一个类CPerson的指针。而类Person的所有成员函数的实现都是靠这个CPerson指针来调用类CPerson的相应成员函数来实现。
    下面是具体的实现代码：

// ManageCppDll.cpp
#include "stdafx.h"
#include "ManageCppDll.h"
#include <vcclr.h>
namespace ManageCppDll 
{
    // 在构造函数中创建类CPerson的对象并在析构函数中将该对象销毁
    // 所有的成员函数实现都是通过指针m_pImp调用类CPerson的相应成员函数实现
    Person::Person()
    {
        m_pImp = new CPerson();
    }
    Person::Person(String ^ strName, Char cSex, int iAge)
    {
        // 将string转换成C++能识别的指针
        pin_ptr<const wchar_t> wcName = PtrToStringChars(strName);
        m_pImp = new CPerson(wcName, cSex, iAge);
    }
    Person::~Person()
    {
        // 在析构函数中删除CPerson对象
        delete m_pImp;
    }
    void Person::Name::set(String ^ strName)
    {
        pin_ptr<const wchar_t> wcName = PtrToStringChars(strName);
        m_pImp->SetName(wcName);
    }
    String ^ Person::Name::get()
    {
        return gcnew String(m_pImp->GetName());
    }
    void Person::Sex::set(Char cSex)
    {
        m_pImp->SetSex(cSex);
    }
    Char Person::Sex::get()
    {
        return m_pImp->GetSex();
    }
    void Person::Age::set(int iAge)
    {
        m_pImp->SetAge(iAge);
    }
    int  Person::Age::get()
    {
        return m_pImp->GetAge();
    }
    String ^ Person::GetLastError()
    {
        return gcnew String(m_pImp->GetLastError());
    }
};
    如果要在C#中使用类Person，首先要添加对ManageCppDll.dll的引用，然后就可以像用普通的C#类一样的使用类Person了。比如下面这样的代码：

using ManageCppDll;
Person person = new Person();
person.Name = "StarLee";
person.Sex = ‘M‘;
person.Age = 28;
    熟悉设计模式的看了上面的代码肯定会发现,这样的设计跟BRIDGE模式如出一辙。其实，上面的方法也算是一种BRIDGE模式，由托管C++充当了C#中使用用C++开发的类的桥梁。另外，这种形式也可以理解为ADAPTER模式，托管C++类Person就是C++类CPerson的一个适配器。通过这个桥梁，可以很容易的重用以前用C++开发的类，让这些C++类继续在C#中发挥它们的效用，让开发变得事半功倍。