BazelCon 2024 登録の受け付けを開始しました。

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

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

問題を報告ソースを表示ナイトリー · 8.0 · 7.4 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

学習内容

このチュートリアルでは、以下の方法について学習します。

Bazel と Xcode をインストールし、サンプルプロジェクトをダウンロードして環境を設定します。
アプリのソースコードと、ワークスペースディレクトリの最上位を識別する WORKSPACE ファイルを含む Bazel ワークスペースを設定します。
必要な外部依存関係への参照を含めるように WORKSPACE ファイルを更新します。
BUILD ファイルを作成する
Bazel を実行して、シミュレータと iOS デバイス用のアプリをビルドする
シミュレータと iOS デバイスでアプリを実行する

環境の設定

始める前に、Bazel と Xcode をインストールし、サンプルプロジェクトを取得します。

Bazel をインストールする

インストール手順に沿って、Bazel とその依存関係をインストールします。

Xcode をインストールする

Xcode をダウンロードしてインストールします。Xcode には、Apple アプリケーションのビルドに Bazel で必要なコンパイラ、SDK、その他のツールが含まれています。

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

また、GitHub からチュートリアルのサンプルプロジェクトを入手する必要があります。GitHub リポジトリには、source-only と main の 2 つのブランチがあります。source-only ブランチには、プロジェクトのソースファイルのみが含まれています。このチュートリアルでは、このブランチのファイルを使用します。main ブランチには、ソースファイルと完成した Bazel WORKSPACE ファイルと BUILD ファイルの両方が含まれています。このブランチのファイルを使用して、チュートリアルの手順を完了した後、作業を確認できます。

コマンドラインで次のように入力して、source-only ブランチのファイルを取得します。

cd $HOME
git clone -b source-only https://github.com/bazelbuild/examples

git clone コマンドは、$HOME/examples/ という名前のディレクトリを作成します。このディレクトリには、Bazel のサンプルプロジェクトがいくつか含まれています。このチュートリアルのプロジェクトファイルは $HOME/examples/tutorial/ios-app にあります。

ワークスペースを設定する

ワークスペースは、1 つ以上のソフトウェアプロジェクトのソースファイル、および Bazel がソフトウェアのビルドに使用する手順を含む WORKSPACE ファイルと BUILD ファイルを含むディレクトリです。ワークスペースには、出力ディレクトリへのシンボリックリンクも含まれている場合があります。

ワークスペースディレクトリはファイルシステムの任意の場所に配置できます。ルートに WORKSPACE ファイルがあることで示されます。このチュートリアルでは、ワークスペースディレクトリは $HOME/examples/tutorial/ です。このディレクトリには、前の手順で GitHub リポジトリからクローンを作成したサンプルプロジェクトファイルが含まれています。

便宜上、ワークスペースディレクトリを参照するように $WORKSPACE 環境変数を設定します。コマンドラインで、次のように入力します。

export WORKSPACE=$HOME/examples/tutorial

WORKSPACE ファイルを作成する

すべてのワークスペースには、最上位のワークスペースディレクトリに WORKSPACE という名前のテキストファイルが必要です。このファイルは空である場合もあれば、ソフトウェアのビルドに必要な外部依存関係への参照が含まれている場合もあります。

現時点では、ワークスペースディレクトリを識別するだけの空の WORKSPACE ファイルを作成します。後続の手順では、ファイルを更新して外部依存関係情報を追加します。

コマンドラインで次のように入力します。

touch $WORKSPACE/WORKSPACE
open -a Xcode $WORKSPACE/WORKSPACE

これにより、空の WORKSPACE ファイルが作成されて開きます。

WORKSPACE ファイルを更新する

Apple デバイス用にアプリケーションをビルドするには、Bazel が GitHub リポジトリから最新の Apple ビルドルールを pull する必要があります。これを有効にするには、次の git_repository ルールを WORKSPACE ファイルに追加します。

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(
    name = "build_bazel_rules_apple",
    remote = "https://github.com/bazelbuild/rules_apple.git",
    tag = "0.19.0",
)

git_repository(
    name = "build_bazel_rules_swift",
    remote = "https://github.com/bazelbuild/rules_swift.git",
    tag = "0.13.0",
)

git_repository(
    name = "build_bazel_apple_support",
    remote = "https://github.com/bazelbuild/apple_support.git",
    tag = "0.7.2",
)

git_repository(
    name = "bazel_skylib",
    remote = "https://github.com/bazelbuild/bazel-skylib.git",
    tag = "0.9.0",
)

ソースファイルを確認する

$WORKSPACE/ios-app/UrlGet にあるアプリのソースファイルを確認します。繰り返しになりますが、ここではアプリの構造を把握するためにこれらのファイルを確認するだけです。このチュートリアルを完了するためにソースファイルを編集する必要はありません。

BUILD ファイルを作成する

コマンドラインプロンプトで、新しい BUILD ファイルを編集用に開きます。

touch $WORKSPACE/ios-app/BUILD
open -a Xcode $WORKSPACE/ios-app/BUILD

ルールの読み込みステートメントを追加する

iOS ターゲットをビルドするには、Bazel はビルドの実行時に GitHub リポジトリからビルドルールを読み込む必要があります。これらのルールをプロジェクトで使用できるようにするには、BUILD ファイルの先頭に次の読み込みステートメントを追加します。

load("@build_bazel_rules_apple//apple:ios.bzl", "ios_application")

