Xamarin で C/C++ ライブラリを使用する

[アーティクル]
07/19/2023

概要

Xamarin を使用すると、開発者は Visual Studio でクロスプラットフォームのネイティブモバイルアプリを作成できます。一般的に、C# バインドは、既存のプラットフォームコンポーネントを開発者に公開するために使用されます。しかし、Xamarin アプリで既存のコードベースを使用することが必要な場合もあります。チームには、十分にテストされて高度に最適化された大規模なコードベースを C# に移植するための時間、予算、リソースがない場合があります。

クロスプラットフォームのモバイル開発用の Visual C++ を使用すると、C/C++ と C# コードを同じソリューションの一部としてビルドできるため、統合されたデバッグエクスペリエンスなどの多くの利点が得られます。 Microsoft は、Hyperlapse Mobile や Pix カメラなどのアプリを配信するために、このように C/C++ と Xamarin を使用してきました。

ただし、場合によっては、既存の C/C++ のツールとプロセスを保持し、ライブラリコードをアプリケーションから切り離して、ライブラリをサードパーティ製のコンポーネントと同様に扱うことが望ましい (あるいは必要になる) ことがあります。このような状況では、関連するメンバーを C# に公開するだけでなく、ライブラリを依存関係として管理することも困難です。そしてもちろん、このプロセスを可能な限り自動化することも該当します。

この記事では、このシナリオの大まかなアプローチについて概説し、簡単な例を紹介します。

背景

C/C++ はクロスプラットフォーム言語と見なされていますが、ソースコードが実際にクロスプラットフォームになっているようにするために、十分な注意が必要です。つまり、すべてのターゲットコンパイラでサポートされている C/C++ のみを使用し、条件付きで含まれるプラットフォームまたはコンパイラに固有のコードがほとんどないか、あるいはまったくないようにします。

最終的には、コードはすべてのターゲットプラットフォームでコンパイルして正常に実行する必要があります。したがってこれは、ターゲットプラットフォーム (およびコンパイラ) 全体での共通事項に帰結します。コンパイラ間のわずかな違いから問題が発生する可能性があるため、各ターゲットプラットフォームでの (可能であれば自動化による) 徹底的なテストがますます重要になります。

上位レベルのアプローチ

次の図は、C/C++ ソースコードをクロスプラットフォームの Xamarin ライブラリに変換し、それを NuGet 経由で共有して Xamarin.Forms アプリで使用するための、4 つのステージからなるアプローチを示しています。

High-level approach for using C/C++ with Xamarin

4 つのステージは以下のとおりです。

C/C++ ソースコードをプラットフォーム固有のネイティブライブラリにコンパイルする。
Visual Studio ソリューションでネイティブライブラリをラップする。
.NET ラッパー用の NuGet パッケージをパッキングおよびプッシュする。
NuGet パッケージを Xamarin アプリから使用する。

ステージ 1:C/C++ ソースコードをプラットフォーム固有のネイティブライブラリにコンパイルする

このステージの目標は、 C# ラッパーによって呼び出すことができるネイティブライブラリを作成することです。これは、状況によっては関連性がない場合もあります。この一般的なシナリオで使用できる多くのツールとプロセスについては、この記事では取り上げません。重要な考慮事項は、C/C++ コードベースをあらゆるネイティブラッパーコードと同期させること、十分な単体テスト、およびビルドの自動化です。

このチュートリアルのライブラリは、Visual Studio Code および付属のシェルスクリプトを使用して作成されました。このチュートリアルの拡張バージョンについては、サンプルのこの部分について詳しく説明している Mobile CAT GitHub リポジトリに関する記事を参照してください。この場合、ネイティブライブラリはサードパーティの依存関係として扱われますが、このステージはコンテキストのために示しています。

わかりやすくするために、このチュートリアルではアーキテクチャのサブセットのみを対象としています。 iOS では lipo ユーティリティを使用して、アーキテクチャ固有の個々のバイナリから 1 つの FAT バイナリを作成します。 Android では .so 拡張子の動的バイナリが使用され、iOS では .a 拡張子の静的 FAT バイナリが使用されます。

ステージ 2:Visual Studio ソリューションでネイティブライブラリをラップする

次のステージでは、ネイティブライブラリをラップして、.NET から簡単に使用できるようにします。これは、4 つのプロジェクトを含む Visual Studio ソリューションで行います。共有プロジェクトには、共通のコードが含まれています。 Xamarin.Android、Xamarin.iOS、および .NET Standard のそれぞれを対象とするプロジェクトでは、プラットフォームに依存しない方法でライブラリを参照できます。

