ホステッドアプリの作成

[アーティクル]
06/02/2023

Windows 10 Version 2004 以降では、"ホステッドアプリ" を作成できます。ホステッドアプリは、親の "ホスト" アプリと同じ実行可能ファイルと定義を共有しますが、外観と動作はシステム上で別々のアプリのようになります。

ホステッドアプリは、コンポーネント (実行可能ファイルやスクリプトファイルなど) がスタンドアロンの Windows 10 アプリのように動作する必要があるものの、そのコンポーネントを実行するためにホストプロセスが必要な場合に役立ちます。たとえば、PowerShell または Python スクリプトは、実行するためにホストをインストールする必要があるホステッドアプリとして提供できます。ホステッドアプリには、独自のスタートタイルや ID を指定できるほか、バックグラウンドタスク、通知、タイル、共有ターゲットなどの Windows 10 の機能と緊密に統合することもできます。

ホステッドアプリの機能は、パッケージマニフェスト内のいくつかの要素と属性でサポートされています。これにより、ホステッドアプリがホストアプリパッケージ内の実行可能ファイルと定義を使用できるようになります。ユーザーがホステッドアプリを実行すると、OS はホステッドアプリの ID でホスト実行可能ファイルを自動的に起動します。その後、ホストはホステッドアプリとしてビジュアル資産やコンテンツを読み込んだり、API を呼び出したりすることができます。ホステッドアプリは、ホストとホステッドアプリとの間で宣言された機能の共通部分を取得します。つまり、ホステッドアプリは、ホストが提供するよりも多くの機能を要求することはできません。

ホストを定義する

"ホスト" は、ホステッドアプリのメインの実行可能またはランタイムプロセスです。現在サポートされているホストは、"パッケージ ID" を持つデスクトップアプリ (.NET または C++ デスクトップ) のみです。デスクトップアプリがパッケージ ID を持つには、いくつかの方法があります。

デスクトップアプリにパッケージ ID を付与する方法として最も一般的なのは、MSIX パッケージにパッケージ化することです。
場合によっては、外部の場所を持つパッケージを作成してパッケージ ID を付与することもできます (「外部の場所でパッケージ化することでパッケージ ID をを参照してください)。このオプションは、デスクトップアプリをインストールするために MSIX を採用できない場合に便利です。

ホストは、uap10:HostRuntime 拡張機能によってパッケージマニフェストで宣言されます。この拡張機能にある Id 属性には、ホステッドアプリのパッケージマニフェストでも参照される値を割り当てる必要があります。ホステッドアプリがアクティブになると、ホストはホステッドアプリの ID で起動され、ホステッドアプリパッケージからコンテンツまたはバイナリを読み込むことができます。

次の例は、パッケージマニフェストでホストを定義する方法を示しています。 uap10:HostRuntime 拡張機能はパッケージ全体にわたる機能であるため、Package 要素の子として宣言されます。

<Package xmlns:uap10="http://schemas.microsoft.com/appx/manifest/uap/windows10/10">

  <Extensions>
    <uap10:Extension Category="windows.hostRuntime"  
        Executable="PyScriptEngine\PyScriptEngine.exe"  
        uap10:RuntimeBehavior="packagedClassicApp"  
        uap10:TrustLevel="mediumIL">
      <uap10:HostRuntime Id="PythonHost" />
    </uap10:Extension>
  </Extensions>

</Package>

次の要素に関する以下の重要な詳細情報をメモしてください。

要素詳細

uap10:Extension windows.hostRuntime カテゴリは、ホステッドアプリのアクティブ化時に使用されるランタイム情報を定義する、パッケージ全体の拡張機能を宣言します。ホステッドアプリは、拡張機能で宣言された定義を使用して実行されます。前の例で宣言されたホストアプリを使用する場合、ホステッドアプリは mediumIL 信頼レベルで実行可能ファイル PyScriptEngine.exe として実行されます。

Executable、uap10:RuntimeBehavior、および uap10:TrustLevel の各属性は、パッケージ内のホストプロセスバイナリの名前と、ホステッドアプリの実行方法を指定します。たとえば、前の例の属性を使用するホステッドアプリは、mediumIL 信頼レベルでPyScriptEngine.exe 実行可能ファイルとして実行されます。

