Microsoft MVP성태의 닷넷 이야기
글쓴 사람
홈페이지
첨부 파일

C# 개발자를 위한 C++ COM 객체의 기본 구현 방식 설명

순수 C# 개발자들이라면, 아마도 C++ COM 객체는 잘 이해가 안 되는 개념일 수 있습니다. 물론, C++을 공부해 COM 객체를 이해하면 가장 좋겠지만 녹록지 않은 것도 현실입니다. 그래도 다행히 C#을 이용해서도 어느 정도는 전체적인 개념을 잡는 것이 가능합니다. 왜냐하면, C#으로도 C++의 COM 객체를 구현하는 것과 거의 동일한 절차를 밟을 수 있기 때문입니다.

이미 C# 클래스 자체를 regasm.exe를 이용해 COM 객체로 만드는 방법을 알고 있는 분도 있을 것입니다.

regasm.exe로 어셈블리 등록 시 시스템 변경 사항 (1) - .NET 2.0 + x86/x64/AnyCPU
; https://www.sysnet.pe.kr/2/0/1286

하지만 이 글에서는 위의 방법이 아닌, 말 그대로 C++의 COM 객체 구현과 유사한 방식을 따름으로써 COM의 개요를 이해할 수 있도록 할 예정입니다.

사실, 이 방법들은 다음의 글들을 통해 어느 정도 이미 나와 있기도 합니다. ^^

Implementing COM OutOfProc Servers in C# .NET !!! 
; http://developerexperience.blogspot.kr/2006/04/implementing-com-outofproc-servers-in.html

C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법
; https://www.sysnet.pe.kr/2/0/11052

그래도, step-by-step 식으로 하나씩 설명해 보는 것도 좋을 것 같아 이렇게 글을 쓰게 되었습니다. 자~~~~, 그럼 이제부터 재미 삼아 한번 만들어 볼까요? ^^




우선, 대개의 COM DLL 파일들이 export하고 있는 다음의 4개 함수를 C# DLL에서도 구현해야 합니다.

  • DllCanUnloadNow
  • DllGetClassObject
  • DllRegisterServer
  • DllUnregisterServer

각각의 함수들이 어떤 역할을 하는지 하나씩 살펴볼 텐데요.

이를 위해 가장 먼저 C++ 측에서 COM 객체를 어떻게 생성할 수 있는지를 봐야 합니다. 원칙적으로 C++은 CoGetClassObject Win32 API를 통해,

CoGetClassObject function
; https://msdn.microsoft.com/en-us/library/windows/desktop/ms684007(v=vs.85).aspx

다음과 같이 "원하는 COM 객체를 생성할 줄 아는 Factory 클래스"를 먼저 구해옵니다.

int main()
{
    CoInitialize(nullptr);
    {
        CLSID refclsId = { 0, };

        // {C0000000-71EB-43A6-9BD1-5770A3737617} == 원하는 Factory Class의 식별자
        //                                           개발자가 임의로 지정해서 약속으로 만듦
        CLSIDFromString(L"{C0000000-71EB-43A6-9BD1-5770A3737617}", &refclsId);
        LPVOID ppvFactoryObject = nullptr;

        CoGetClassObject(refclsId, CLSCTX_INPROC_SERVER, nullptr, IID_IClassFactory, &ppvFactoryObject);
    }
    CoUninitialize();
    return 0;
}

CoGetClassObject의 첫 번째 인자로 들어가는 refclsId 인자가 바로 "Factory 클래스"를 식별하는 역할을 합니다. 그리고, 그 Factory 클래스를 구현하고 있는 실행 파일을 찾기 위해 레지스트리를 이용합니다. 즉, 윈도우에서 제공하는 CoGetClassObject는 레지스트리를 검색해 DLL/EXE 실행 파일을 찾고, 그 파일로부터 "Factory 클래스"를 얻어 반환하는 역할을 하는 것입니다. 이때의 레지스트리 경로는 다음과 같습니다.

HKEY_CLASSES_ROOT\CLSID\{C0000000-71EB-43A6-9BD1-5770A3737617}

만약 저 경로가 존재한다면, 그 하위의 InProcServer32 키를 조사하고, 그 키도 있다면 (Default) 값으로 설정된 구현 파일의 경로를 구할 수 있어 결국 해당 바이너리를 메모리에 로드하게 됩니다.