このラッパーには、"bait and switch trick" が使用されています。これは唯一の方法ではありませんが、ライブラリを簡単に参照できるようになり、使用する側のアプリケーション自体でプラットフォーム固有の実装を明示的に管理する必要がなくなります。このテクニックでは基本的に、複数のターゲット (.NET Standard、Android、iOS) が同じ名前空間、アセンブリ名、およびクラス構造を共有するようにします。 NuGet は常にプラットフォーム固有のライブラリを優先して使用するため、実行時に .NET Standard バージョンが使用されることはありません。

この手順での作業の大部分は、P/Invoke を使用してネイティブライブラリメソッドを呼び出し、基になるオブジェクトへの参照を管理することに焦点を当てます。目標は、ライブラリの機能をコンシューマーに公開しながら、複雑なものを抽象化することです。 Xamarin.Forms の開発者は、アンマネージライブラリの内部動作に関する実用的な知識を持っている必要はありません。一般的なマネージド C# ライブラリを使用しているかのように感じられるはずです。

最終的に、このステージの成果物は、ターゲットごとに 1 つの .NET ライブラリのセットと、次の手順でパッケージをビルドするために必要な情報を含む nuspec ドキュメントです。

ステージ 3:.NET ラッパー用の NuGet パッケージをパッキングおよびプッシュする

3 番目のステージでは、前の手順で作成したビルド成果物を使用して NuGet パッケージを作成します。この手順の成果物は、Xamarin アプリから使用できる NuGet パッケージです。このチュートリアルでは、NuGet フィードとして機能するローカルディレクトリを使用します。運用環境では、この手順でパブリックまたはプライベートの NuGet フィードにパッケージを公開する必要があり、この手順は完全に自動化される必要があります。

ステージ 4:NuGet パッケージを Xamarin.Forms アプリから使用する

最後の手順は、Xamarin.Forms アプリから NuGet パッケージを参照して使用することです。これを行うには、前の手順で定義したフィードを使用するように Visual Studio で NuGet フィードを構成する必要があります。

フィードが構成されたら、クロスプラットフォームの Xamarin.Forms アプリの各プロジェクトからパッケージが参照される必要があります。 "bait-and-switch trick" は同一のインターフェイスを提供するため、1 つの場所で定義されたコードを使用してネイティブライブラリ機能を呼び出すことができます。

ソースコードリポジトリには、Azure DevOps にプライベート NuGet フィードを設定する方法と、そのフィードにパッケージをプッシュする方法に関する記事を含む、参考資料の一覧が含まれています。この種類のフィードは、ローカルディレクトリよりも多少設定に時間がかかりますが、チーム開発環境に適しています。

チュートリアル

ここで説明する手順は Visual Studio for Mac に固有のものですが、その構造は Visual Studio 2017 でも機能します。

前提条件

これに従うには、開発者には次のものが必要です。

Note

アプリを iPhone にデプロイするには、アクティブな Apple Developer アカウントが必要です。

ネイティブライブラリの作成 (ステージ 1)

ネイティブライブラリの機能は、「チュートリアル:スタティックライブラリの作成と使用 (C++)」の例に基づいています。

このチュートリアルでは、最初のステージであるネイティブライブラリのビルドをスキップします。これは、このシナリオではライブラリがサードパーティの依存関係として提供されているためです。プリコンパイル済みネイティブライブラリはサンプルコードに付属していますが、直接ダウンロードすることもできます。

ネイティブライブラリの操作

元の MathFuncsLib のサンプルには、次の定義を持つ MyMathFuncs という 1 つのクラスが含まれています。

namespace MathFuncs
{
    class MyMathFuncs
    {
    public:
        double Add(double a, double b);
        double Subtract(double a, double b);
        double Multiply(double a, double b);
        double Divide(double a, double b);
    };
}

追加のクラスでは、基礎となるネイティブ MyMathFuncs クラスを .NET コンシューマーが作成、破棄、および操作できるようにするラッパー関数を定義します。

#include "MyMathFuncs.h"
using namespace MathFuncs;

extern "C" {
    MyMathFuncs* CreateMyMathFuncsClass();
    void DisposeMyMathFuncsClass(MyMathFuncs* ptr);
    double MyMathFuncsAdd(MyMathFuncs *ptr, double a, double b);
    double MyMathFuncsSubtract(MyMathFuncs *ptr, double a, double b);
    double MyMathFuncsMultiply(MyMathFuncs *ptr, double a, double b);
    double MyMathFuncsDivide(MyMathFuncs *ptr, double a, double b);
}

Xamarin 側では、これらのラッパー関数が使用されます。

ネイティブライブラリのラップ (ステージ 2)

このステージでは、前のセクションで説明したプリコンパイル済みライブラリが必要です。

Visual Studio ソリューションの作成

