次の方法で共有

Windows ランタイム 8 プロジェクトのユニバーサル Windows プラットフォーム (UWP) プロジェクトへの移植

  • [アーティクル]

[一部の情報はリリース前の製品に関することであり、正式版がリリースされるまでに大幅に変更される可能性があります。本書に記載された情報について、Microsoft は明示または黙示を問わずいかなる保証をするものでもありません。]

移植プロセスを開始するとき、2 つの方法から選ぶことができます。1 つは、既にあるプロジェクト ファイル (アプリ パッケージ マニフェストなど) のコピーを編集する方法です。この方法については、ユニバーサル Windows プラットフォーム用アプリの開発に関するページに記載されているプロジェクト ファイルの更新に関する説明をご覧ください。もう 1 つのオプションは、Visual Studio で新しい Windows 10 プロジェクトを作成し、お使いのファイルをそのプロジェクトにコピーする方法です。 このトピックの最初のセクションでは、2 番目の方法について説明しますが、トピックの他の部分では、両方の方法に適用できる追加情報について説明します。既にあるプロジェクトと同じソリューションに新しい Windows 10 プロジェクトを保持しておき、共有プロジェクトを使ってソース コード ファイルを共有することもできます。また、新しいプロジェクトを独自のソリューションに保持しておき、Visual Studio のリンク ファイル機能を使ってソース コード ファイルを共有することもできます。

プロジェクトを作成し、ファイルをコピーする

