このチュートリアルでは、Bazel を使用して簡単な Android アプリを作成する方法について説明します。
Bazel は、Android のルールを使用した Android アプリのビルドをサポートしています。
このチュートリアルは、Windows、macOS、Linux のユーザーを対象としており、Bazel または Android アプリ開発の経験は必要ありません。このチュートリアルでは、Android コードを記述する必要はありません。
学習内容
このチュートリアルでは、次の方法について学びます。
- Bazel と Android Studio をインストールし、サンプル プロジェクトをダウンロードして、環境をセットアップします。
- アプリのソースコードと、ワークスペース ディレクトリの最上位を識別する
WORKSPACE
ファイルを含む Bazel ワークスペースを設定します。 WORKSPACE
ファイルを更新して、必要な外部依存関係(Android SDK など)への参照を含めます。BUILD
ファイルを作成します。- Bazel を使用してアプリをビルドします。
- Android Emulator または実機にアプリをデプロイして実行します。
始める前に
Bazel をインストールする
チュートリアルを開始する前に、次のソフトウェアをインストールしてください。
- Bazel.インストールするには、インストール手順に沿って操作してください。
- Android Studioインストールするには、Android Studio をダウンロードする手順を実施してください。設定ウィザードを実行して SDK をダウンロードし、環境を構成します。
- (省略可)Git。
git
を使用して Android アプリ プロジェクトをダウンロードします。
サンプル プロジェクトを取得する
サンプル プロジェクトでは、Bazel のサンプル リポジトリにある基本的な Android アプリ プロジェクトを使用します。
このアプリには、クリックすると挨拶メッセージを出力するボタンが 1 つあります。
図 1. Android アプリボタンの挨拶。
git
を使用してリポジトリのクローンを作成します(または、ZIP ファイルを直接ダウンロードします)。
git clone https://github.com/bazelbuild/examples
このチュートリアルのサンプル プロジェクトは examples/android/tutorial
にあります。チュートリアルの残りの部分では、このディレクトリでコマンドを実行します。
ソースファイルを確認する
アプリのソースファイルを確認してみましょう。
.
├── README.md
└── src
└── main
├── AndroidManifest.xml
└── java
└── com
└── example
└── bazel
├── AndroidManifest.xml
├── Greeter.java
├── MainActivity.java
└── res
├── layout
│ └── activity_main.xml
└── values
├── colors.xml
└── strings.xml
主なファイルとディレクトリは次のとおりです。
名前 | ロケーション |
---|---|
Android マニフェスト ファイル | src/main/AndroidManifest.xml 、src/main/java/com/example/bazel/AndroidManifest.xml |
Android ソースファイル | src/main/java/com/example/bazel/MainActivity.java 、Greeter.java |
リソース ファイルのディレクトリ | src/main/java/com/example/bazel/res/ |
Bazel を使用したビルド
ワークスペースを設定する
ワークスペースは、1 つ以上のソフトウェア プロジェクトのソースファイルを含むディレクトリで、そのルートに WORKSPACE
ファイルがあります。
WORKSPACE
ファイルは空の場合も、プロジェクトのビルドに必要な外部依存関係への参照を含んでいる場合もあります。
まず、次のコマンドを実行して空の WORKSPACE
ファイルを作成します。
OS | コマンド |
---|---|
Linux、macOS | touch WORKSPACE |
Windows(コマンド プロンプト) | type nul > WORKSPACE |
Windows(PowerShell) | New-Item WORKSPACE -ItemType file |
Bazel の実行
次のコマンドを使用して、Bazel が正しく実行されているかどうかを確認できます。
bazel info workspace
Bazel が現在のディレクトリのパスを出力したら、完了です。WORKSPACE
ファイルが存在しない場合は、次のようなエラー メッセージが表示されることがあります。
ERROR: The 'info' command is only supported from within a workspace.
Android SDK との統合
アプリをビルドするために、Bazel は Android SDK ビルドツールを実行する必要があります。そのため、Bazel がどこにあるかを把握できるように、WORKSPACE
ファイルに情報を追加する必要があります。
WORKSPACE
ファイルに次の行を追加します。
android_sdk_repository(name = "androidsdk")
これにより、ANDROID_HOME
環境変数で参照されるパスで Android SDK が使用され、最も高い API レベルとその場所にインストールされているビルドツールの最新バージョンが自動的に検出されます。
ANDROID_HOME
変数を Android SDK の場所に設定できます。Android Studio の SDK Manager を使用して、インストールされている SDK のパスを確認します。
SDK がデフォルトの場所にインストールされている場合は、次のコマンドを使用して ANDROID_HOME
変数を設定できます。
OS | コマンド |
---|---|
Linux | export ANDROID_HOME=$HOME/Android/Sdk/ |
macOS | export ANDROID_HOME=$HOME/Library/Android/sdk |
Windows(コマンド プロンプト) | set ANDROID_HOME=%LOCALAPPDATA%\Android\Sdk |
Windows(PowerShell) | $env:ANDROID_HOME="$env:LOCALAPPDATA\Android\Sdk" |
上記のコマンドは、現在のシェル セッションにのみ変数を設定します。これを永続的にするには、次のコマンドを実行します。
OS | コマンド |
---|---|
Linux | echo "export ANDROID_HOME=$HOME/Android/Sdk/" >> ~/.bashrc |
macOS | echo "export ANDROID_HOME=$HOME/Library/Android/Sdk/" >> ~/.bashrc |
Windows(コマンド プロンプト) | setx ANDROID_HOME "%LOCALAPPDATA%\Android\Sdk" |
Windows(PowerShell) | [System.Environment]::SetEnvironmentVariable('ANDROID_HOME', "$env:LOCALAPPDATA\Android\Sdk", [System.EnvironmentVariableTarget]::User) |
path
、api_level
、build_tools_version
の各属性を含めることで、Android SDK の絶対パス、API レベル、使用するビルドツールのバージョンを明示的に指定することもできます。api_level
と build_tools_version
が指定されていない場合、android_sdk_repository
ルールは SDK で利用可能なそれぞれの最新バージョンを使用します。SDK に存在する限り、これらの属性の任意の組み合わせを指定できます。次に例を示します。
android_sdk_repository(
name = "androidsdk",
path = "/path/to/Android/sdk",
api_level = 25,
build_tools_version = "30.0.3"
)
Windows では、path
属性には混合スタイルのパス、つまりスラッシュを含む Windows パスを使用する必要があります。
android_sdk_repository(
name = "androidsdk",
path = "c:/path/to/Android/sdk",
)
省略可: ネイティブ コードを Android アプリにコンパイルする場合は、Android NDK もダウンロードし、次の行を WORKSPACE
ファイルに追加して Bazel への場所を伝える必要があります。
android_ndk_repository(name = "androidndk")
android_sdk_repository
と同様に、Android NDK へのパスは、デフォルトで ANDROID_NDK_HOME
環境変数から推定されます。パスは、android_ndk_repository
の path
属性を使用して明示的に指定することもできます。
詳細については、Bazel を使用した Android Native Development Kit の使用をご覧ください。
api_level
は、SDK と NDK がターゲットとする Android API のバージョンです。たとえば、Android 6.0 の場合は 23、Android 7.1 の場合は 25 です。明示的に設定されていない場合、api_level
はデフォルトで android_sdk_repository
と android_ndk_repository
で使用可能な最も高い API レベルになります。
SDK と NDK で API レベルを同じ値に設定する必要はありません。このページには、Android リリースから NDK 対応 API レベルへのマップが掲載されています。
BUILD ファイルを作成する
BUILD
ファイルには、aapt
のコンパイル済み Android リソースや javac
のクラスファイルなど、一連のビルド出力と、それらの依存関係との関係が記述されます。これらの依存関係は、ワークスペース内のソースファイル(Java、C++)やその他のビルド出力です。BUILD
ファイルは、Starlark という言語で記述します。
BUILD
ファイルは、パッケージ階層と呼ばれる Bazel のコンセプトの一部です。パッケージ階層は、ワークスペースのディレクトリ構造にオーバーレイする論理構造です。各パッケージは、関連するソースファイルのセットと BUILD
ファイルを含むディレクトリ(およびそのサブディレクトリ)です。パッケージにはサブディレクトリも含まれます(独自の BUILD
ファイルを含むものを除く)。パッケージ名は、WORKSPACE
を基準とする BUILD
ファイルへの相対パスです。
Bazel のパッケージ階層は、BUILD
ファイルが配置されている Android アプリ ディレクトリの Java パッケージ階層と概念的に異なりますが、ディレクトリは同じ構造になっている場合があります。
このチュートリアルのシンプルな Android アプリの場合、src/main/
のソースファイルは単一の Bazel パッケージで構成されています。より複雑なプロジェクトでは、ネストされたパッケージが多数存在する場合があります。
android_library ルールを追加する
BUILD
ファイルには、Bazel のさまざまなタイプの宣言が含まれています。最も重要なタイプはビルドルールで、ソースファイルのセットやその他の依存関係から中間または最終的なソフトウェア出力をビルドする方法を Bazel に指示します。Bazel には、Android アプリのビルドに使用できる 2 つのビルドルール(android_library
と android_binary
)が用意されています。
このチュートリアルでは、まず android_library
ルールを使用して、アプリのソースコードとリソース ファイルから Android ライブラリ モジュールをビルドするよう Bazel に指示します。次に、android_binary
ルールを使用して、Android アプリ パッケージのビルド方法を Bazel に指示します。
src/main/java/com/example/bazel
ディレクトリに新しい BUILD
ファイルを作成し、新しい android_library
ターゲットを宣言します。
src/main/java/com/example/bazel/BUILD
:
package(
default_visibility = ["//src:__subpackages__"],
)
android_library(
name = "greeter_activity",
srcs = [
"Greeter.java",
"MainActivity.java",
],
manifest = "AndroidManifest.xml",
resource_files = glob(["res/**"]),
)
android_library
ビルドルールには、Bazel がソースファイルからライブラリ モジュールをビルドするために必要な情報を指定する一連の属性が含まれています。また、ルールの名前が greeter_activity
であることに留意してください。android_binary
ルールで、この名前を依存関係として使用してルールを参照します。
android_binary ルールを追加する
android_binary
ルールは、アプリの Android アプリ パッケージ(.apk
ファイル)をビルドします。
src/main/
ディレクトリに新しい BUILD
ファイルを作成し、新しい android_binary
ターゲットを宣言します。
src/main/BUILD
:
android_binary(
name = "app",
manifest = "AndroidManifest.xml",
deps = ["//src/main/java/com/example/bazel:greeter_activity"],
)
ここで、deps
属性は、上記の BUILD
ファイルに追加した greeter_activity
ルールの出力を参照します。つまり、Bazel はこのルールの出力をビルドするときに、まず greeter_activity
ライブラリ ルールの出力がビルドされ、最新かどうかを確認します。そうでない場合、Bazel はビルドし、その出力を使用してアプリケーション パッケージ ファイルをビルドします。
ファイルを保存して閉じます。
アプリをビルドする
アプリを作成してみましょう。次のコマンドを実行して、android_binary
ターゲットをビルドします。
bazel build //src/main:app
build
サブコマンドは、後続のターゲットをビルドするように Bazel に指示します。ターゲットは、BUILD
ファイル内のビルドルールの名前と、ワークスペース ディレクトリへの相対パッケージパスとして指定されます。この例では、ターゲットは app
で、パッケージパスは //src/main/
です。
コマンドラインの現在の作業ディレクトリとターゲットの名前によっては、パッケージパスまたはターゲット名を省略できる場合があります。ターゲットのラベルとパスの詳細については、ラベルをご覧ください。
Bazel がサンプルアプリのビルドを開始します。ビルドプロセス中に、出力は次のようになります。
INFO: Analysed target //src/main:app (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //src/main:app up-to-date:
bazel-bin/src/main/app_deploy.jar
bazel-bin/src/main/app_unsigned.apk
bazel-bin/src/main/app.apk
ビルド出力を確認する
Bazel は、中間ビルド オペレーションと最終ビルド オペレーションの両方の出力を、ユーザーごと、ワークスペースごとの一連の出力ディレクトリに配置します。これらのディレクトリは、プロジェクト ディレクトリの最上位にある次の場所からシンボリック リンクされています。ここで、WORKSPACE
は次のとおりです。
bazel-bin
: バイナリ実行可能ファイルとその他の実行可能なビルド出力を保存します。bazel-genfiles
には、Bazel ルールによって生成された中間ソースファイルが保存されます。bazel-out
は他のタイプのビルド出力を格納します。
Bazel は、android_binary
ルールを使用して生成された Android .apk
ファイルを bazel-bin/src/main
ディレクトリに保存します。サブディレクトリ名 src/main
は Bazel パッケージの名前から派生します。
コマンド プロンプトで、このディレクトリの内容を一覧表示し、app.apk
ファイルを見つけます。
OS | コマンド |
---|---|
Linux、macOS | ls bazel-bin/src/main |
Windows(コマンド プロンプト) | dir bazel-bin\src\main |
Windows(PowerShell) | ls bazel-bin\src\main |
アプリを実行する
これで、コマンドラインから bazel
mobile-install
コマンドを使用して、接続された Android デバイスまたはエミュレータにアプリをデプロイできるようになりました。このコマンドは、Android Debug Bridge(adb
)を使用してデバイスと通信します。デプロイ前に、Android Debug Bridge の手順に沿って adb
を使用するようにデバイスをセットアップする必要があります。Android Studio に組み込まれている Android Emulator にアプリをインストールすることもできます。以下のコマンドを実行する前に、エミュレータが実行されていることを確認してください。
次の情報を入力します。
bazel mobile-install //src/main:app
次に、「Bazel チュートリアル アプリ」を探して起動します。
図 2. Bazel チュートリアル アプリ。
おめでとうございます。Bazel でビルドした初めての Android アプリをインストールできました。
なお、mobile-install
サブコマンドでは --incremental
フラグもサポートされています。このフラグを使用すると、前回のデプロイ以降に変更されたアプリの部分のみをデプロイすることができます。
また、--start_app
フラグをサポートしており、インストール後すぐにアプリを起動できます。
参考資料
詳しくは、次のページをご覧ください。
- GitHub で未解決の問題
- モバイル インストールの詳細
- rules_jvm_external を使用して、AppCompat、Guava、JUnit などの外部依存関係を Maven リポジトリから統合します。
- robolectric-bazel 統合を使用して Robolectric テストを実行します。
- Android インストルメンテーション テストでアプリをテストする
- NDK を使用して C / C++ コードを Android アプリに統合する
- 以下の Bazel プロジェクトの例をご覧ください。
ご利用をお待ちしております。