Visual Studio for Mac で、 [新しいプロジェクト] (ウェルカムページから) または [新しいソリューション] ( [ファイル] メニューから) をクリックします。
[新しいプロジェクト] ウィンドウで、[共有プロジェクト] ("[マルチプラットフォーム] > [ライブラリ]" から) を選び、[次へ] をクリックします。
次のフィールドを更新し、 [作成] をクリックします。
- [プロジェクト名]: MathFuncs.Shared
- [ソリューション名]: MathFuncs
- [場所]: 既定の保存場所を使用します (または別のものを選択します)
- [ソリューションディレクトリ内にプロジェクトディレクトリを作成する]: これをオンに設定します
[ソリューションエクスプローラー] で、MathFuncs.Shared プロジェクトをダブルクリックし、 [メイン設定] に移動します。
.Shared を [既定の名前空間] から削除して、MathFuncs のみが設定されるようにし、 [OK] をクリックします。
テンプレートによって作成された MyClass.cs を開き、クラスとファイル名の両方を MyMathFuncsWrapper に変更し、名前空間を MathFuncs に変更します。
ソリューション MathFuncs を Ctrl キーを押したままクリックし、 [追加] メニューから [新しいプロジェクトの追加...] を選択します。
[新しいプロジェクト] ウィンドウで、[.NET Standard ライブラリ] ("[マルチプラットフォーム] > [ライブラリ]" から) を選び、[次へ] をクリックします。
[.NET Standard 2.0] を選択し、 [次へ] を選択します。
次のフィールドを更新し、 [作成] をクリックします。
- [プロジェクト名]: MathFuncs.Standard
- [場所]: 共有プロジェクトと同じ保存場所を使用します
[ソリューションエクスプローラー] で、MathFuncs.Standard プロジェクトをダブルクリックします。
[メイン設定] に移動し、 [既定の名前空間] を [MathFuncs] に更新します。
[出力] 設定に移動し、 [アセンブリ名] を [MathFuncs] に更新します。
[コンパイラ] 設定に移動し、 [構成] を [リリース] に変更し、 [デバッグ情報] を [シンボルのみ] に設定し、 [OK] をクリックします。
プロジェクトから [Class1.cs]/[Getting Started](はじめに) を削除します (これらのいずれかがテンプレートの一部として含まれている場合)。
プロジェクトの [依存関係]/[参照設定] フォルダーを Ctrl キーを押したままクリックし、 [参照の編集] を選択します。
[プロジェクト] タブの [MathFuncs.Shared] を選択し、 [OK] をクリックします。

次の構成を使用して、手順 7 から 17 を繰り返します (手順 9 は無視します) 。

プロジェクト名	テンプレート名	新しいプロジェクトメニュー
MathFuncs.Android	クラスライブラリ	Android > ライブラリ
MathFuncs.iOS	バインドライブラリ	iOS > ライブラリ

[ソリューションエクスプローラー] で、MathFuncs.Android プロジェクトをダブルクリックし、 [コンパイラ] 設定に移動します。
[構成] を [デバッグ] に設定して、 [Define Symbols](シンボルを定義) を編集して [Android;] を含めます。
同様に、 [構成] を [リリース] に変更して、 [Define Symbols](シンボルを定義) を編集して [Android;] を含めます。
MathFuncs.iOS に対して手順 19 と 20 を繰り返します。どちらの場合も、 [Define Symbols](シンボルを定義) を編集して [Android;] ではなく [iOS;] を含めます。
[Release] 構成でソリューションをビルドし (Ctrl キー + COMMAND キー + B キー) 、(それぞれのプロジェクトの bin フォルダーにある) 3 つのすべての出力アセンブリ (Android、iOS、.NET Standard) で同じ名前 MathFuncs.dll が共有されていることを確認します。

このステージでは、このソリューションには 3 つのターゲット (Android、iOS、.NET Standard 用に 1 つずつ) と、その 3 つのターゲットそれぞれが参照する共有プロジェクトがあります。これらは、同じ既定の名前空間と出力アセンブリを同じ名前で使用するように構成する必要があります。これは、前述の "bait and switch" アプローチに必要です。

ネイティブライブラリの追加

ラッパーソリューションにネイティブライブラリを追加するプロセスは、Android と iOS では多少異なります。

MathFuncs.Android に対するネイティブ参照

MathFuncs.Android プロジェクトを Ctrl キーを押したままクリックし、 [追加] メニューから [新しいフォルダー] を選択して lib という名前を付けます。
それぞれの ABI (アプリケーションバイナリインターフェイス) について、lib フォルダーを Ctrl キーを押したままクリックし、 [追加] メニューから [新しいフォルダー] を選択して、それぞれの ABI に関連した名前を付けます。この場合、次のようになります。
- arm64-v8a
- armeabi-v7a
- x86
- x86_64
Note

より詳細な概要については、NDK 開発者ガイドの「アーキテクチャと CPU」のトピック、特にアプリパッケージでのネイティブコードについて説明されているセクションを参照してください。

フォルダー構造を確認します。