objc_library ルールは Bazel パッケージにビルドされているため、ios_application ルールのみを読み込む必要があります。

objc_library ルールを追加する

Bazel には、iOS プラットフォーム用のアプリのビルドに使用できるビルドルールがいくつか用意されています。このチュートリアルでは、まず objc_library ルールを使用して、アプリのソースコードと Xib ファイルから静的ライブラリをビルドする方法を Bazel に指示します。次に、ios_application ルールを使用して、アプリケーションバイナリと .ipa バンドルをビルドする方法を指定します。

次のコードを BUILD ファイルに追加します。

objc_library(
    name = "UrlGetClasses",
    srcs = [
         "UrlGet/AppDelegate.m",
         "UrlGet/UrlGetViewController.m",
         "UrlGet/main.m",
    ],
    hdrs = glob(["UrlGet/*.h"]),
    data = ["UrlGet/UrlGetViewController.xib"],
)

ルールの名前 UrlGetClasses をメモします。

ios_application ルールを追加する

ios_application ルールは、アプリケーションバイナリをビルドし、.ipa バンドルファイルを作成します。

次のコードを BUILD ファイルに追加します。

ios_application(
    name = "ios-app",
    bundle_id = "Google.UrlGet",
    families = [
        "iphone",
        "ipad",
    ],
    minimum_os_version = "9.0",
    infoplists = [":UrlGet/UrlGet-Info.plist"],
    visibility = ["//visibility:public"],
    deps = [":UrlGetClasses"],
)

deps 属性が、上記の BUILD ファイルに追加した UrlGetClasses ルールの出力を参照していることに注意してください。

ファイルを保存して閉じます。BUILD ファイルを GitHub リポジトリの main ブランチにある完成したサンプルと比較できます。

アプリをビルドしてデプロイする

これで、アプリをビルドしてシミュレータと iOS デバイスにデプロイする準備が整いました。

ビルドされたアプリは $WORKSPACE/bazel-bin ディレクトリにあります。

このチュートリアルの完成した WORKSPACE ファイルと BUILD ファイルは、GitHub リポジトリのメインブランチにあります。作成したファイルと完成したファイルを比較して、追加のサポートやトラブルシューティングを行うことができます。

シミュレータ用にアプリをビルドする

現在の作業ディレクトリが Bazel ワークスペース内にあることを確認します。

cd $WORKSPACE

次のように入力して、サンプルアプリをビルドします。

bazel build //ios-app:ios-app

Bazel がサンプルアプリを起動してビルドします。ビルドプロセス中に出力は次のようになります。

INFO: Found 1 target...
Target //ios-app:ios-app up-to-date:
  bazel-bin/ios-app/ios-app.ipa
INFO: Elapsed time: 0.565s, Critical Path: 0.44s

ビルド出力を確認する

.ipa ファイルとその他の出力は $WORKSPACE/bazel-bin/ios-app ディレクトリにあります。

シミュレータでアプリを実行してデバッグする

これで、iOS シミュレータを使用して Xcode からアプリを実行できるようになりました。まず、Tulsi を使用して Xcode プロジェクトを生成します。

次に、Xcode でプロジェクトを開き、ランタイムスキームとして iOS シミュレータを選択し、[実行] をクリックします。

デバイス用のアプリを作成する

iOS デバイスにインストールして起動できるようにアプリをビルドするには、Bazel にそのデバイスモデルに適したプロビジョニングプロファイルが必要です。手順は次のとおりです。

Apple デベロッパーアカウントにアクセスし、デバイスに適したプロビジョニングプロファイルをダウンロードします。詳しくは、Apple のドキュメントをご覧ください。
プロフィールを $WORKSPACE に移動します。
（省略可）.gitignore ファイルにプロファイルを追加します。
BUILD ファイルの ios_application ターゲットに次の行を追加します。
```
provisioning_profile = "<your_profile_name>.mobileprovision",
```

次に、デバイス用のアプリをビルドします。

bazel build //ios-app:ios-app --ios_multi_cpus=armv7,arm64

これにより、アプリがファットバイナリとしてビルドされます。特定のデバイスアーキテクチャ用にビルドするには、ビルドオプションで指定します。

特定の Xcode バージョン用にビルドするには、--xcode_version オプションを使用します。特定の SDK バージョン用にビルドするには、--ios_sdk_version オプションを使用します。ほとんどのシナリオでは、--xcode_version オプションで十分です。

必要な最小 iOS バージョンを指定するには、BUILD ファイルの ios_application ビルドルールに minimum_os_version パラメータを追加します。

Tulsi を使用して、コマンドラインではなく GUI でアプリをビルドすることもできます。

デバイスにアプリをインストールする

デバイスにアプリをインストールする最も簡単な方法は、Xcode を起動して Windows > Devices コマンドを使用することです。左側のリストから接続されているデバイスを選択し、[インストール済みアプリ] の下にある [追加]（プラス記号）ボタンをクリックして、ビルドした .ipa ファイルを選択してアプリを追加します。

アプリがデバイスにインストールされない場合は、BUILD ファイルで正しいプロビジョニングプロファイルを指定していることを確認します（前のセクションのステップ 4）。

アプリが起動しない場合は、デバイスがプロビジョニングプロファイルの一部であることを確認してください。Xcode の Devices 画面の View Device Logs ボタンをクリックすると、問題の原因に関するその他の情報が表示されることがあります。