このページは Cloud Translation API によって翻訳されました。

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

注: Android アプリのビルドに Bazel を使用する場合は、既知の制限事項があります。既知の問題のリストについては、GitHub の team-Android ホットリストをご覧ください。Bazel チームとオープンソースソフトウェア（OSS）コントリビューターは、既知の問題への対応に積極的に取り組んでいますが、Android Studio が Bazel プロジェクトを正式にサポートしているわけではないことにユーザーは注意する必要があります。

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

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

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

学習内容

このチュートリアルでは、次の方法を学習します。

Bazel と Android Studio をインストールし、サンプルプロジェクトをダウンロードして、環境をセットアップします。
アプリのソースコードを含む Bazel ワークスペースと、ワークスペースディレクトリの最上位を識別する WORKSPACE ファイルを設定します。
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 アプリのビルドに使用できる 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 チュートリアルアプリ」を見つけて起動します。

Bazel チュートリアルアプリ

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

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

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

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