- lib
    - arm64-v8a
    - armeabi-v7a
    - x86
    - x86_64

次のマッピングに基づいて、対応する .so ライブラリをそれぞれの ABI フォルダーに追加します。

arm64-v8a: lib/Android/arm64

armeabi-v7a: lib/Android/arm

x86: lib/Android/x86

x86_64: lib/Android/x86_64

Note

ファイルを追加するには、それぞれの ABI を表すフォルダーを Ctrl キーを押したままクリックし、 [追加] メニューから [ファイルの追加...] を選択します。適切なライブラリを (PrecompiledLibs ディレクトリから) 選択し、 [Open](開く) 、 [OK] の順にクリックし、既定のオプションの [ファイルをディレクトリにコピーする] のままにします。
各 .so ファイルに対して Ctrl キーを押したままクリックし、 [ビルドアクション] メニューから [EmbeddedNativeLibrary] オプションを選択します。

これで、lib フォルダーは次のようになります。

- lib
    - arm64-v8a
        - libMathFuncs.so
    - armeabi-v7a
        - libMathFuncs.so
    - x86
        - libMathFuncs.so
    - x86_64
        - libMathFuncs.so

MathFuncs.iOS に対するネイティブ参照

MathFuncs.iOS プロジェクトを Ctrl キーを押したままクリックし、 [追加] メニューから [ネイティブ参照の追加] を選択します。
libMathFuncs.a ライブラリを (PrecompiledLibs ディレクトリの libs/ios から) 選択し、 [Open](開く) をクリックします
libMathFuncs ファイル ( [ネイティブ参照] フォルダー内) を Ctrl キーを押したままクリックし、メニューから [プロパティ] オプションを選択します
[ネイティブ参照] プロパティを構成して、それらが [Properties] Pad でチェックされる (チェックマークアイコンが表示される) ようにします。
- 強制読み込み
- C++
- スマートリンク
Note

バインドライブラリプロジェクトの種類とネイティブ参照を一緒に使用すると、スタティックライブラリが埋め込まれ、(NuGet パッケージでこれが含まれている場合であっても) これを参照する Xamarin.iOS アプリと自動的にリンクできるようになります。
ApiDefinition.cs を開き、テンプレート化されたコメントコードを削除 (MathFuncs 名前空間のみを残す) してから、Structs.cs に対して同じ手順を実行します

Note

バインドライブラリプロジェクトでは、ビルドするためにこれらのファイル (ObjCBindingApiDefinition と ObjCBindingCoreSource ビルドアクションを使用) が必要です。しかしここでは、ネイティブライブラリを呼び出すコードを、これらのファイルの外部で、標準の P/Invoke を使用して Android と iOS の両方のライブラリターゲットで共有できるように記述します。

マネージドライブラリコードの記述

次に、ネイティブライブラリを呼び出す C# コードを記述します。目標は、根底にある複雑さを隠すことです。コンシューマーがネイティブライブラリの内部構造や P/Invoke の概念に関する実用的な知識を持たなくても済むようにします。

SafeHandle の作成

MathFuncs.Shared プロジェクトを Ctrl キーを押したままクリックし、 [追加] メニューから [ファイルの追加...] を選択します。
[新しいファイル] ウィンドウで [空のクラス] を選択し、MyMathFuncsSafeHandle という名前を指定して、 [New](新規作成) をクリックします
MyMathFuncsSafeHandle クラスを実装します。
```
using System;
using Microsoft.Win32.SafeHandles;

namespace MathFuncs
{
    internal class MyMathFuncsSafeHandle : SafeHandleZeroOrMinusOneIsInvalid
    {
        public MyMathFuncsSafeHandle() : base(true) { }

        public IntPtr Ptr => handle;

        protected override bool ReleaseHandle()
        {
            // TODO: Release the handle here
            return true;
        }
    }
}
```
Note

マネージドコードでアンマネージリソースを操作するには、SafeHandle を使用することをお勧めします。これにより、クリティカルファイナライズとオブジェクトのライフサイクルに関連する多数の定型コードが抽象化されます。このハンドルの所有者は、これを後で他の管理対象リソースと同様に扱うことができ、完全な Dispose パターンを実装する必要はありません。

内部ラッパークラスの作成

MyMathFuncsWrapper.cs を開き、それを内部静的クラスに変更します

namespace MathFuncs
{
    internal static class MyMathFuncsWrapper
    {
    }
}

同じファイル内で、次の条件付きステートメントをクラスに追加します。
```
#if Android
    const string DllName = "libMathFuncs.so";
#else
    const string DllName = "__Internal";
#endif
```
Note