물론, 기본 설치된 윈도우 운영체제에는 {C0000000-71EB-43A6-9BD1-5770A3737617} 키 파일의 경로가 레지스트리에 등록되어 있지 않습니다. 따라서 CoGetClassObject API가 정상적으로 동작하려면 레지스트리에 CLSID 경로가 등록되어야 하는데, 대개의 경우 그 역할을 해당 COM 객체를 구현한 DLL 파일이 담당하게 됩니다. 그리고 바로 그 기능을 구현해야 할 의무가 있는 것이 DllRegisterServer 함수입니다. 이렇게 해서, 우리가 첫 번째로 구현하는 C# COM DLL의 DllRegisterServer 함수는 다음과 같게 됩니다.

using Microsoft.Win32;
using RGiesecke.DllExport;
using System;
using System.Runtime.InteropServices;

namespace MyCOMObj
{
    public class Register
    {
        const string CLSID_KEY = "{C0000000-71EB-43A6-9BD1-5770A3737617}";

        [DllExport("DllRegisterServer", CallingConvention = CallingConvention.StdCall)]
        public static int DllRegisterServer()
        {
            try
            {
                if (IntPtr.Size == 4)
                {
                    RegisterDLL(RegistryView.Registry32);
                }
                else
                {
                    RegisterDLL(RegistryView.Registry64);
                }
            }
            catch (Exception e)
            {
                return Marshal.GetHRForException(e);
            }

            return 0;
        }

        private static void RegisterDLL(RegistryView regView)
        {
            using (RegistryKey clsRoot = RegistryKey.OpenBaseKey(RegistryHive.ClassesRoot, regView))
            {
                using (RegistryKey clsKey = clsRoot.OpenSubKey("CLSID", true))
                using (RegistryKey clsIdKey = clsKey.CreateSubKey(CLSID_KEY))
                {
                    using (RegistryKey inprocKey = clsIdKey.CreateSubKey("InProcServer32"))
                    {
                        inprocKey.SetValue(null, typeof(Register).Assembly.Location);
                        inprocKey.SetValue("ThreadingModel", "Apartment");
                    }
                }
            }
        }
    }
}

위와 같이 구현하고 빌드한 후, 생성된 DLL을 대상으로 regsvr32.exe를 실행시켜 주면,

C:\ClassLibrary1\bin\x86\Debug>regsvr32 MyCOMObj.dll

RegisterDLL 메서드에 지정했던 레지스트리 키들이 만들어진 것을 확인할 수 있습니다.

cs_comobj_1.png

DllRegisterServer를 이렇게 구현했으니, 당연히 그 반대의 역할을 하는 DllUnregisterServer도 구현할 수 있습니다.

[DllExport("DllUnregisterServer", CallingConvention = CallingConvention.StdCall)]
public static int DllUnregisterServer()
{
    try
    {
        if (IntPtr.Size == 4)
        {
            UnregisterDLL(RegistryView.Registry32);
        }
        else
        {
            UnregisterDLL(RegistryView.Registry64);
        }
    }
    catch (Exception e)
    {
        return Marshal.GetHRForException(e);
    }

    return 0;
}

private static void UnregisterDLL(RegistryView regView)
{
    using (RegistryKey clsRoot = RegistryKey.OpenBaseKey(RegistryHive.ClassesRoot, regView))
    {
        using (RegistryKey clsKey = clsRoot.OpenSubKey("CLSID", true))
        {
            clsKey.DeleteSubKeyTree(CLSID_KEY, false);
        }
    }
}

이제는 다음의 명령어로 레지스트리로부터 COM DLL 관련 정보를 제거할 수 있습니다.

C:\ClassLibrary1\bin\x86\Debug>regsvr32 /u MyCOMObj.dll




여기까지 마치고, 다시 C++의 CoGetClassObject API를 호출해도 역시 오류가 발생합니다.

HRESULT hr = CoGetClassObject(refclsId, CLSCTX_INPROC_SERVER, nullptr, IID_IClassFactory, &ppvFactoryObject);
if (hr == S_OK)
{
    // ...[성공]...
}
else
{
    // ...[실패]...
    // 0x800401f9 - Error in the DLL
}

레지스트리를 통해 refclsId에 해당하는 DLL 파일은 찾았지만, 그 DLL을 로딩한 후 DllGetClassObject 함수를 호출해 Factory Class를 가져와야 하는데 그것이 구현되지 않은 상태이기 때문입니다.

이를 해결하기 위해 다음과 같이 구현을 추가해 주면 됩니다.

