Практическое руководство. Создание классического компонента COM с помощью WRL

  • Статья

Библиотеку шаблонов C++ (WRL) можно использовать среда выполнения Windows для создания базовых классических com-компонентов для использования в классических приложениях, а также для приложений универсальная платформа Windows (UWP). Для создания COM-компонентов библиотека шаблонов C++ среда выполнения Windows может требовать меньше кода, чем ATL. Сведения о подмножестве COM, поддерживаемых библиотекой шаблонов C++ среда выполнения Windows C++, см. в разделе среда выполнения Windows библиотеке шаблонов C++ (WRL).

В этом документе показано, как использовать библиотеку шаблонов C++ среда выполнения Windows для создания базового COM-компонента. Хотя можно использовать механизм развертывания, который наилучшим образом соответствует требованиям, в этом документе также показан простой способ регистрации и использования компонента модели COM из обычного приложения для настольных систем.

Использование библиотеки шаблонов C++ среда выполнения Windows для создания базового классического COM-компонента

  1. В Visual Studio создайте проект пустого решения . Присвойте проекту имя, например WRLClassicCOM.

  2. Добавьте в решение проект Win32. Присвойте проекту имя, например CalculatorComponent. На вкладке "Приложение Параметры" выберите библиотеку DLL.

  3. Добавьте в проект файл Midl File (IDL). Присвойте файлу имя, например CalculatorComponent.idl.

  4. Добавьте этот код в файл CalculatorComponent.idl:

    import "ocidl.idl";

[uuid(0DBABB94-CE99-42F7-ACBD-E698B2332C60), version(1.0)] 
interface ICalculatorComponent : IUnknown
{
    HRESULT Add([in] int a, [in] int b, [out, retval] int* value);
}

[uuid(9D3E6826-CB8E-4D86-8B14-89F0D7EFCD01), version(1.0)]
library CalculatorComponentLib
{
    [uuid(E68F5EDD-6257-4E72-A10B-4067ED8E85F2), version(1.0)]
    coclass CalculatorComponent
    {
        [default] interface ICalculatorComponent;
    }
};

  5. В файле CalculatorComponent.cpp определите класс CalculatorComponent. Класс CalculatorComponent наследует от Microsoft::WRL::RuntimeClass. Microsoft::WRL::RuntimeClassFlags<ClassicCom> указывает, что класс является производным от IUnknown и не IInspectable. (IInspectable доступно только для среда выполнения Windows компонентов приложения.) CoCreatableClass создает фабрику для класса, который можно использовать с такими функциями, как CoCreateInstance.

    #include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier

#include "CalculatorComponent_h.h"
#include <wrl.h>

using namespace Microsoft::WRL;

class CalculatorComponent: public RuntimeClass<RuntimeClassFlags<ClassicCom>, ICalculatorComponent>
{
public:
    CalculatorComponent()
    {
    }

    STDMETHODIMP Add(_In_ int a, _In_ int b, _Out_ int* value)
    {
        *value = a + b;
        return S_OK;
    }
};

CoCreatableClass(CalculatorComponent);

  6. Используйте следующий код, чтобы заменить код в dllmain.cpp. Этот файл определяет функции экспорта библиотек DLL. Эти функции используют класс Microsoft::WRL::Module для управления фабриками классов для модуля.

    #include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier
#include <wrl\module.h>

using namespace Microsoft::WRL;

#if !defined(__WRL_CLASSIC_COM__)
STDAPI DllGetActivationFactory(_In_ HSTRING activatibleClassId, _COM_Outptr_ IActivationFactory** factory)
{
    return Module<InProc>::GetModule().GetActivationFactory(activatibleClassId, factory);
}
#endif

#if !defined(__WRL_WINRT_STRICT__)
STDAPI DllGetClassObject(REFCLSID rclsid, REFIID riid, _COM_Outptr_ void** ppv)
{
    return Module<InProc>::GetModule().GetClassObject(rclsid, riid, ppv);
}
#endif

STDAPI DllCanUnloadNow()
{
    return Module<InProc>::GetModule().Terminate() ? S_OK : S_FALSE;
}

STDAPI_(BOOL) DllMain(_In_opt_ HINSTANCE hinst, DWORD reason, _In_opt_ void*)
{
    if (reason == DLL_PROCESS_ATTACH)
    {
        DisableThreadLibraryCalls(hinst);
    }
    return TRUE;
}

  7. Добавьте файл файла определения модуля (.def) в проект. Присвойте файлу имя, например CalculatorComponent.def. Этот файл передает компоновщику имена функций, подлежащих экспорту. Откройте диалоговое окно "Страницы свойств" проекта, а затем в разделе "Входные данные компоновщика>свойств>конфигурации" задайте свойству файла определения модуля значение DEF-файла.

  8. Добавьте в файл CalculatorComponent.def следующий код:

    LIBRARY

EXPORTS
    DllGetActivationFactory PRIVATE
    DllGetClassObject       PRIVATE
    DllCanUnloadNow         PRIVATE

  9. Добавьте файл runtimeobject.lib в строку компоновщика. Дополнительные сведения см. в разделе .Lib "Файлы как входные данные компоновщика".

Использование компонента модели COM в обычном приложении для настольных систем

  1. Зарегистрируйте компонент модели COM в реестре Windows. Для этого создайте файл записей регистрации, назовите его RegScript.regи добавьте следующий текст. Замените <путь> dll на путь к библиотеке DLL, например C:\temp\WRLClassicCOM\Debug\CalculatorComponent.dll.

    Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}]