これにより、ライブラリのビルド対象が Android か iOS かに基づいて、DllName 定数値が設定されます。これは、それぞれのプラットフォームで使用される異なる名前付け規則に対処するためだけでなく、この場合に使用されるライブラリの種類にも対処するためです。 Android はダイナミックライブラリを使用するため、拡張子を含むファイル名が必要です。 iOS の場合はスタティックライブラリを使用するため、' __Internal' が必要です。
MyMathFuncsWrapper.cs ファイルの先頭に System.Runtime.InteropServices への参照を追加します
```
using System.Runtime.InteropServices;
```
MyMathFuncs クラスの作成と破棄を処理するラッパーメソッドを追加します。
```
[DllImport(DllName, EntryPoint = "CreateMyMathFuncsClass")]
internal static extern MyMathFuncsSafeHandle CreateMyMathFuncs();

[DllImport(DllName, EntryPoint = "DisposeMyMathFuncsClass")]
internal static extern void DisposeMyMathFuncs(MyMathFuncsSafeHandle ptr);
```
Note

.NET ランタイムにそのライブラリ内で呼び出す関数の名前を明示的に指示する EntryPoint とともに、定数 DllName を DllImport 属性に渡します。技術的には、マネージドメソッド名がアンマネージメソッド名と同一である場合、EntryPoint 値を指定する必要はありません。指定されていない場合は、マネージドメソッド名が EntryPoint として代わりに使用されます。ただし、明示的なものにすることをお勧めします。
次のコードを使用して、MyMathFuncs クラスを操作できるようにするラッパーメソッドを追加します。
```
[DllImport(DllName, EntryPoint = "MyMathFuncsAdd")]
internal static extern double Add(MyMathFuncsSafeHandle ptr, double a, double b);

[DllImport(DllName, EntryPoint = "MyMathFuncsSubtract")]
internal static extern double Subtract(MyMathFuncsSafeHandle ptr, double a, double b);

[DllImport(DllName, EntryPoint = "MyMathFuncsMultiply")]
internal static extern double Multiply(MyMathFuncsSafeHandle ptr, double a, double b);

[DllImport(DllName, EntryPoint = "MyMathFuncsDivide")]
internal static extern double Divide(MyMathFuncsSafeHandle ptr, double a, double b);
```
Note

この例では、パラメーターに単純型を使用しています。この場合、マーシャリングはビットごとのコピーであるため、追加の作業は必要ありません。また、標準の IntPtrではなく、MyMathFuncsSafeHandle クラスを使用することにも注意してください。 IntPtr は、マーシャリングプロセスの一部として、SafeHandle に自動的にマップされます。

完成した MyMathFuncsWrapper クラスが次のように表示されることを確認します。

using System.Runtime.InteropServices;

namespace MathFuncs
{
    internal static class MyMathFuncsWrapper
    {
        #if Android
            const string DllName = "libMathFuncs.so";
        #else
            const string DllName = "__Internal";
        #endif

        [DllImport(DllName, EntryPoint = "CreateMyMathFuncsClass")]
        internal static extern MyMathFuncsSafeHandle CreateMyMathFuncs();

        [DllImport(DllName, EntryPoint = "DisposeMyMathFuncsClass")]
        internal static extern void DisposeMyMathFuncs(MyMathFuncsSafeHandle ptr);

        [DllImport(DllName, EntryPoint = "MyMathFuncsAdd")]
        internal static extern double Add(MyMathFuncsSafeHandle ptr, double a, double b);

        [DllImport(DllName, EntryPoint = "MyMathFuncsSubtract")]
        internal static extern double Subtract(MyMathFuncsSafeHandle ptr, double a, double b);

        [DllImport(DllName, EntryPoint = "MyMathFuncsMultiply")]
        internal static extern double Multiply(MyMathFuncsSafeHandle ptr, double a, double b);

        [DllImport(DllName, EntryPoint = "MyMathFuncsDivide")]
        internal static extern double Divide(MyMathFuncsSafeHandle ptr, double a, double b);
    }
}

MyMathFuncsSafeHandle クラスの完成

MyMathFuncsSafeHandle クラスを開き、ReleaseHandle メソッド内のプレースホルダー TODO コメントに移動します。
```
// TODO: Release the handle here
```

TODO 行を次のように置き換えます。

MyMathFuncsWrapper.DisposeMyMathFuncs(this);

MyMathFuncs クラスの記述

ラッパーが完成したので、アンマネージ C++ の MyMathFuncs オブジェクトへの参照を管理する MyMathFuncs クラスを作成します。

MathFuncs.Shared プロジェクトを Ctrl キーを押したままクリックし、 [追加] メニューから [ファイルの追加...] を選択します。
[新しいファイル] ウィンドウで [空のクラス] を選択し、MyMathFuncs という名前を指定して、 [New](新規作成) をクリックします
次のメンバーを MyMathFuncs クラスに追加します。
```
readonly MyMathFuncsSafeHandle handle;
```
クラスのコンストラクターを実装して、クラスがインスタンス化されるときにネイティブの MyMathFuncs オブジェクトへのハンドルを作成して格納するようにします。
```
public MyMathFuncs()
{
    handle = MyMathFuncsWrapper.CreateMyMathFuncs();
}
```

