💭 🚵 🔙 Visual C ++でWindowsランタイムコンポーネントを作成する 👩🏼‍🤝‍👩🏻 🚷 🏪

C＃の荒野を通るでこぼこ道と、ある時点でのWindowsランタイム向けのC ++ / CX開発の茂みにより、WinRTおよびCOMアプリケーションとコンポーネントを簡単に作成できるWRLテンプレートライブラリに至りました。この特定のライブラリを操作するとき、コードがそれ自体の下に隠れるものを見つけたいと思いました。

#include "pch.h" #include "RAWinRT.WRL.h" using namespace Microsoft::WRL::Wrappers; using namespace Microsoft::WRL; using namespace ABI::RAWinRT::WRL; using namespace ABI::Windows::ApplicationModel::Background; class ABI::RAWinRT::WRL::TestTask : public RuntimeClass < RuntimeClassFlags<WinRt>, IBackgroundTask > { InspectableClass(RuntimeClass_RAWinRT_WRL_TestTask, BaseTrust); public: STDMETHODIMP Run(IBackgroundTaskInstance *taskInstance) override { return S_OK; } }; ActivatableClass(TestTask);

これらの不可解なマクロ、テンプレート、ライブラリ関数。

そして、私は最も単純なものから始めることにしました。 Visual C ++でバックグラウンドタスクの単一の「クラス」を持つWindowsランタイムコンポーネントを記述します。

あなたがそれから来たものに興味があるなら、猫へようこそ。

コンポーネントプロジェクトの作成とカスタマイズ

最初に、Visual Studio 2013 IDEで空のソリューションファイルを作成し、WindowsストアアプリケーションのDLLプロジェクトを追加しました。

プロジェクトでは、NMSPC.TestComponentという名前を選択しました。ここで、NMSPCは名前空間です。このような命名は、プロジェクトを作成する際のかなり一般的な慣行であるため、デモ目的でこれを行いました。また、デフォルトのネームスペースをNMSPC_TestComponentから対応するプロジェクト名に変更しました。

ファイルについては、短い名前を好むため、ヘッダーファイルとソースファイルの名前をTetsComponentに変更しました。コードにコンポーネントを実装する前に、いくつかの追加ファイルを追加しました。 TestComponent.def-動的ライブラリによってエクスポートされる関数を定義するためのファイル、TestComponent.idl-インターフェイスを記述するためのファイル

これらのファイルをプロジェクトに追加したら、構成を開始しました。各構成の設定を個別に変更しないようにするには、すべての構成とプラットフォームを選択して、パラメーターの編集に進むだけで十分です。アラートレベル設定が指定され、メタデータ生成オプションが指定され、MIDLコンパイラーによって生成されたヘッダーファイルの名前テンプレートが変更され、runtimeobject.libのレイアウトが追加され、サブシステムが選択されました。

次に、プロジェクトを構築するための追加ステップを設定しました。彼についてもう少し説明します。

このステップは、プロジェクトメタデータの正しい生成を目的としています。コマンドラインは次のように設定されました。

 del "$(OutDir)$(TargetName).winmd" && mdmerge -partial -i "$(OutDir)." -o "$(OutDir)Output" -metadata_dir "$(WindowsSDK_MetadataPath)" && del "$(OutDir)*.winmd" && copy /y "$(OutDir)Output\*" "$(OutDir)" && rd /q /s "$(OutDir)Output"

少数の連続したステップで構成され、各ステップは特定のタスクを実行します。

宛先フォルダーからNMSPC.TestComponent.winmdプロジェクトメタデータファイルを削除します。
メタデータファイルを結合します。結果は、出力フォルダーの$（OutDir）に配置されます。
Ouputフォルダーから$（OutDir）フォルダーにメタデータファイルをコピーします。
コンテンツと共に出力フォルダーを削除します。

これらの準備手順をすべて完了した後、ようやくコードの記述を開始できました。

DEF、MIDL、PCH

自尊心のあるWindowsランタイムコンポーネントライブラリは、ランタイムによって使用される2つの非常に重要な関数、DllGetActivationFactoryおよびDllCanUnloadNowをエクスポートする必要があります。これらの関数のエクスポートは、TestComponent.defファイルで定義されました（コードで実装する必要がありますが、これについては後で詳しく説明します）。

 EXPORTS DllGetActivationFactory PRIVATE DllCanUnloadNow PRIVATE

