.JAR のバインド

[アーティクル]
04/11/2018

重要

現在、Xamarin プラットフォームでのカスタムバインディングの使用を調査しています。今後の開発作業の発展のために、このアンケートにご回答ください。

このチュートリアルでは、Android .JAR ファイルから Xamarin.Android Java バインドライブラリを作成する詳しい手順について説明します。

概要

Android コミュニティでは、アプリで使用できる多くの Java ライブラリが提供されています。多くの場合、これらの Java ライブラリは .JAR (Java Archive) 形式にパッケージ化されていますが、その機能を Xamarin Android アプリで使用できるように、.JAR を Java バインドライブラリ にパッケージ化できます。 Java バインドライブラリの目的は、.JAR ファイル内の API を、自動的に生成されたコードラッパーを使用して C# コードで使用できるようにすることです。

Xamarin ツールでは、1 つ以上の入力 .JAR ファイルからバインドライブラリを生成できます。バインドライブラリ (.DLL アセンブリ) には次のものが含まれます。

元の .JAR ファイルの内容。
マネージド呼び出し可能ラッパー (MCW)。これは、.JAR ファイル内の対応する Java 型をラップする C# 型です。

生成された MCW コードは、JNI (Java Native Interface) を使用して、API 呼び出しを基になる .JAR ファイルに転送します。当初は Android で使用することを目的としていた任意の JAR ファイルのバインドライブラリを作成できます (Xamarin ツールは、現在 Android 以外の Java ライブラリのバインドをサポートしていないことに注意してください)。 .JAR ファイルの内容を含めずにバインドライブラリをビルドして、実行時に DLL が .JAR に依存するように選択することもできます。

このガイドでは、1 つの .JAR ファイルに対するバインドライブラリを作成するための基本について説明します。バインドのカスタマイズやデバッグの必要がない、すべてが適切に動作する例を示します。メタデータを使用したバインディングの作成では、バインドプロセスが完全に自動化されておらず、一部の手動介入が必要になる、より高度なシナリオ例について説明しています。一般的な Java ライブラリのバインドの概要 (基本的なコード例を含む) については、「Java ライブラリのバインド」を参照してください。

チュートリアル

次のチュートリアルでは、イメージの読み込みとキャッシュ機能を提供する一般的な Android .JAR である Picasso のバインドライブラリを作成します。次の手順を使用して picasso-2.x.x.jar をバインドし、Xamarin.Android プロジェクトで使用できる新しい .NET アセンブリを作成します。

新しい Java バインドライブラリプロジェクトを作成します。
.JAR ファイルをプロジェクトに追加します。
.JAR ファイルに適切なビルドアクションを設定します。
.JAR でサポートされるターゲットフレームワークを選択します。
バインドライブラリをビルドします。

バインドライブラリを作成したら、バインドライブラリで API を呼び出す機能を示す小さな Android アプリを開発します。この例では、picasso-2.x.x.jar のメソッドにアクセスします。

package com.squareup.picasso

public class Picasso
{
    ...
    public static Picasso with (Context context) { ... };
    ...
    public RequestCreator load (String path) { ... };
    ...
}

picasso-2.x.x.jar のバインドライブラリを生成した後、これらのメソッドを C# から呼び出すことができます。次に例を示します。

using Com.Squareup.Picasso;
...
Picasso.With (this)
    .Load ("https://mydomain.myimage.jpg")
    .Into (imageView);

バインドライブラリの作成

以下の手順を実行する前に、picasso-2.x.x.jar をダウンロードしてください。

最初に、新しいバインドライブラリプロジェクトを作成します。 Visual Studio for Mac または Visual Studio で、新しいソリューションを作成し、"Android バインドライブラリ" テンプレートを選択します。 (このチュートリアルのスクリーンショットでは Visual Studio が使用されていますが、Visual Studio for Mac もよく似ています)。ソリューションに JarBinding と名前を付けます。

テンプレートには、Jars フォルダーが含まれています。ここで、バインドライブラリプロジェクトに対して .JAR を追加します。 Jars フォルダーを右クリックし、[追加] > [既存の項目] の順に選択します。

前にダウンロードした picasso-2.x.x.jar に移動し、それを選択して [追加] をクリックします。

picasso-2.x.x.jar ファイルがプロジェクトに正常に追加されたことを確認します。

Java バインドライブラリプロジェクトを作成する場合は、.JAR をバインドライブラリに埋め込むか、個別にパッケージ化するかを指定する必要があります。これを行うには、次のいずれかの "ビルドアクション" を指定します。