@="CalculatorComponent Class"

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\InprocServer32]
@="<dll-path>"
"ThreadingModel"="Apartment"

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\Programmable]

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\TypeLib]
@="{9D3E6826-CB8E-4D86-8B14-89F0D7EFCD01}"

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\Version]
@="1.0"

  2. Запустите RegScript.reg или добавьте его в событие после сборки проекта. Дополнительные сведения см . в диалоговом окне командной строки события предварительной сборки или события после сборки.

  3. Добавьте в решение проект консольного приложения Win32. Присвойте проекту имя, например Calculator.

  4. Используйте этот код для замены содержимого Calculator.cpp:

    #include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier

#include "..\CalculatorComponent\CalculatorComponent_h.h"

const IID IID_ICalculatorComponent = {0x0DBABB94,0xCE99,0x42F7,0xAC,0xBD,0xE6,0x98,0xB2,0x33,0x2C,0x60};
const CLSID CLSID_CalculatorComponent = {0xE68F5EDD,0x6257,0x4E72,0xA1,0x0B,0x40,0x67,0xED,0x8E,0x85,0xF2};

// Prints an error string for the provided source code line and HRESULT
// value and returns the HRESULT value as an int.
int PrintError(unsigned int line, HRESULT hr)
{
    wprintf_s(L"ERROR: Line:%d HRESULT: 0x%X\n", line, hr);
    return hr;
}

int wmain()
{
    HRESULT hr;

    // Initialize the COM library.
    hr = CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED);
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    ICalculatorComponent* calc = nullptr; // Interface to COM component.

    // Create the CalculatorComponent object.
    hr = CoCreateInstance(CLSID_CalculatorComponent, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&calc));
    if (SUCCEEDED(hr))
    {
        // Test the component by adding two numbers.
        int result;
        hr = calc->Add(4, 5, &result);
        if (FAILED(hr))
        {
            PrintError(__LINE__, hr);
        }
        else
        {
            wprintf_s(L"result = %d\n", result);
        }

        // Free the CalculatorComponent object.
        calc->Release();
    }
    else
    {
        // Object creation failed. Print a message.
        PrintError(__LINE__, hr);
    }

    // Free the COM library.
    CoUninitialize();

    return hr;
}
/* Output:
result = 9
*/

Отказоустойчивость

В этом документе используются стандартные функции COM для демонстрации того, что можно использовать библиотеку шаблонов C++ среда выполнения Windows C++, чтобы создать com-компонент и сделать его доступным для любой технологии с поддержкой COM. Вы также можете использовать среда выполнения Windows типы библиотек шаблонов C++, такие как Microsoft::WRL::ComPtr в классическом приложении для управления временем существования COM и других объектов. Следующий код использует библиотеку шаблонов среда выполнения Windows C++ для управления временем существования ICalculatorComponent указателя. Класс CoInitializeWrapper является программой-оболочкой RAII, которая гарантирует, что библиотека COM освобождена и время ее жизни превысит время жизни объекта интеллектуального указателя ComPtr.

#include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier
#include <wrl.h>

#include "..\CalculatorComponent\CalculatorComponent_h.h"

using namespace Microsoft::WRL;

const IID IID_ICalculatorComponent = {0x0DBABB94,0xCE99,0x42F7,0xAC,0xBD,0xE6,0x98,0xB2,0x33,0x2C,0x60};
const CLSID CLSID_CalculatorComponent = {0xE68F5EDD,0x6257,0x4E72,0xA1,0x0B,0x40,0x67,0xED,0x8E,0x85,0xF2};

// Prints an error string for the provided source code line and HRESULT
// value and returns the HRESULT value as an int.
int PrintError(unsigned int line, HRESULT hr)
{
    wprintf_s(L"ERROR: Line:%d HRESULT: 0x%X\n", line, hr);
    return hr;
}

int wmain()
{
    HRESULT hr;

    // RAII wrapper for managing the lifetime of the COM library.
    class CoInitializeWrapper
    {
        HRESULT _hr;
    public:
        CoInitializeWrapper(DWORD flags)
        {
            _hr = CoInitializeEx(nullptr, flags);
        }
        ~CoInitializeWrapper()
        {
            if (SUCCEEDED(_hr))
            {
                CoUninitialize();
            }
        }
        operator HRESULT()
        {
            return _hr;
        }

    };

    // Initialize the COM library.
    CoInitializeWrapper initialize(COINIT_APARTMENTTHREADED);
    if (FAILED(initialize))
    {
        return PrintError(__LINE__, initialize);
    }

    ComPtr<ICalculatorComponent> calc; // Interface to COM component.

    // Create the CalculatorComponent object.
    hr = CoCreateInstance(CLSID_CalculatorComponent, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(calc.GetAddressOf()));
    if (SUCCEEDED(hr))
    {
        // Test the component by adding two numbers.
        int result;
        hr = calc->Add(4, 5, &result);
        if (FAILED(hr))
        {
            return PrintError(__LINE__, hr);
        }
        wprintf_s(L"result = %d\n", result);
    }
    else
    {
        // Object creation failed. Print a message.
        return PrintError(__LINE__, hr);
    }

    return 0;
}

См. также

Библиотека шаблонов C++ для среды выполнения Windows (WRL)