次に、TestComponent.idlファイルでクラスインターフェイスについて説明しました。

 import "Windows.ApplicationModel.Background.idl"; namespace NMSPC { namespace TestComponent { [version(1.0)] [activatable(1.0)] [marshaling_behavior(agile)] [threading(both)] runtimeclass TestBackgroundTask { [default] interface Windows.ApplicationModel.Background.IBackgroundTask; }; } }

最初のディレクティブは、Windows :: ApplicationModel :: Background :: IBackgroundTaskのバックグラウンドタスクインターフェイスの説明を含むファイルをインポートします。このファイルはMIDLコンパイラに十分なので、他のインターフェイス記述ファイルをインポートする必要はありません（Windowsストア8.1プラットフォームの場合、インターフェイス記述ファイルとヘッダーファイルはC：\ Program Files（x86）\ Windows Kits \ 8.1 \ Include \ winrtにあります）。クラスの名前空間は、プロジェクト名NMSPC :: TestComponentに従って選択されました。属性を使用して、クラスのバージョン（バージョン）、デフォルトコンストラクターの存在の兆候（起動可能）、スレッドの操作（スレッド化）およびマーシャリング（marshaling_behavior）を設定しました。 MIDLコンパイラを使用してこれをコンパイルすると、TetsComponent.hヘッダーファイルが取得されました。

コンパイル時間を短縮するため、pch.hファイル（プリコンパイル済みヘッダーファイルの生成に使用）にactivation.hおよび新しいヘッダーファイルを含めるためのディレクティブを追加で発行しました。これらのヘッダーファイルを含める必要があることは、IActivationFactoryインターフェイスの依存関係とstd :: nothrow定数によって説明されています。

 #pragma once #include "targetver.h" #ifndef WIN32_LEAN_AND_MEAN #define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers #endif #include <windows.h> #include <activation.h> #include <new>

コードにクラス、ファクトリ、エクスポートされた関数を実装するために残っただけです。

コード

まず、プリコンパイル済みヘッダーファイルに加えて、MIDLコンパイラーによって生成されたTestComponent.hヘッダーファイルをTestComponent.cppコードファイルに含めました。慣例により、コンパイラ用にMIDLによって生成されたすべてのインターフェイスはABI名前空間に配置されるため、クラスとその宣言のインターフェイスはABI :: NMSPC :: TestComponentに配置され、バックグラウンドタスクをABI :: Windows :: ApplicationModel :: Background（名前空間全体をインポートしたのではなく、個々のインターフェイスのみの使用を示しました）。

 #include "pch.h" #include "TestComponent.h" //     using namespace ABI::NMSPC::TestComponent; //     ABI::Windows::ApplicationModel::Background using ABI::Windows::ApplicationModel::Background::IBackgroundTask; using ABI::Windows::ApplicationModel::Background::IBackgroundTaskInstance;