次の手順では、Visual Studio で新しい Windows 10 プロジェクトを作成し、お使いのファイルをそのプロジェクトにコピーする方法について説明しています。作成するプロジェクトの数およびコピーするファイルに関する一部の仕様は、「ユニバーサル 8.1 アプリがある場合」や、それに続くセクションで説明されている要因と決定事項によって異なります。次の手順では、最もシンプルなケースを前提としています。

  1. Microsoft Visual Studio 2015 RC を起動し、"新しいアプリケーション (Windows ユニバーサル)" プロジェクトを新規作成します。詳しくは、「テンプレート (C#、C++、Visual Basic) を使った Windows ストア アプリ開発に着手する」をご覧ください。新しいプロジェクトによって、すべてのデバイス ファミリで実行される 1 つのアプリ パッケージ (appx ファイル) が構築されます。
  2. ユニバーサル 8.1 アプリ プロジェクトで、再利用するすべてのソース コード ファイルとビジュアル アセット ファイルを確認します。エクスプローラーを使って、データ モデル、ビュー モデル、ビジュアル アセット、リソース ディクショナリ、フォルダー構造、および再利用するその他すべての要素を、新しいプロジェクトにコピーします。必要に応じて、ディスクにサブフォルダーをコピーするか、作成します。
  3. 新しいプロジェクトに、ビュー (たとえば MainPage.xaml、MainPage.xaml.cs など) もコピーします。ここでも、必要に応じて新しいサブフォルダーを作成し、プロジェクトから既にあるビューを削除します。ただし、Visual Studio が生成したビューを上書きまたは削除する前に、後で参照することが役立つ場合があるために、コピーを保存しておきます。ユニバーサル 8.1 アプリを移植する最初のフェーズでは、1 つのデバイス ファミリでアプリが適切に表示され機能することを重視します。その後で、すべてのフォーム ファクターに対してビューを適切に対応させることに重点を置きます。必要に応じて、特定のデバイス ファミリを最大限に活用できるように、アダプティブ コードを追加します。
  4. ソリューション エクスプローラーで、[すべてのファイルを表示] がオンであることを確認します。コピーしたファイルを選択して右クリックし、[プロジェクトに含める] をクリックします。これによって、含まれるフォルダーが自動的に取り込まれます。後で必要に応じて、[すべてのファイルを表示] をオフに切り替えることができます。代替ワークフローとして、[既存項目の追加] コマンドを使って Visual Studio ソリューション エクスプローラーで必要なすべてのサブフォルダーを作成することもできます。ビジュアル アセットで、[ビルド アクション] が [コンテンツ] に設定されており、[出力ディレクトリにコピー] が [コピーしない] に設定されていることを確認します。
  5. この段階では、ビルド エラーが発生する可能性があります。ただし、どのような変更が必要であるかを理解している場合は、Visual Studio の Find and Replace コマンドを使って、ソース コードに対して一括変更を実行できます。また Visual Studio の命令型コード エディターで、コンテキスト メニューの Resolve コマンドと Organize Usings コマンドを使って、よりターゲットを絞った変更を実行することもできます。

マークアップとコード再利用の最大化

若干のリファクタリングを行い、アダプティブ コード (後で説明します) を追加することで、すべてのデバイス ファミリで動作するマークアップとコードを最大限に活用できることがわかります。詳しい説明を次に示します。

  • すべてのデバイス ファミリに共通するファイルについては、特に考慮する必要はありません。これらのファイルは、実行対象となるすべてのデバイス ファミリで、アプリが使うファイルです。これには、XAML マークアップ ファイル、命令型ソース コード ファイル、アセット ファイルが含まれます。
  • 実行されているデバイス ファミリをアプリで検出し、そのデバイス ファミリ専用に設計されたビューに移動させることができます。詳しくは、「アプリが実行されているプラットフォームの検出」をご覧ください。
  • プラットフォームを検出するための代替方法がない場合に役立つと考えられる同様の手法として、マークアップ ファイルや ResourceDictionary ファイル (またはこのファイルが保存されているフォルダー) に対して特殊な名前を設定する方法があります。この特殊な名前によって、アプリを特定のデバイス ファミリで実行する場合、実行時に自動的に読み込まれるようになります。この手法については、「Bookstore1」のケース スタディをご覧ください。
  • Windows 10 のみをサポートする必要がある場合は、ユニバーサル 8.1 アプリのソース コードに含まれている多数の条件付きコンパイル ディレクティブを削除できます。このトピックの「条件付きコンパイルとアダプティブ コード」をご覧ください。
  • 一部のデバイス ファミリでのみ利用できる機能 (プリンター、スキャナー、カメラのボタンなど) を使うには、アダプティブ コードを記述します。このトピックの「条件付きコンパイルとアダプティブ コード」に記載されている 3 番目の例をご覧ください。
  • Windows 8.1、Windows Phone 8.1、および Windows 10 をサポートする必要がある場合は、3 つのプロジェクトを同じソリューション内に保持し、共有プロジェクトを使ってコードを共有することができます。また、プロジェクト間でソース コード ファイルを共有することもできます。そのためには、Visual Studio のソリューション エクスプローラーでプロジェクトを右クリックし、[既存項目の追加] を選び、共有するファイルを選んで、[リンクとして追加] をクリックします。リンクしたプロジェクトを確認できるファイル システム上の共通のフォルダーにソース コード ファイルを格納します。また、ソース コントロールに追加することを忘れないでください。
  • ソース コード レベルではなくバイナリ レベルでの再利用については、「C# および Visual Basic での Windows ランタイム コンポーネントの作成」をご覧ください。また、Windows 8.1、Windows Phone 8.1、Windows 10 (.NET Core) の各アプリ用の .NET Framework で利用できる .NET API のサブセットやフル バージョンの .NET Framework をサポートするポータブル クラス ライブラリがあります。ポータブル クラス ライブラリ アセンブリは、これらのプラットフォームすべてとバイナリ レベルで互換性があります。Visual Studio を使って、ポータブル クラス ライブラリをターゲットとするプロジェクトを作成します。「汎用性のあるクラス ライブラリを使用したプラットフォーム間の開発」をご覧ください。

拡張 SDK

ユニバーサル 8.1 アプリによって呼び出されている Windows ランタイム API のほとんどは、ユニバーサル デバイス ファミリと呼ばれる API のセットに実装されています。ただし、一部の API は拡張 SDK に実装されており、Visual Studio で認識されるのは、アプリのターゲット デバイス ファミリによって実装された API、または参照している拡張 SDK によって実装された API のみです。

検出できなかった名前空間、型、メンバーについてのコンパイル エラーが発生した場合は、上記のことが原因となる可能性があります。API リファレンス ドキュメントで API のトピックを表示し、要件に関するセクションに移動します。このセクションでは、どのようなデバイス ファミリ が API を実装するかが示されています。ターゲット デバイス ファミリが示されていない場合は、プロジェクトで API を利用できるようにするために、そのデバイス ファミリ用の拡張 SDK に対する参照が必要になります。

[プロジェクト]、[参照の追加]、[Windows Universal] (Windows ユニバーサル)、[拡張機能] の順にクリックし、適切な拡張 SDK を選びます。たとえば、呼び出す API がモバイル デバイス ファミリでのみ利用可能であり、それらの API がバージョン 10.0.x.y で導入されている場合は、[Microsoft Mobile Extension SDK for Universal App Platform 10.0.x.y] (ユニバーサル アプリ プラットフォーム 10.0.x.y 用 Microsoft Mobile Extension SDK) を選びます。

これにより、次の参照がプロジェクト ファイルに追加されます。

<ItemGroup>
    <SDKReference Include="WindowsMobile, Version=10.0.x.y">
        <Name>Microsoft Mobile Extension SDK for Universal App Platform</Name>
    </SDKReference>
</ItemGroup>

名前とバージョン番号は、SDK がインストールされている場所にあるフォルダーと一致します。たとえば、上記の情報は次のフォルダー名と一致します。

\Program Files (x86)\Windows Kits\10\Extension SDKs\WindowsMobile\10.0.x.y

API を実装するデバイス ファミリがアプリのターゲットではない場合は、ApiInformation クラスを使って、API を呼び出す前に API の有無をテストする必要があります (これはアダプティブ コードと呼ばれます)。このテストの条件は、アプリの実行時に必ず評価されますが、API が存在するデバイスに対してのみ true と評価され、呼び出しが可能になります。ユニバーサル API が存在するかどうかを最初に確認した後では、拡張 SDK とアダプティブ コードのみを使います。次のセクションで、例をいくつか示します。

「アプリ パッケージ マニフェスト」もご覧ください。

条件付きコンパイルとアダプティブ コード

コード ファイルが Windows 8.1 と Windows Phone 8.1 の両方で動作するように、条件付きコンパイル (C# プリプロセッサ ディレクティブによる条件付きコンパイル) を使っている場合は、Windows 10 に対して実行される集約作業を考慮して、その条件付きコンパイルを確認できます。この集約作業では、Windows 10 アプリで、いくつかの条件を完全に削除できることを意味します。削除されない条件は、次に説明するように実行時チェックに変更します。

注  1 つのコード ファイルで Windows 8.1、Windows Phone 8.1、Windows 10 をサポートする場合も、同様の確認作業を実行できます。プロジェクト プロパティ ページで Windows 10 プロジェクトを確認すると、プロジェクトでは条件付きコンパイル シンボルとして WINDOWS_UAP が定義されていることがわかります。このため、このシンボルを WINDOWS_APP や WINDOWS_PHONE_APP と組み合わせて使うことができます。次の例では、ユニバーサル 8.1 アプリから条件付きコンパイルを削除し、Windows 10 アプリ用の同等のコードで置き換えるシンプルなケースを紹介します。

最初の例では、PickSingleFileAsync API (Windows 8.1 にのみ適用) と PickSingleFileAndContinue API (Windows Phone 8.1 にのみ適用) の使用パターンを示しています。

#if WINDOWS_APP
    // use Windows.Storage.Pickers.FileOpenPicker.PickSingleFileAsync
#else
    // use Windows.Storage.Pickers.FileOpenPicker.PickSingleFileAndContinue
#endif // WINDOWS_APP

Windows 10 では、PickSingleFileAsync API に集約され、次のようにコードが簡略化されます。

    // use Windows.Storage.Pickers.FileOpenPicker.PickSingleFileAsync

次の例では、ハードウェアの "戻る" ボタンを処理しますが、Windows Phone のみが対象となります。

#if WINDOWS_PHONE_APP
        Windows.Phone.UI.Input.HardwareButtons.BackPressed += this.HardwareButtons_BackPressed;
#endif // WINDOWS_PHONE_APP

...

#if WINDOWS_PHONE_APP
    void HardwareButtons_BackPressed(object sender, Windows.Phone.UI.Input.BackPressedEventArgs e)
    {
        // handle the event.
    }
#endif // WINDOWS_PHONE_APP

Windows 10 では、"戻る" ボタンのイベントはユニバーサルな概念です。ハードウェアまたはソフトウェアに実装されているすべての "戻る" ボタンでは BackRequested イベントが発生するため、このイベントを処理します。

        Windows.UI.Core.SystemNavigationManager.GetForCurrentView().BackRequested +=
            this.ViewModelLocator_BackRequested;

...

    private void ViewModelLocator_BackRequested(object sender, Windows.UI.Core.BackRequestedEventArgs e)
    {
        // handle the event.
    }

最後の例は、前の例に類似しています。ここでは、ハードウェアの "カメラ" ボタンを処理しますが、この場合も Windows Phone アプリ パッケージにコンパイルされるコードのみが対象となります。

#if WINDOWS_PHONE_APP
        Windows.Phone.UI.Input.HardwareButtons.CameraPressed += this.HardwareButtons_CameraPressed;
#endif // WINDOWS_PHONE_APP

...

#if WINDOWS_PHONE_APP
    void HardwareButtons_CameraPressed(object sender, Windows.Phone.UI.Input.CameraEventArgs e)
    {
        // handle the event.
    }
#endif // WINDOWS_PHONE_APP

Windows 10 では、ハードウェアの "カメラ" ボタンはモバイル デバイス ファミリに固有の概念です。1 つのアプリ パッケージがすべてのデバイスで実行されるため、アダプティブ コードと呼ばれる手法を使って、コンパイル時の条件を実行時の条件に変更します。そのためには、ApiInformation クラスを使って、実行時に HardwareButtons クラスの有無を照会します。HardwareButtons は、モバイル拡張 SDK で定義されているため、その SDK への参照をプロジェクトに追加して、このコードをコンパイルする必要があります。ただし、ハンドラーはモバイル拡張 SDK で定義されている型を実装するデバイスでのみ実行されることに注意してください。このようなデバイスは、モバイル デバイス ファミリに該当します。このコードは事実上ユニバーサル 8.1 コードと同等のコードとなるため、このコードでは存在する機能のみを使うように注意してください。これは、別の方法で実施することもできます。

        // note, cache the value instead of querying it more than once.
        bool isHardwareButtonsAPIPresent = Windows.Foundation.Metadata.ApiInformation.IsTypePresent
            ("Windows.Phone.UI.Input.HardwareButtons");

        if (isHardwareButtonsAPIPresent)
        {
            Windows.Phone.UI.Input.HardwareButtons.CameraPressed +=
                this.HardwareButtons_CameraPressed;
        }

    ...

    private void HardwareButtons_CameraPressed(object sender, Windows.Phone.UI.Input.CameraEventArgs e)
    {
        // handle the event.
    }

「アプリが実行されているプラットフォームの検出」もご覧ください。

アプリ パッケージ マニフェスト

「Windows 10 の変更点」トピックには、Windows 10 のパッケージ マニフェスト スキーマ リファレンスに対する変更点 (追加、削除、変更された要素など) が記載されています。このスキーマのすべての要素、属性、タイプに関するリファレンス情報については、「要素の階層」をご覧ください。Windows Phone ストア アプリを移植する場合は、移植先のアプリ マニフェスト内の pm:PhoneIdentity 要素が、移植元のアプリのアプリ マニフェスト内の要素と一致していることを確認してください (詳しくは、「pm:PhoneIdentity」トピックをご覧ください)。

プロジェクトの設定 (すべての拡張 SDK の参照を含む) により、アプリが呼び出すことができる API サーフェイス領域が決定されます。ただし、ユーザーがアプリをストアからインストールできる実際のデバイスのセットを決定するのは、アプリ パッケージ マニフェストです。詳しくは、「TargetDeviceFamily」の例をご覧ください。

さまざまな宣言、機能、および一部の機能で必要となる他の設定を指定するように、アプリ パッケージ マニフェストを編集できます。Visual Studio アプリ パッケージ マニフェスト エディターを使って、編集できます。ソリューション エクスプローラーが表示されていない場合は、[表示] メニューから選択します。[Package.appxmanifest] をダブルクリックします。マニフェスト エディター ウィンドウが開きます。変更する適切なタブを選び、保存します。

次のトピックはトラブルシューティングです。

関連トピック

ユニバーサル Windows プラットフォーム用アプリの開発

テンプレート (C#、C++、Visual Basic) を使った Windows ストア アプリ開発に着手する

Windows ランタイム コンポーネントの作成

Cross-Platform Development with the Portable Class Library (.NET Framework を使用したプラットフォーム間の開発)