次のコードを使用して、IDisposable インターフェイスを実装します。

public class MyMathFuncs : IDisposable
{
    ...

    protected virtual void Dispose(bool disposing)
    {
        if (handle != null && !handle.IsInvalid)
            handle.Dispose();
    }

    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    // ...
}

MyMathFuncsWrapper クラスを使用して MyMathFuncs メソッドを実装し、格納したポインターを基底のアンマネージオブジェクトに渡すことによって、内部で実際の作業を実行します。コードは次のようになります。

public double Add(double a, double b)
{
    return MyMathFuncsWrapper.Add(handle, a, b);
}

public double Subtract(double a, double b)
{
    return MyMathFuncsWrapper.Subtract(handle, a, b);
}

public double Multiply(double a, double b)
{
    return MyMathFuncsWrapper.Multiply(handle, a, b);
}

public double Divide(double a, double b)
{
    return MyMathFuncsWrapper.Divide(handle, a, b);
}

nuspec の作成

NuGet を使用してライブラリをパッケージ化して配布するには、ソリューションに nuspec ファイルが必要です。これにより、サポートされている各プラットフォームに対して組み込まれるアセンブリが特定されます。

MathFuncs ソリューションを Ctrl キーを押したままクリックし、 [追加] メニューから [Add Solution Folder](ソリューションフォルダーの追加) を選択して、SolutionItems という名前を付けます。
SolutionItems フォルダーを Ctrl キーを押したままクリックし、 [追加] メニューから [新しいファイル...] を選択します。
[新しいファイル] ウィンドウで [空の XML ファイル] を選択し、MathFuncs.nuspec という名前を指定して、 [New](新規作成) をクリックします。

NuGet コンシューマーに表示される基本的なパッケージメタデータを使用して、MathFuncs.nuspec を更新します。次に例を示します。

<?xml version="1.0"?>
<package>
    <metadata>
        <id>MathFuncs</id>
        <version>$version$</version>
        <authors>Microsoft Mobile Customer Advisory Team</authors>
        <description>Sample C++ Wrapper Library</description>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <copyright>Copyright 2018</copyright>
    </metadata>
</package>

注意

このマニフェストに使用されるスキーマの詳細については、nuspec リファレンスのドキュメントを参照してください。

<package> 要素の子として <files> 要素を追加し (<metadata> のすぐ下)、各ファイルを個別の <file> 要素で識別します。
```
<files>

    

    

    

</files>
```
Note

パッケージがプロジェクトにインストールされ、同じ名前で複数のアセンブリが指定されている場合、NuGet は、特定のプラットフォームに最も特化したアセンブリを効率的に選択します。

Android アセンブリ用の <file> 要素を追加します。

<file src="MathFuncs.Android/bin/Release/MathFuncs.dll" target="lib/MonoAndroid81/MathFuncs.dll" />
<file src="MathFuncs.Android/bin/Release/MathFuncs.pdb" target="lib/MonoAndroid81/MathFuncs.pdb" />

iOS アセンブリ用の <file> 要素を追加します。

<file src="MathFuncs.iOS/bin/Release/MathFuncs.dll" target="lib/Xamarin.iOS10/MathFuncs.dll" />
<file src="MathFuncs.iOS/bin/Release/MathFuncs.pdb" target="lib/Xamarin.iOS10/MathFuncs.pdb" />

netstandard2.0 アセンブリ用の <file> 要素を追加します。

<file src="MathFuncs.Standard/bin/Release/netstandard2.0/MathFuncs.dll" target="lib/netstandard2.0/MathFuncs.dll" />
<file src="MathFuncs.Standard/bin/Release/netstandard2.0/MathFuncs.pdb" target="lib/netstandard2.0/MathFuncs.pdb" />

nuspec マニフェストを確認します。

<?xml version="1.0"?>
<package>
<metadata>
    <id>MathFuncs</id>
    <version>$version$</version>
    <authors>Microsoft Mobile Customer Advisory Team</authors>
    <description>Sample C++ Wrapper Library</description>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <copyright>Copyright 2018</copyright>
</metadata>
<files>

    <!-- Android -->
    <file src="MathFuncs.Android/bin/Release/MathFuncs.dll" target="lib/MonoAndroid81/MathFuncs.dll" />
    <file src="MathFuncs.Android/bin/Release/MathFuncs.pdb" target="lib/MonoAndroid81/MathFuncs.pdb" />

    <!-- iOS -->
    <file src="MathFuncs.iOS/bin/Release/MathFuncs.dll" target="lib/Xamarin.iOS10/MathFuncs.dll" />
    <file src="MathFuncs.iOS/bin/Release/MathFuncs.pdb" target="lib/Xamarin.iOS10/MathFuncs.pdb" />

    <!-- netstandard2.0 -->
    <file src="MathFuncs.Standard/bin/Release/netstandard2.0/MathFuncs.dll" target="lib/netstandard2.0/MathFuncs.dll" />
    <file src="MathFuncs.Standard/bin/Release/netstandard2.0/MathFuncs.pdb" target="lib/netstandard2.0/MathFuncs.pdb" />