uap10:HostRuntime Id 属性は、パッケージでこの特定のホストアプリの一意の ID を宣言します。パッケージには複数のホストアプリを備えることができ、それぞれには、一意の Id を持つ uap10:HostRuntime 要素が必要です。

要素	詳細
uap10:Extension	`windows.hostRuntime` カテゴリは、ホステッドアプリのアクティブ化時に使用されるランタイム情報を定義する、パッケージ全体の拡張機能を宣言します。ホステッドアプリは、拡張機能で宣言された定義を使用して実行されます。前の例で宣言されたホストアプリを使用する場合、ホステッドアプリは mediumIL 信頼レベルで実行可能ファイル PyScriptEngine.exe として実行されます。 Executable、uap10:RuntimeBehavior、および uap10:TrustLevel の各属性は、パッケージ内のホストプロセスバイナリの名前と、ホステッドアプリの実行方法を指定します。たとえば、前の例の属性を使用するホステッドアプリは、mediumIL 信頼レベルでPyScriptEngine.exe 実行可能ファイルとして実行されます。
uap10:HostRuntime	Id 属性は、パッケージでこの特定のホストアプリの一意の ID を宣言します。パッケージには複数のホストアプリを備えることができ、それぞれには、一意の Id を持つ uap10:HostRuntime 要素が必要です。

ホステッドアプリを宣言する

"ホステッドアプリ" は、"ホスト" へのパッケージの依存関係を宣言します。ホステッドアプリは、独自のパッケージでエントリポイントの実行可能ファイルを指定するのではなく、アクティブ化のためにホストの ID (つまり、ホストパッケージ内のuap10:HostRuntime 拡張機能の Id 属性) を利用します。ホステッドアプリには、通常、ホストからアクセスできるコンテンツ、ビジュアル資産、スクリプト、またはバイナリが含まれます。ホステッドアプリパッケージ内の TargetDeviceFamily 値は、ホストと同じ値をターゲットにする必要があります。

ホステッドアプリパッケージは、署名付きでも署名なしでもかまいません。

署名付きパッケージには、実行可能ファイルを含めることができます。これは、バイナリ拡張メカニズムがあり、ホストがホステッドアプリパッケージに DLL または登録済みコンポーネントを読み込むことができる場合に役立ちます。
ほとんどのシナリオでは、署名されていないパッケージには実行可能なコンテンツが含まれます。ただし、 非実行可能ファイル ファイルのみを含む署名されていないパッケージは、ホストがイメージ、アセット、およびコンテンツファイルまたはスクリプトファイルのみを読み込む必要があるシナリオで役立ちます。署名されていないパッケージは、Identity 要素に特別なOID値を含める必要があります。そうしないと、登録できません。これにより、署名なしパッケージが署名付きパッケージの ID と競合したり、これをスプーフィングしたりするのを防止できます。

ホストテッドアプリを定義するには、パッケージマニフェストで次の項目を宣言します。

uap10:HostRuntimeDependency 要素。これは、Dependencies 要素の子です。
Application 要素 (アプリの場合) または Extension 要素 (アクティブ化可能な拡張機能の場合) の uap10:HostId 属性。

次の例は、署名なしホステッドアプリのパッケージマニフェストの関連セクションを示しています。

<Package xmlns:uap10="http://schemas.microsoft.com/appx/manifest/uap/windows10/10">

  <Identity Name="NumberGuesserManifest"
    Publisher="CN=AppModelSamples, OID.2.25.311729368913984317654407730594956997722=1"
    Version="1.0.0.0" />

  <Dependencies>
    <TargetDeviceFamily Name="Windows.Desktop" MinVersion="10.0.19041.0" MaxVersionTested="10.0.19041.0" />
    <uap10:HostRuntimeDependency Name="PyScriptEnginePackage" Publisher="CN=AppModelSamples" MinVersion="1.0.0.0"/>
  </Dependencies>

  <Applications>
    <Application Id="NumberGuesserApp"  
      uap10:HostId="PythonHost"  
      uap10:Parameters="-Script &quot;NumberGuesser.py&quot;">
    </Application>
  </Applications>

</Package>

次の要素に関する以下の重要な詳細情報をメモしてください。

