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 ルールの詳細については、ビルド百科事典エントリをご覧ください。

クイック スタート

C++ for Android をビルドするには、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 は、デフォルトで armeabi-v7a ABI をターゲットとして、すべての cc_libraries を単一の共有オブジェクト（.so）ファイルにコンパイルします。この設定を変更したり、複数の 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();

}

注: ネイティブ ライブラリの名前は、最上位の android_binary ターゲットの名前から取得されます。この例では app です。

STL を設定する

C++ STL を構成するには、--android_crosstool_top フラグを使用します。

bazel build //:app --android_crosstool_top=target label

@androidndk で使用可能な STL は次のとおりです。

STL	ターゲット ラベル
STLport	@androidndk//:toolchain-stlport
libc++	@androidndk//:toolchain-libcpp
グヌストル	@androidndk//:toolchain-gnu-libstdcpp

r16 以前では、デフォルトの STL は gnustl です。r17 以降では libc++ です。便宜上、ターゲット @androidndk//:default_crosstool はそれぞれのデフォルト STL にエイリアスされます。

r18 以降では、STLport と gnustl が削除され、libc++ が NDK の唯一の STL になります。

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

ターゲット ABI を構成する

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

bazel build //:app --fat_apk_cpu=comma-separated list of ABIs

デフォルトでは、Bazel は armeabi-v7a のネイティブ Android コードをビルドします。x86 向け（エミュレータ向けなど）向けのビルドを行うには、--fat_apk_cpu=x86 を渡します。複数のアーキテクチャ用のファット APK を作成するには、複数の CPU を指定します（--fat_apk_cpu=armeabi-v7a,x86）。

複数の ABI が指定されている場合、Bazel は ABI ごとに共有オブジェクトを含む APK を作成します。

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

NDK リビジョン	ABI
16 以下	armeabi、armeabi-v7a、arm64-v8a、mips、mips64、x86、x86_64
17 歳以上	armeabi-v7a、arm64-v8a、x86、x86_64

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

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

C++ 標準の選択

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

C++ 標準	フラグ
C++98	デフォルト（フラグは不要）
C++11	--cxxopt=-std=c++11
C++14	--cxxopt=-std=c++14

例:

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

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

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

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

プラットフォームやツールチェーンとのインテグレーション

Bazel の構成モデルは、プラットフォームとツールチェーンに移行しています。ビルドで --platforms フラグを使用して、ビルド対象のアーキテクチャやオペレーティング システムを選択する場合、NDK を使用するために --extra_toolchains フラグを Bazel に渡す必要があります。

たとえば、Go ルールが提供する android_arm64_cgo ツールチェーンと統合するには、--platforms フラグに加えて --extra_toolchains=@androidndk//:all を渡します。

bazel build //my/cc:lib \
  --platforms=@io_bazel_rules_go//go/toolchain:android_arm64_cgo \
  --extra_toolchains=@androidndk//:all

WORKSPACE ファイルで直接登録することもできます。

android_ndk_repository(name = "androidndk")
register_toolchains("@androidndk//:all")

これらのツールチェーンを登録すると、アーキテクチャとオペレーティング システムの制約を解決する際に、NDK BUILD ファイル（NDK 20 の場合）でツールチェーンを探すよう Bazel に指示されます。

toolchain(
  name = "x86-clang8.0.7-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:x86_32",
  ],
  toolchain = "@androidndk//:x86-clang8.0.7-libcpp",
)

toolchain(
  name = "x86_64-clang8.0.7-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:x86_64",
  ],
  toolchain = "@androidndk//:x86_64-clang8.0.7-libcpp",
)

toolchain(
  name = "arm-linux-androideabi-clang8.0.7-v7a-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:arm",
  ],
  toolchain = "@androidndk//:arm-linux-androideabi-clang8.0.7-v7a-libcpp",
)

