このチュートリアルでは、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 の場所に設定できます。インストールされている SDK へのパスは、Android Studio の SDK Manager を使用して確認します。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 アプリのビルドに使用できる android_library
と android_binary
の 2 つのビルドルールがあります。
このチュートリアルでは、まず 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 を使用して、Maven リポジトリから AppCompat、Guava、JUnit などの外部依存関係を統合します。
- robolectric-bazel 統合を使用して Robolectric テストを実行します。
- Android インストルメンテーション テストでアプリをテストする
- NDK を使用して Android アプリに C / C++ コードを統合する
- 以下の Bazel サンプル プロジェクトをご覧ください。
ご利用をお待ちしております。