EmbeddedJar – .JAR はバインドライブラリに埋め込まれます。
InputJar – .JAR はバインドライブラリとは別に保持されます。

通常は、EmbeddedJar ビルドアクションを使用して、.JAR が自動的にバインドライブラリにパッケージ化されるようにします。これは、最も簡単なオプションです。.JAR 内の Java バイトコードは Dex バイトコードに変換され、APK に (マネージド呼び出し可能ラッパーと共に) 埋め込まれます。 .JAR をバインドライブラリとは別に保持する場合は、InputJar オプションを使用できます。ただし、アプリを実行するデバイスで確実に .JAR ファイルが使用できるようにする必要があります。

ビルドアクションを EmbeddedJar に設定します。

次に、プロジェクトのプロパティを開いて、"ターゲットフレームワーク" を構成します。 .JAR で Android API が使用される場合は、ターゲットフレームワークを .JAR が期待する API レベルに設定します。通常、.JAR ファイルの開発者は、.JAR と互換性のある API レベルを示します。 (一般的なターゲットフレームワークの設定および Android API レベルの詳細については、「Android API レベルの理解」を参照してください。)

バインドライブラリのターゲット API レベルを設定します (この例では API レベル 19 を使用しています)。

最後に、バインドライブラリをビルドします。いくつかの警告メッセージが表示される場合がありますが、バインドライブラリプロジェクトが正常にビルドされ、JarBinding/bin/Debug/JarBinding.dll に出力 .DLL が生成されます。

バインドライブラリの使用

この .DLL を Xamarin.Android アプリで使用するには、次のようにします。

バインドライブラリへの参照を追加します。
マネージド呼び出し可能ラッパーを使用して .JAR への呼び出しを行います。

次の手順では、バインドライブラリを使用して、ImageView のイメージをダウンロードして表示する最小限のアプリを作成します。"複雑な処理" は、.JAR ファイル内のコードによって行われます。

最初に、バインドライブラリを使用する新しい Xamarin.Android アプリを作成します。ソリューションを右クリックして [新しいプロジェクトの追加] を選択し、新しいプロジェクトに「BindingTest」という名前を付けます。このチュートリアルを簡略化するために、このアプリをバインドライブラリと同じソリューションに作成しています。ただし、バインドライブラリを使用するアプリは、別のソリューションに存在させることもできます。

BindingTest プロジェクトの [参照] ノードを右クリックし、[参照の追加] を選択します。

先ほど作成した JarBinding プロジェクトをチェックし、[OK] をクリックします。

BindingTest プロジェクトの [参照] ノードを開き、JarBinding 参照が存在することを確認します。

ImageView が 1 つになるように、BindingTest のレイアウト (Main.axml) を変更します。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:minWidth="25px"
    android:minHeight="25px">
    <ImageView
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:id="@+id/imageView" />
</LinearLayout>

次の using ステートメントを MainActivity.cs に追加します。これにより、バインドライブラリに存在する Java ベースの Picasso クラスのメソッドに簡単にアクセスできるようになります。

using Com.Squareup.Picasso;

OnCreate メソッドを変更し、Picasso クラスを使用して URL からイメージを読み込み、ImageView に表示するようにします。

public class MainActivity : Activity
{
    protected override void OnCreate(Bundle bundle)
    {
        base.OnCreate(bundle);
        SetContentView(Resource.Layout.Main);
        ImageView imageView = FindViewById<ImageView>(Resource.Id.imageView);

        // Use the Picasso jar library to load and display this image:
        Picasso.With (this)
            .Load ("https://i.imgur.com/DvpvklR.jpg")
            .Into (imageView);
    }
}

BindingTest プロジェクトをコンパイルして実行します。アプリが起動し、短い遅延 (ネットワークの状態によって異なります) の後に、次のスクリーンショットのようなイメージがダウンロードされて表示されます。

お疲れさまでした。 Java ライブラリ .JAR を正しくバインドし、Xamarin.Android アプリで使用しました。

まとめ

このチュートリアルでは、サードパーティー .JAR ファイルのバインドライブラリを作成して、最小限のテストアプリにバインドライブラリを追加し、アプリを実行して C# コードが .JAR ファイル内にある Java コードを呼び出せることを確認しました。

次の方法で共有

.JAR のバインド

概要

チュートリアル

バインドライブラリの作成

バインドライブラリの使用

まとめ

その他のリソース

次の方法で共有

.JAR のバインド

概要

チュートリアル

バインド ライブラリの作成

バインド ライブラリの使用

まとめ

関連リンク

その他のリソース

バインドライブラリの作成

バインドライブラリの使用