バックグラウンドタスクの実装クラスは非常にシンプルであることが判明しました。本質的に、IUnknown、IInspectable、およびIBackgroundTaskインターフェイスを実装する必要がありました。

 //   . //  "" IBackgroundTask class ABI::NMSPC::TestComponent::TestBackgroundTask sealed : public IBackgroundTask { //       ULONG m_count; public: TestBackgroundTask() throw() : m_count(1) { //      InterlockedIncrement(&m_objectsCount); } ~TestBackgroundTask() throw() { //      InterlockedDecrement(&m_objectsCount); } #pragma region IUnknown // COM       STDMETHODIMP_(ULONG) AddRef() throw() override final { //        return InterlockedIncrement(&m_count); } // COM       STDMETHODIMP_(ULONG) Release() throw() override { //        auto const count = InterlockedDecrement(&m_count); //     if (0 == count) { //  delete this; } //   return count; } // COM       STDMETHODIMP QueryInterface(const IID& riid, void** ppvObject) throw() override final { //      //     IBackgroundTask  IInspectable // IInspectable  IUnknown if (__uuidof(IUnknown) == riid || __uuidof(IInspectable) == riid || __uuidof(IBackgroundTask) == riid) { *ppvObject = this; } else { *ppvObject = nullptr; //  ,      return E_NOINTERFACE; } //     //   static_cast<IInspectable*>(*ppvObject)->AddRef(); return S_OK; } #pragma endregion #pragma region IInspectable // WINRT       STDMETHODIMP GetIids(ULONG* iidCount, IID** iids) throw() override { //    GUID, ..       //  CoTaskMemAlloc, ..        CoTaskMemFree *iids = static_cast<GUID*>(CoTaskMemAlloc(sizeof(GUID))); //  NULL if (!*iids) { //    return E_OUTOFMEMORY; } //    *iidCount = 1; //    IBackgroundTask (*iids)[0] = __uuidof(IBackgroundTask); return S_OK; } // WINRT    Runtime  STDMETHODIMP GetRuntimeClassName(HSTRING* className) throw() override final { //    //   E_OUTOFMEMORY     //       if (S_OK != WindowsCreateString( RuntimeClass_NMSPC_TestComponent_TestBackgroundTask, _countof(RuntimeClass_NMSPC_TestComponent_TestBackgroundTask), className)) { return E_OUTOFMEMORY; } return S_OK; } // WINRT   TrustLevel  STDMETHODIMP GetTrustLevel(TrustLevel* trustLevel) throw() override final { *trustLevel = BaseTrust; return S_OK; } #pragma endregion #pragma region IBackgroundTask // IBackgroundTask     STDMETHODIMP Run(IBackgroundTaskInstance* task_instance) throw() override final { //      OutputDebugStringW(L"Hello from background task.\r\n"); return S_OK; } #pragma endregion };

クラスの準備ができたので、オブジェクトファクトリクラスを作成する必要がありました。このファクトリクラスは、activation.hヘッダーファイルで定義されているIActivationFactoryインターフェイスを実装する必要があります。このインターフェイスは、IInspectable（したがってIUnknown）を継承することに加えて、メソッドを定義します

 virtual HRESULT STDMETHODCALLTYPE ActivateInstance( /* [out] */ __RPC__deref_out_opt IInspectable **instance) = 0;

MSDNのメソッドのドキュメントで説明されているように、GetRuntimeClassNameメソッドの実装も異なる必要があります。

https://msdn.microsoft.com/en-us/library/br205823(v=vs.85).aspx

 //    . class TestBackgroundTaskFactory sealed : public IActivationFactory { //       ULONG m_count; public: TestBackgroundTaskFactory() throw() : m_count(1) { //      InterlockedIncrement(&m_objectsCount); } ~TestBackgroundTaskFactory() throw() { //      InterlockedDecrement(&m_objectsCount); } // COM       STDMETHODIMP_(ULONG) AddRef() throw() override final { //        return InterlockedIncrement(&m_count); } // COM       STDMETHODIMP_(ULONG) Release() throw() override { //        auto const count = InterlockedDecrement(&m_count); //     if (0 == count) { //  delete this; } //   return count; } // COM       STDMETHODIMP QueryInterface(const IID& riid, void** ppvObject) throw() override final { if (__uuidof(IUnknown) == riid || __uuidof(IInspectable) == riid || __uuidof(IActivationFactory) == riid) { *ppvObject = this; } else { *ppvObject = nullptr; return E_NOINTERFACE; } static_cast<IInspectable*>(*ppvObject)->AddRef(); return S_OK; } // WINRT       STDMETHODIMP GetIids(ULONG* iidCount, IID** iids) throw() override final { //    GUID, ..       //  CoTaskMemAlloc, ..        CoTaskMemFree *iids = static_cast<GUID*>(CoTaskMemAlloc(sizeof(GUID))); //  NULL if (*iids) { //    return E_OUTOFMEMORY; } //    *iidCount = 1; //    IBackgroundTask (*iids)[0] = __uuidof(IActivationFactory); return S_OK; } // WINRT    Runtime  STDMETHODIMP GetRuntimeClassName(HSTRING*) throw() override final { //  , ..    return E_ILLEGAL_METHOD_CALL; } // WINRT   TrustLevel  STDMETHODIMP GetTrustLevel(TrustLevel* trustLevel) throw() override final { *trustLevel = BaseTrust; return S_OK; } // IActivationFactory    STDMETHODIMP ActivateInstance(IInspectable** instance) throw() override final { //   null if (nullptr == instance) { //  return E_INVALIDARG; } //  //    ,      *instance = new (std::nothrow) TestBackgroundTask(); //        return *instance ? S_OK : E_OUTOFMEMORY; } };