</files>
</package>

Note

このファイルはリリース ビルドからのアセンブリ出力パスを指定します。そのため、その構成を使用してソリューションをビルドしてください。

この時点で、ソリューションには 3 つの .NET アセンブリと、サポートする nuspec マニフェストが含まれています。

NuGet を使用した .NET ラッパーの配布

次の手順では、NuGet パッケージをパッケージ化して配布することで、それをアプリで簡単に使用でき、依存関係として管理できるようにします。ラッピングと使用はすべて 1 つのソリューション内で行うことができますが、NuGet を使用してライブラリを配布することで分離が可能になり、これらのコードベースを個別に管理することができます。

ローカルパッケージディレクトリの準備

NuGet フィードの最も単純な形式は、ローカルディレクトリです。

Finder で、使いやすいディレクトリに移動します。たとえば、 /Users などです。
[ファイル] メニューから [新規フォルダー] を選択し、local-nuget-feed などのわかりやすい名前を指定します。

パッケージの作成

[ビルド構成] を [リリース] に設定し、COMMAND キーと B キーを使用してビルドを実行します。
[ターミナル] を開き、nuspec ファイルが格納されているフォルダーにディレクトリを変更します。
[ターミナル] で、nuspec ファイル、バージョン (1.0.0 など)、および OutputDirectory (前の手順で作成したフォルダー (つまり local-nuget-feed) を使用) を指定して nuget pack コマンドを実行します。次に例を示します。
```
nuget pack MathFuncs.nuspec -Version 1.0.0 -OutputDirectory ~/local-nuget-feed
```
local-nuget-feed ディレクトリに MathFuncs.1.0.0.nupkg が作成されていることを確認します。

[省略可能] Azure DevOps でのプライベート NuGet フィードの使用

より堅牢な手法については Azure DevOps での NuGet パッケージの使用に関する記事を参照してください。そこでは、プライベートフィードを作成し、(前の手順で生成した) パッケージをそのフィードにプッシュする方法が説明されています。

このワークフローは、たとえば Azure Pipelines などを使用して、完全に自動化することをお勧めします。詳細については、「Azure Pipelines の使用を開始する」を参照してください。

.NET ラッパーを Xamarin.Forms アプリから使用する

このチュートリアルを完了するには、ローカル NuGet フィードに公開されたばかりのパッケージを使用する Xamarin. Forms アプリを作成します。

Xamarin.Forms プロジェクトの作成

Visual Studio for Mac の新しいインスタンスを開きます。これは [ターミナル] から行うことができます。
```
open -n -a "Visual Studio"
```
Visual Studio for Mac で、 [新しいプロジェクト] (ウェルカムページから) または [新しいソリューション] ( [ファイル] メニューから) をクリックします。
[新しいプロジェクト] ウィンドウで、[空白フォームのアプリ] ("[マルチプラットフォーム] > [アプリ] から") を選び、[次へ] をクリックします。
次のフィールドを更新し、 [次へ] をクリックします。
- [アプリ名]: MathFuncsApp。
- [組織の識別子]: たとえば、com.{your_org} のように、逆引き名前空間を使用します。
- [ターゲットプラットフォーム]: 既定値 (Android と iOS の両方のターゲット) を使用します。
- [共有コード]: これを .NET Standard に設定します ("共有ライブラリ" ソリューションも可能ですが、このチュートリアルでは扱いません)。
次のフィールドを更新し、 [作成] をクリックします。
- [プロジェクト名]: MathFuncsApp。
- [ソリューション名]: MathFuncsApp。
- [場所]: 既定の保存場所を使用します (または別のものを選択します)。
ソリューションエクスプローラーで、最初のテストのターゲット (MathFuncsApp.Android または MathFuncs.iOS) をCtrl キーを押したままクリックし、 [スタートアッププロジェクトに設定] を選択します。
優先する デバイスまたは シミュレーター/エミュレーターを選択します。
ソリューションを実行し (COMMAND キー + RETURN キー)、テンプレート化された Xamarin.Forms プロジェクトがビルドされ、正常に実行されることを検証します。

Note

iOS (具体的にはシミュレーター) では、ビルド/デプロイ時間が最も速くなる傾向があります。

NuGet 構成へのローカル NuGet フィードの追加