要素	詳細
ID	この例のホステッドアプリパッケージは署名がないので、Publisher 属性には `OID.2.25.311729368913984317654407730594956997722=1` 文字列を組み込む必要があります。これにより、署名なしパッケージが署名付きパッケージの ID をスプーフィングできないことが確実になります。
TargetDeviceFamily	MinVersion 属性は 10.0.19041.0 またはそれ以降の OS バージョンを指定する必要があります。
uap10:HostRuntimeDependency	この要素は、ホストアプリパッケージへの依存関係を宣言します。これは、ホストパッケージの Name と Publisher、および依存している MinVersion で構成されます。これらの値は、ホストパッケージの Identity 要素の下にあります。
Application	uap10:HostId 属性は、ホストへの依存関係を表します。ホステッドアプリパッケージは、Application または Extension の各要素に通常の Executable と EntryPoint の各属性の代わりにこの属性を宣言する必要があります。その結果、ホステッドアプリは、Executable、EntryPoint およびランタイムの属性を、対応する HostId 値を持つホストから継承します。 uap10:Parameters 属性は、ホスト実行可能ファイルのエントリポイント関数に渡されるパラメーターを指定します。ホストはこれらのパラメーターの処理方法を認識している必要があるため、ホストとホステッドアプリの間には暗黙の契約があります。

実行時に署名なしホステッドアプリパッケージを登録する

uap10:HostRuntime 拡張機能のメリットの 1 つは、PackageManager API を使用して実行時にホステッドアプリパッケージを動的に生成し、登録できるようになることです。署名する必要はありません。これにより、ホストは、ホステッドアプリパッケージのコンテンツとマニフェストを動的に生成し、登録できます。

署名なしのホステッドアプリパッケージを登録するには、PackageManager クラスの以下の方法を使用します。これらの方法は、Windows 10 バージョン 2004 以降で使用できます。

AddPackageByUriAsync: options パラメーターの AllowUnsigned プロパティを使用して、署名なしの MSIX パッケージを登録します。
RegisterPackageByUriAsync: ルースパッケージマニフェストファイル登録を実行します。パッケージが署名されている場合、マニフェストが入っているフォルダーには .p7x ファイルとカタログが含まれている必要があります。署名なしの場合、options パラメーターの AllowUnsigned プロパティが設定されなければなりません。

署名なしのホステッドアプリの要件

パッケージマニフェスト内の Application または Extension の各要素には、Executable、EntryPoint、または TrustLevel の各属性などのライセンス認証データを含めることはできません。代わりに、これらの要素には、ホストへの依存関係を表す uap10:HostId 属性と、uap10:Parameters 属性のみを含めることができます。
パッケージはメインパッケージである必要があります。バンドル、フレームワークパッケージ、リソース、オプションパッケージにすることはできません。

署名なしのホステッドアプリパッケージをインストールして登録するホストの要件

ホストにはパッケージ ID が必要です。
ホストには、 packageManagement restricted 機能が必要です。
```
<rescap:Capability Name="packageManagement" />
```

サンプル

それ自体をホストとして宣言してから、実行時にホステッドアプリパッケージを動的に登録するというように、適切に機能するサンプルアプリについては、ホステッドアプリのサンプルに関するページを参照してください。

ホスト

ホストには PyScriptEngine という名前が付いています。これは、Python スクリプトを実行する C# で記述されたラッパーです。 -Register パラメーターを指定して実行すると、スクリプトエンジンによって、Python スクリプトを含むホステッドアプリがインストールされます。ユーザーが新しくインストールされたホステッドアプリを起動しようとすると、ホストが起動され、NumberGuesser Python スクリプトが実行されます。

ホストアプリのパッケージマニフェスト (PyScriptEnginePackage フォルダー内の Package.appxmanifest ファイル) には、ID PythonHost と実行可能ファイル PyScriptEngine.exe を使用してアプリをホストとして宣言する uap10:HostRuntime 拡張機能が入っています。

Note

このサンプルでは、パッケージマニフェストは package.appxmanifest という名前で、Windows アプリケーションパッケージプロジェクトの一部です。このプロジェクトがビルドされると、AppxManifest.xml という名前のマニフェストが生成され、ホストアプリの MSIX パッケージがビルドされます。