注意深い読者は、クラスのコンストラクタとデストラクタの奇妙な詳細、つまり変数m_objectsCountのインクリメントとデクリメントに気付くでしょう。クラスコードの前にディレクティブを使用した直後に、この変数を宣言しました。そして、DllCanUnloadNow関数のエクスポートされたライブラリで使用されます。

 //       HRESULT WINAPI DllCanUnloadNow() throw() { //        return m_objectsCount ? S_FALSE : S_OK; }

この関数に加えて、別のDllGetActivationFactoryが定義されました。これは、クラス識別子（Windowsランタイムではすべての名前空間を含む文字列）でファクトリを受け取ることを目的としています。

 //      ,   activatableClassId HRESULT WINAPI DllGetActivationFactory(HSTRING activatableClassId, IActivationFactory **factory) throw() { //       if (WindowsIsStringEmpty(activatableClassId) || nullptr == factory) { //       return E_INVALIDARG; } //          if (0 == wcscmp(RuntimeClass_NMSPC_TestComponent_TestBackgroundTask, WindowsGetStringRawBuffer(activatableClassId, nullptr))) { //  *factory = new (std::nothrow) TestBackgroundTaskFactory(); return *factory ? S_OK : E_OUTOFMEMORY; } *factory = nullptr; return E_NOINTERFACE; }

C＃アプリケーションでのコンポーネントの使用について説明する前に、dllmain.cppファイルで定義されているDllMain関数の明示的な実装についても説明します。診断目的でのみ使用しましたが、ユースケースは私のものとは異なる場合があります。

 #include "pch.h" BOOL APIENTRY DllMain(HMODULE /* hModule */, DWORD ul_reason_for_call, LPVOID /* lpReserved */) { OutputDebugStringW(L"Hello from DLL.\r\n"); return TRUE; }

これで、コンポーネントライブラリの実装が完了しました。そして、アプリケーションでの実用化を開始することができました。

C＃アプリケーション

Blank Appテンプレートを使用してNMSPC.CSTestApppアプリケーションプロジェクトを作成したら、コンポーネントプロジェクトとMicrosoft Visual C ++ 2013ランタイムパッケージへのリンクを追加しました。

残ったのは、アプリケーションマニフェストファイルを編集して、バックグラウンドタスクの定義を追加し、バックグラウンドタスクを登録するコードを書くことだけでした。

コードは、AppクラスのOnLaunchedメソッドに配置されます。コードは単純です。最初にすべてのタスク登録を削除してから、タスクビルダオブジェクトを作成し、マニフェストで指定されたトリガーを設定して、タスクを登録します。

 foreach (var pair in BackgroundTaskRegistration.AllTasks) { pair.Value.Unregister(true); } var taskBuilder = new BackgroundTaskBuilder { Name = "TestBackgroundTask", TaskEntryPoint = "NMSPC.TestComponent.TestBackgroundTask" }; taskBuilder.SetTrigger(new SystemTrigger(SystemTriggerType.TimeZoneChange, true)); taskBuilder.Register();

C ++コードのブレークポイントに移動できるようにするために、アプリケーションプロジェクトのデバッグ設定でプロセスタイプMixed（Managed and Native）を設定します。ところで、この設定はC ++ / CXアプリケーションにも関連しています。

これで、デバッグモードでアプリケーションを起動し、コンポーネント登録コードを実行し、[デバッグの場所]セクションの[ライフサイクルイベント]ボタンを使用してバックグラウンドタスクの起動をテストできました。

これを実行すると、出力ウィンドウに非常に大事な行が表示され、その出力はOutputDebugStringW関数を使用してC ++コードでプログラムされました。

 Hello from DLL. Hello from background task.

おわりに

結局のところ、WRLを使用せずにコンポーネントコードを記述することが可能です。この問題の解決策により、Windowsランタイム環境のコンポーネント間の相互作用の実行メカニズムと原理をよりよく理解することが可能になりました。

GitHubで入手可能なソースコード

https://github.com/altk/RuntimeComponent

Visual C ++でWindowsランタイムコンポーネントを作成する

コンポーネントプロジェクトの作成とカスタマイズ

DEF、MIDL、PCH

コード

C＃アプリケーション

おわりに

More articles: