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 百科事典のエントリをご覧ください。
最新バージョンの Android NDK(r22 以降)を使用している場合は、android_ndk_repository
の Starlark 実装を使用します。README の手順に沿って操作します。
クイック スタート
cc_library
依存関係を android_binary
ルールまたは android_library
ルールに追加するだけで、C++ for Android をビルドすることができます。
たとえば、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();
}
ターゲット 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 制約を移行するには、次のグラフをご覧ください。
CPU 値 | プラットフォーム |
---|---|
armeabi-v7a |
@platforms//cpu:armv7 |
arm64-v8a |
@platforms//cpu:arm64 |
x86 |
@platforms//cpu:x86_32 |
x86_64 |
@platforms//cpu:x86_64 |
もちろん、マルチアーキテクチャ APK の場合は、複数のラベル(--android_platforms=//:arm64,//:x86_64
など)を渡します(最上位の BUILD.bazel
ファイルで定義していることを前提としています)。
Bazel はデフォルトの Android プラットフォームを選択できないため、--android_platforms
で定義して指定する必要があります。
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 ファット APK は APK のサイズが大きくなるため、リリースビルドにはおすすめしませんが、開発ビルドや QA ビルドには便利です。
C++ 標準の選択
C++ 標準に従ってビルドするには、次のフラグを使用します。
C++ 標準 | フラグ |
---|---|
C++98 | デフォルト。フラグは不要 |
C++11 | --cxxopt=-std=c++11 |
C++14 | --cxxopt=-std=c++14 |
C++17 | --cxxopt=-std=c++17 |
例:
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
)
android_binary
を使用せずに Android 用 cc_library
をビルドする
android_binary
を使用せずに Android 用のスタンドアロン cc_binary
または cc_library
をビルドするには、--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>
次に、x86
の cc_library
をビルドするには、次のように実行します。
bazel build //my/cc/jni:target --config=android_x86
通常、この方法は低レベルのターゲット(cc_library
など)またはビルド内容を正確に把握している場合に使用します。制御しない多くのターゲットをビルドする予定がある高レベルのターゲットの場合は、android_binary
からの自動構成遷移に依存します。