Visual Studio で、(Visual Studio メニューから) [ユーザー設定] を選択します。
[NuGet] セクションで [ソース] を選択し、 [追加] をクリックします。
次のフィールドを更新し、 [変換元の追加] をクリックします。
- Name: わかりやすい名前 (たとえば Local-Packages) を指定します。
- [場所]:前の手順で作成した local-nuget-feed フォルダーを指定します。
Note

この場合、 [ユーザー名] と [パスワード] を指定する必要はありません。
[OK] をクリックします。

パッケージの参照

各プロジェクト (MathFuncsApp、MathFuncsApp.Android、MathFuncsApp.iOS) に対して、次の手順を繰り返します。

プロジェクトを Ctrl キーを押したままクリックし、 [追加] メニューから [NuGet パッケージの追加...] を選択します。
MathFuncs を検索します。
パッケージのバージョンが 1.0.0 であること、およびその他の詳細が期待どおりに表示されること (たとえば、 [タイトル] と [説明] が MathFuncs および Sample C++ Wrapper Librar であること) を確認します。
MathFuncs パッケージを選択し、 [パッケージの追加] をクリックします。

ライブラリ関数の使用

各プロジェクトでの MathFuncs パッケージへの参照により、関数を C# コードで使用できるようになりました。

MathFuncsApp の共通の Xamarin.Forms プロジェクト (MathFuncsApp.Android と MathFuncsApp.iOS の両方によって参照されるもの) から MainPage.xaml.cs を開きます。
そのファイルの先頭に、System.Diagnostics および MathFuncs の using ステートメントを追加します。
```
using System.Diagnostics;
using MathFuncs;
```
MainPage クラスの先頭で MyMathFuncs クラスのインスタンスを宣言します。
```
MyMathFuncs myMathFuncs;
```

ContentPage 基底クラスの OnAppearing および OnDisappearing メソッドをオーバーライドします。

protected override void OnAppearing()
{
    base.OnAppearing();
}

protected override void OnDisappearing()
{
    base.OnDisappearing();
}

前に宣言した myMathFuncs 変数を初期化するように OnAppearing メソッドを更新します。
```
protected override void OnAppearing()
{
    base.OnAppearing();
    myMathFuncs = new MyMathFuncs();
}
```
myMathFuncs の Dispose メソッドを呼び出すように OnDisappearing メソッドを更新します。
```
protected override void OnDisappearing()
{
    base.OnAppearing();
    myMathFuncs.Dispose();
}
```

次のように、TestMathFuncs というプライベートメソッドを実装します。

private void TestMathFuncs()
{
    var numberA = 1;
    var numberB = 2;

    // Test Add function
    var addResult = myMathFuncs.Add(numberA, numberB);

    // Test Subtract function
    var subtractResult = myMathFuncs.Subtract(numberA, numberB);

    // Test Multiply function
    var multiplyResult = myMathFuncs.Multiply(numberA, numberB);

    // Test Divide function
    var divideResult = myMathFuncs.Divide(numberA, numberB);

    // Output results
    Debug.WriteLine($"{numberA} + {numberB} = {addResult}");
    Debug.WriteLine($"{numberA} - {numberB} = {subtractResult}");
    Debug.WriteLine($"{numberA} * {numberB} = {multiplyResult}");
    Debug.WriteLine($"{numberA} / {numberB} = {divideResult}");
}

最後に、OnAppearing メソッドの最後で TestMathFuncs を呼び出します。
```
TestMathFuncs();
```
各ターゲットプラットフォームでアプリを実行し、 [アプリケーションの出力] パッドの出力が次のようになっていることを確認します。
```
1 + 2 = 3
1 - 2 = -1
1 * 2 = 2
1 / 2 = 0.5
```
Note

Android でのテスト時に 'DLLNotFoundException' が発生した場合、または iOS でビルドエラーが発生した場合は、使用しているデバイス/エミュレーター/シミュレーターの CPU アーキテクチャが、サポートするように選択したサブセットと互換性があることを必ず確認してください。

まとめ

この記事では、NuGet パッケージを介して配布される共通の .NET ラッパーを通じてネイティブライブラリを使用する Xamarin.Forms アプリを作成する方法について説明しました。このチュートリアルに記載されている例は、この方法をより簡単に示すために、意図的に非常に単純化されています。実際のアプリケーションでは、例外処理、コールバック、より複雑な型のマーシャリング、他の依存関係ライブラリとのリンクなどの複雑さに対処する必要があります。重要な考慮事項は、 C++ コードの展開がラッパーおよびクライアントアプリケーションと調整および同期されるプロセスです。このプロセスは、これらの懸念事項の一方または両方が 1 つのチームの責任であるかどうかによって異なる場合があります。いずれにしても、自動化は大きなメリットです。関連するダウンロードとともに、いくつかの重要な概念についての詳細を提供するリソースを以下に示します。

ダウンロード

例

もっと読む

この投稿の内容に関連する記事