toolchain(
  name = "aarch64-linux-android-clang8.0.7-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:aarch64",
  ],
  toolchain = "@androidndk//:aarch64-linux-android-clang8.0.7-libcpp",
)

仕組み: Android の設定の移行の導入

android_binary ルールでは、Bazel に Android 互換構成での依存関係をビルドするよう明示的に要求できます。これにより、Bazel ビルドが ABI と STL の構成用の --fat_apk_cpu と --android_crosstool_top を除き、特別なフラグなしで正常に機能するようになります。

この自動構成はバックグラウンドで、Android の構成遷移を使用します。

android_binary などの互換性のあるルールは、依存関係の構成を Android 構成に自動的に変更するため、ビルドの Android 固有のサブツリーのみが影響を受けます。ビルドグラフの他の部分は、トップレベルのターゲット構成を使用して処理されます。ビルドグラフにそれをサポートするパスがある場合は、両方の構成で 1 つのターゲットを処理することもあります。

Bazel が Android 互換の構成（トップレベルで指定されるか、上位レベルの移行ポイントによって指定）になると、追加の移行ポイントが発生しても構成は変更されません。

Android 構成への移行をトリガーする組み込み場所は、android_binary の deps 属性のみです。

注: android_binary の data 属性は、意図的に遷移をトリガーしません。また、android_local_test と android_library は移行を意図的にトリガーしません。

たとえば、フラグを指定せずに cc_library 依存関係を持つ android_library ターゲットをビルドしようとすると、JNI ヘッダーが欠落しているというエラーが発生する可能性があります。

ERROR: project/app/src/main/BUILD.bazel:16:1: C++ compilation of rule '//app/src/main:jni_lib' failed (Exit 1)
app/src/main/cpp/native-lib.cpp:1:10: fatal error: 'jni.h' file not found
#include <jni.h>
         ^~~~~~~
1 error generated.
Target //app/src/main:lib failed to build
Use --verbose_failures to see the command lines of failed build steps.

理想的には、これらの自動移行によって、Bazel が大半のケースで適切な処理を実行できるようになります。ただし、C++ デベロッパーが特定の cc_library をテストする場合など、Bazel コマンドラインのターゲットがこれらの移行ルールのいずれかを下回っている場合は、カスタム --crosstool_top を使用する必要があります。

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

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

例:

bazel build //my/cc/jni:target \
      --crosstool_top=@androidndk//:default_crosstool \
      --cpu=<abi> \
      --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

この例では、トップレベルの cc_library ターゲットと cc_binary ターゲットが NDK ツールチェーンを使用してビルドされています。ただし、この場合、ホスト ツールチェーンはターゲット ツールチェーンからコピーされるため、Bazel 独自のホストツールは NDK ツールチェーンを使用してビルドされます（したがって Android の場合もビルドされます）。この問題を回避するには、--host_crosstool_top の値を @bazel_tools//tools/cpp:toolchain に指定して、ホストの C++ ツールチェーンを明示的に設定します。

このアプローチでは、ビルドツリー全体が影響を受けます。

注: これらのフラグを指定すると、コマンドラインのすべてのターゲットが Android 用のビルドに対応している必要があります。そのため、/... や :all のような Bazel ワイルドカードを使用するのが難しい場合があります。

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

common:android_x86 --crosstool_top=@androidndk//:default_crosstool
common:android_x86 --cpu=x86
common:android_x86 --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

common:android_armeabi-v7a --crosstool_top=@androidndk//:default_crosstool
common:android_armeabi-v7a --cpu=armeabi-v7a
common:android_armeabi-v7a --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

# In general
common:android_<abi> --crosstool_top=@androidndk//:default_crosstool
common:android_<abi> --cpu=<abi>
common:android_<abi> --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

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

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

この方法は、低レベルのターゲット（cc_library など）の場合や、ビルド対象が正確にわかっている場合に使用します。高レベルのターゲットでは、制御対象外のターゲットを大量にビルドすることが想定される android_binary からの自動構成移行を使用してください。