Build Foundation の創設メンバーの登録が開始されました。メーリングリストに参加し、参加契約を読み、登録してください。

Bazel チュートリアル: Android アプリを作成する

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

注: Android アプリのビルドに Bazel を使用する場合、既知の制限事項があります。既知の問題の一覧については、Github チームの Android ホットリストをご覧ください。Bazel チームとオープンソースソフトウェア（OSS）のコントリビューターは既知の問題の解決に積極的に取り組んでいますが、Android Studio は公式には Bazel プロジェクトをサポートしていません。

このチュートリアルでは、Bazel を使用して簡単な Android アプリをビルドする方法について説明します。

Bazel は、 Android ルールを使用して Android アプリのビルドをサポートしています。

このチュートリアルは、Windows、macOS、Linux ユーザーを対象としており、Bazel や Android アプリ開発の経験は必要ありません。このチュートリアルでは、Android コードを記述する必要はありません。

学習内容

このチュートリアルでは、次の方法について説明します。

Bazel と Android Studio をインストールし、サンプルプロジェクトをダウンロードして環境をセットアップします。
アプリのソースコードと、ワークスペースディレクトリの最上位レベルを識別する WORKSPACE ファイルを含む Bazel ワークスペースをセットアップします。
WORKSPACE ファイルを更新して、Android SDK など、必要な外部依存関係への参照を含めます。
BUILD ファイルを作成します。
Bazel でアプリをビルドします。
Android エミュレータまたは実機にアプリをデプロイして実行します。

始める前に

Bazel をインストールする

チュートリアルを開始する前に、次のソフトウェアをインストールします。

Bazel. インストールするには、インストール手順に沿って操作します。
Android Studio. インストールするには、Android Studio をダウンロードする手順に沿って操作します。セットアップウィザードを実行して SDK をダウンロードし、環境を構成します。
（省略可）Git.git を使用して Android アプリプロジェクトをダウンロードします。

サンプルプロジェクトを取得する

サンプルプロジェクトには、 Bazel の examples リポジトリにある基本的な 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 に NDK の場所を通知する必要があります。

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 ファイルを作成する

A 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 .apk ファイルを android_binary ルールを使用して生成し、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 エミュレータにアプリをインストールすることもできます。次のコマンドを実行する前に、エミュレータが実行されていることを確認してください。

次の情報を入力します。

bazel mobile-install //src/main:app

次に、「Bazel Tutorial App」を見つけて起動します。

Bazel チュートリアルアプリ

図 2.Bazel チュートリアルアプリ。

おめでとうございます。Bazel でビルドされた最初の Android アプリをインストールしました。

mobile-install サブコマンドは、 --incremental フラグもサポートしています。このフラグを使用すると、前回のデプロイ以降に変更されたアプリの部分のみをデプロイできます。

また、--start_app フラグもサポートしています。このフラグを使用すると、アプリをインストールするとすぐに起動します。

Bazel チュートリアル: Android アプリを作成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。