[DllExport("DllGetClassObject", CallingConvention = CallingConvention.StdCall)]
public static int DllGetClassObject(ref Guid rclsid, ref Guid riid, out IntPtr pUnk)
{
    pUnk = IntPtr.Zero;

    // COM DLL 내에는 여러 개의 Class Factory를 제공할 수 있기 때문에,
    // 그중에서도 (C0000000-71EB-43A6-9BD1-5770A3737617로 약속했던) MyClassFactory를 요구하는지 확인
    if (rclsid.ToString().ToUpper() == "C0000000-71EB-43A6-9BD1-5770A3737617") 
    {
        // MyClassFactory 객체의 IClassFactory 인터페이스를 요구하는 것인지 확인
        if (riid.ToString().ToUpper() == "00000001-0000-0000-C000-000000000046") // IClassFactory
        {
            pUnk = Marshal.GetComInterfaceForObject(new MyClassFactory(), typeof(IClassFactory));
            return 0; // S_OK
        }
    }

    return -1; // S_FALSE
}

이때의 MyClassFactory 클래스는 IClassFactory 인터페이스를 구현하기만 하면 됩니다.

using COM;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading.Tasks;

namespace COM
{
    static class Guids
    {
        public const string IClassFactory = "00000001-0000-0000-C000-000000000046";
        public const string IUnknown = "00000000-0000-0000-C000-000000000046";
    }

    // http://developerexperience.blogspot.kr/2006/04/implementing-com-outofproc-servers-in.html
    /// 
    /// IClassFactory declaration
    /// 
    [ComImport(), InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid(COM.Guids.IClassFactory)]
    public interface IClassFactory
    {
        [PreserveSig]
        int CreateInstance(IntPtr pUnkOuter, ref Guid riid, out IntPtr ppvObject);
        [PreserveSig]
        int LockServer(bool fLock);
    }
}

namespace MyCOMObj
{
    [Guid(MyClassFactory.CLSID)]
    public class MyClassFactory : IClassFactory
    {
        public int CreateInstance(IntPtr pUnkOuter, ref Guid riid, out IntPtr ppvObject)
        {
            ppvObject = IntPtr.Zero;

            return 0; // S_OK;
        }

        public int LockServer(bool fLock)
        {
            return 0; // S_OK
        }
    }
}

일단은, MyClassFactory가 구현한 CreateInstance는 아무것도 생성하지 않습니다. 그렇긴 해도 C++ 측의 CoGetClassObject는 IClassFactory 인터페이스를 구현한 객체까지 구해오는 것이 전부이므로 다음의 코드가 성공하게 됩니다.

int main()
{
    CoInitialize(nullptr);
    {
        CLSID refclsId = { 0, };

        CLSIDFromString(L"{C0000000-71EB-43A6-9BD1-5770A3737617}", &refclsId);
        LPVOID ppvFactoryObject = nullptr;

        HRESULT hr = CoGetClassObject(refclsId, CLSCTX_INPROC_SERVER, nullptr, IID_IClassFactory, &ppvFactoryObject);
        if (hr == S_OK)
        {
            printf("Created\n"); // ppvFactoryObject에는 IClassFactory를 구현한 C# 측의 COM 객체를 받아옴
        }
        else
        {
            printf("Failed\n");
        }
    }
    CoUninitialize();
    return 0;
}




"원하는 COM 객체를 만들 줄 아는 Factory 객체"를 구했으니, 이제 그 Factory를 통해서 "원하는 COM" 객체를 생성할 수 있습니다. C++ 측에서는 다음과 같이 코딩할 수 있습니다.

IClassFactory *pFactory = (IClassFactory *)ppvFactoryObject;

IID iid = { 0, };
IIDFromString(L"{82996B14-75F2-41FC-86A3-14C13DDD7A2C}", &iid);

// Factory 클래스가 만들어야 할 COM 객체를 IID 식별자로 요구
// 82996B14-75F2-41FC-86A3-14C13DDD7A2C 식별자는 개발자가 임의로 정해 약속으로 고정
LPVOID ppvObject = nullptr;
hr = pFactory->CreateInstance(nullptr, iid, &ppvObject);
if (hr == S_OK)
{
    printf("Created\n");
}
else
{
    printf("Failed\n");
}

위의 코드를 실행하면 ppvObject는 nullptr로 반환되지만 호출 자체는 hr == S_OK로 성공하게 됩니다. 왜냐하면, C# 측의 MyClassFactory.CreateInstance 메서드가 return 0으로 성공을 반환했기 때문입니다.

