Bazel で Android Native Development Kit を使用する

Bazel を初めて使用する場合は、Bazel を使用して Android をビルドする チュートリアルから始めてください。

概要

Bazel は、Android Native Development Kit（NDK）ツールチェーンを使用する構成など、さまざまなビルド構成で実行できます。つまり、通常の cc_library と cc_binary ルールは、 Bazel 内で直接 Android 用にコンパイルできます。Bazel は、android_ndk_repository リポジトリ ルールを使用してこれを実現します。

前提条件

Android SDK と NDK がインストールされていることを確認してください。

SDK と NDK を設定するには、次のスニペットを WORKSPACE に追加します。

android_sdk_repository(
    name = "androidsdk", # Required. Name *must* be "androidsdk".
    path = "/path/to/sdk", # Optional. Can be omitted if `ANDROID_HOME` environment variable is set.
)

android_ndk_repository(
    name = "androidndk", # Required. Name *must* be "androidndk".
    path = "/path/to/ndk", # Optional. Can be omitted if `ANDROID_NDK_HOME` environment variable is set.
)

android_ndk_repository ルールの詳細については、Build Encyclopedia のエントリをご覧ください。

Android NDK の最新バージョン（r22 以降）を使用している場合は、 android_ndk_repository の Starlark 実装を使用します。 README の手順に沿って操作してください。

クイック スタート

Android 用の C++ をビルドするには、cc_library 依存関係を android_binary または android_library ルールに追加します。

たとえば、Android アプリの BUILD ファイルが次のようになっているとします。

# In <project>/app/src/main/BUILD.bazel

cc_library(
    name = "jni_lib",
    srcs = ["cpp/native-lib.cpp"],
)

android_library(
    name = "lib",
    srcs = ["java/com/example/android/bazel/MainActivity.java"],
    resource_files = glob(["res/**/*"]),
    custom_package = "com.example.android.bazel",
    manifest = "LibraryManifest.xml",
    deps = [":jni_lib"],
)

android_binary(
    name = "app",
    deps = [":lib"],
    manifest = "AndroidManifest.xml",
)

この BUILD ファイルにより、次のターゲット グラフが生成されます。

図 1.cc_library 依存関係を持つ Android プロジェクトのビルドグラフ。

アプリをビルドするには、次のコマンドを実行します。

bazel build //app/src/main:app

bazel build コマンドは、Java ファイル、Android リソース ファイル、 cc_library ルールをコンパイルし、すべてを APK にパッケージ化します。

$ zipinfo -1 bazel-bin/app/src/main/app.apk
nativedeps
lib/armeabi-v7a/libapp.so
classes.dex
AndroidManifest.xml
...
res/...
...
META-INF/CERT.SF
META-INF/CERT.RSA
META-INF/MANIFEST.MF

Bazel は、すべての cc_libraries を単一の共有オブジェクト（.so）ファイルにコンパイルします。 デフォルトでは、armeabi-v7a ABI を対象としています。これを変更する場合や、 複数の ABI を同時にビルドする場合は、ターゲット ABIの構成に関するセクションをご覧ください。

設定例

この例は、Bazel のサンプル リポジトリで入手できます。

BUILD.bazel ファイルでは、android_binary、 android_library、cc_library の各ルールを使用して 3 つのターゲットが定義されています。

android_binary 最上位ターゲットは APK をビルドします。

cc_library ターゲットには、JNI 関数 実装を含む単一の C++ ソースファイルが含まれています。

#include <jni.h>
#include <string>

extern "C"
JNIEXPORT jstring

JNICALL
Java_com_example_android_bazel_MainActivity_stringFromJNI(
        JNIEnv *env,
        jobject /* this */) {
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

android_library ターゲットは、Java ソース、リソース ファイル、 cc_library ターゲットへの依存関係を指定します。この例では、MainActivity.java は共有オブジェクト ファイル libapp.so を読み込み、JNI 関数のメソッド シグネチャを定義します。

public class MainActivity extends AppCompatActivity {

    static {
        System.loadLibrary("app");
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
       // ...
    }

    public native String stringFromJNI();

}

ターゲット ABI を構成する

ターゲット ABI を構成するには、--android_platforms フラグを次のように使用します。

bazel build //:app --android_platforms=comma-separated list of platforms

--platforms フラグと同様に、--android_platforms に渡される値は platform ターゲットのラベルです。標準の制約値を使用してデバイスを記述します。

たとえば、64 ビット ARM プロセッサを搭載した Android デバイスの場合、プラットフォームは次のように定義します。

platform(
    name = "android_arm64",
    constraint_values = [
        "@platforms//os:android",
        "@platforms//cpu:arm64",
    ],
)

すべての Android platform で @platforms//os:android OS 制約を使用する必要があります。CPU 制約を移行するには、次の表をご覧ください。

もちろん、マルチアーキテクチャ APK の場合は、複数のラベルを渡します。たとえば、--android_platforms=//:arm64,//:x86_64（最上位の BUILD.bazel ファイルで定義されている場合）。

Bazel はデフォルトの Android プラットフォームを選択できないため、定義して --android_platforms で指定する必要があります。

NDK リビジョンと Android API レベルに応じて、次の ABI を 使用できます。

これらの ABI の詳細については、NDK ドキュメント をご覧ください。

マルチ ABI Fat APK は、APK のサイズが大きくなるため、リリースビルドにはおすすめしませんが、開発ビルドや QA ビルドには役立ちます。

C++ 標準を選択する

C++ 標準に従ってビルドするには、次のフラグを使用します。

次に例を示します。

bazel build //:app --cxxopt=-std=c++11

--cxxopt、--copt、 --linkopt を使用してコンパイラ フラグとリンカーフラグを渡す方法については、ユーザー マニュアルをご覧ください。

コンパイラ フラグとリンカーフラグは、cc_library を使用して copts と linkopts の属性として指定することもできます。次に例を示します。

cc_library(
    name = "jni_lib",
    srcs = ["cpp/native-lib.cpp"],
    copts = ["-std=c++11"],
    linkopts = ["-ldl"], # link against libdl
)

Android 用の cc_library を android_binary を使用せずにビルドする

Android 用のスタンドアロン cc_binary または cc_library を android_binary を使用せずにビルドするには、--platforms フラグを使用します。

たとえば、 my/platforms/BUILD で Android プラットフォームを定義しているとします。

bazel build //my/cc/jni:target \
      --platforms=//my/platforms:x86_64

この方法では、ビルドツリー全体が影響を受けます。

これらのフラグは、bazelrc 構成（ABI ごとに 1 つ）を project/.bazelrc に配置できます。

common:android_x86 --platforms=//my/platforms:x86

common:android_armeabi-v7a --platforms=//my/platforms:armeabi-v7a

# In general
common:android_<abi> --platforms=//my/platforms:<abi>

次に、cc_library 用の x86 をビルドするには、次のコマンドを実行します。

bazel build //my/cc/jni:target --config=android_x86

通常、この方法は、低レベルのターゲット（cc_library など）の場合や、 ビルドするものが正確にわかっている場合に使用します。制御できない多くのターゲットをビルドすることが想定される高レベルのターゲットの場合は、android_binary からの自動構成 遷移に依存します。