public int CreateInstance(IntPtr pUnkOuter, ref Guid riid, out IntPtr ppvObject)
{
    ppvObject = IntPtr.Zero;

    return 0; // S_OK;
}

자, 그럼 원하는 COM 객체를 반환하도록 구현을 해보겠습니다. 우선 CreateInstance는 다음과 같이 변경할 수 있습니다.

public int CreateInstance(IntPtr pUnkOuter, ref Guid riid, out IntPtr ppvObject)
{
    ppvObject = IntPtr.Zero;

    if (pUnkOuter != IntPtr.Zero)
    {
        return -2147221232; // 2147221232 == 0x80040110 == CLASS_E_NOAGGREGATION;
    }

    string riidText = riid.ToString().ToUpper();

    switch (riidText)
    {
        case "82996B14-75F2-41FC-86A3-14C13DDD7A2C": // 생성해야 할 COM 객체의 식별자 GUID
        case "00020400-0000-0000-C000-000000000046": // IDispatch
        case "00000000-0000-0000-C000-000000000046": // IUnknown
            ppvObject = Marshal.GetComInterfaceForObject(new MySimpleObject(), typeof(IMySimpleObject));
            break;

        default:
            return -2147467262; // -2147467262 == 0x80004002 == E_NOINTERFACE
    }            

    return 0;
}

그리고 MySimpleObject와 IMySimpleObject는 (예를 들어) 이렇게 구현하면 됩니다.

using System.Runtime.InteropServices;
using System.Windows.Forms;

namespace MyCOMObj
{
    [ComVisible(true)]
    [InterfaceType(ComInterfaceType.InterfaceIsDual)]
    public interface IMySimpleObject
    {
        [DispId(1)]
        void ShowWinFormMessage([MarshalAs(UnmanagedType.LPWStr)] string text);
    }

    [ClassInterface(ClassInterfaceType.None)]
    public class MySimpleObject : IMySimpleObject
    {
        public void ShowWinFormMessage(string text)
        {
            MessageBox.Show(text);
        }
    }
}

이제 다시 실행해 보면, C++ 소스 코드 측의 CreateInstance 호출은 정상적으로 ppvObject에 값을 반환받게 됩니다. 그런데, C++ 측에서 ppvObject를 어떻게 사용해야 할까요?

어차피, COM 객체는 vtable을 기반으로 약속된 함수들의 집합이기 때문에 C++ 측에서도 동일한 규칙의 클래스를 명시한 후 형 변환해서 맞춰주면 됩니다.

interface IMySimpleObject : IDispatch
{
public:
    virtual HRESULT __stdcall ShowWinFormMessage(wchar_t *text) = 0;
};

int main()
{
    CoInitialize(nullptr);
    {
        // ...[생략]...

        LPVOID ppvObject = nullptr;
        hr = pFactory->CreateInstance(nullptr, iid, &ppvObject);
        if (hr == S_OK)
        {
            printf("COM: Created\n");

            IMySimpleObject *pSimple = (IMySimpleObject *)ppvObject;
            pSimple->ShowWinFormMessage(L"TEST IS GOOD");
        }
        else
        {
            printf("COM: Failed\n");
        }
    }

    CoUninitialize();
    return 0;
}

실행해 보면, C# 측의 ShowWinFormMessage가 호출되는 것을 확인할 수 있습니다. 이렇게까지 구현이 되었으면, 이제 CoGetClassObject + IClassFactory::CreateInstance의 2단계가 아닌, 다음과 같이 1단계로 끝낼 수 있습니다.

IMySimpleObject *pSimple2;
hr = CoCreateInstance(refclsId, nullptr, CLSCTX_INPROC_SERVER, iid, (LPVOID *)&pSimple2);
if (hr == S_OK)
{
    pSimple2->ShowWinFormMessage(L"TEST IS GOOD2");
}

당연히, C#에서도 위에서 만든 COM DLL을 호출할 수 있습니다. 다음과 같이!

Guid guid = new Guid("C0000000-71EB-43A6-9BD1-5770A3737617");
Type type = Type.GetTypeFromCLSID(guid);

object comObject = Activator.CreateInstance(type);

Type objType = comObject.GetType();

objType.InvokeMember("ShowWinFormMessage", 
    System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public
    | System.Reflection.BindingFlags.InvokeMethod,
    null, comObject, new object[] { "TEST IS GOOD3" });




마지막으로 남은 함수 하나! 닷넷의 특성상 DLL을 내리는 것이 불가능하므로 별다른 선택의 여지없이 -1을 반환하는 DllCanUnloadNow 코드.

[DllExport("DllCanUnloadNow", CallingConvention = CallingConvention.StdCall)]
public static int DllCanUnloadNow()
{
    return -1; // S_FALSE
}




C#으로 설명하긴 했지만, 써 놓고 보니 결국 C++의 배경 지식이 있어야 잘 이해될 수 있는 곳들이 많군요. ^^;

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]





[최초 등록일: ]
[최종 수정일: 4/5/2017 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer@outlook.com

비밀번호

댓글 쓴 사람
 




... 31  32  33  34  35  36  37  38  39  40  [41]  42  43  44  45  ...
NoWriterDateCnt.TitleFile(s)
11206정성태5/24/20175484오류 유형: 389. DISM.exe - The specified image in the specified wim is already mounted for read/write access.
11205정성태5/24/20174512.NET Framework: 658. C#의 tail call 구현은?
11204정성태3/8/202011987개발 환경 구성: 316. 간단하게 살펴보는 Docker for Windows [5]
11203정성태5/19/20176270오류 유형: 388. docker - Host does not exist: "default"
11202정성태5/19/20174523오류 유형: 387. WPF - There is no registered CultureInfo with the IetfLanguageTag 'ug'.
11201정성태5/16/20176773오류 유형: 386. WPF - .NET 3.5 이하에서 TextBox에 한글 입력 시 TextChanged 이벤트의 비정상 종료 문제 [1]파일 다운로드1
11200정성태5/16/20174453오류 유형: 385. WPF - 폰트가 없어 System.IO.FileNotFoundException 예외가 발생하는 경우
11199정성태5/16/20175363.NET Framework: 657. CultureInfo.GetCultures가 반환하는 값
11198정성태5/10/20176503.NET Framework: 656. Windows Forms의 오류(Exception) 처리 방법에 대한 차이점 설명
11197정성태5/8/20174677개발 환경 구성: 315. VHD 파일의 최소 크기파일 다운로드1
11196정성태5/4/20175647오류 유형: 384. Msvm_ImageManagementService WMI 객체를 사용할 때 오류 상황 정리 [1]
11195정성태8/19/20175829.NET Framework: 655. .NET Framework 4.7 릴리스
11194정성태5/3/20176891오류 유형: 383. net use 명령어로 네트워크 드라이브 연결 시 "System error 67 has occurred." 오류 발생
11193정성태5/3/20175812Windows: 141. 설치된 Windows로부터 설치 이미지를 만드는 방법
11192정성태5/2/20176628Windows: 140. unattended.xml/autounattend.xml 파일을 마련하는 방법
11191정성태5/2/20176849Windows: 139. Dell Venue 8 Pro 태블릿에 USB를 이용한 윈도우 운영체제 설치 방법
11190정성태5/2/20178609Windows: 138. Windows 운영체제의 ISO 설치 파일에 미리 Device driver를 준비하는 방법
11189정성태5/2/20175212Windows: 137. Windows 7 USB/DVD DOWNLOAD TOOL로 98%에서 실패하는 경우
11188정성태4/27/20175592VC++: 118. Win32 HANDLE 자료형의 이모저모
11187정성태4/26/20177110개발 환경 구성: 314. C# - PowerPoint 확장 Add-in 만드는 방법 [1]파일 다운로드1
11186정성태4/24/20175688VS.NET IDE: 117. Visual Studio 확장(VSIX)을 이용해 사용자 매크로를 추가하는 방법 [1]파일 다운로드1
11185정성태4/22/20174811VS.NET IDE: 116. Visual Studio 확장(VSIX)을 이용해 사용자 메뉴 추가하는 방법 (2) - 동적 메뉴 구성파일 다운로드1
11184정성태4/21/20175720VS.NET IDE: 115. Visual Studio 확장(VSIX)을 이용해 사용자 메뉴 추가하는 방법파일 다운로드1
11183정성태4/19/20175097.NET Framework: 654. UWP 앱에서 FolderPicker 사용 시 유의 사항파일 다운로드1
11182정성태4/19/20175846개발 환경 구성: 313. Nuget Facebook 라이브러리를 이용해 ASP.NET 웹 폼과 로그인 연동하는 방법
11181정성태4/18/20174420개발 환경 구성: 312. Azure Web Role의 AppPool 실행 권한을 Local System으로 바꾸는 방법
... 31  32  33  34  35  36  37  38  39  40  [41]  42  43  44  45  ...