【備忘録】bundletool を自分でビルドしてみた話


略称

  • PAD:Play Asset Delivery
  • AAB:Android App Bundle

■ はじめに

Android Developer で提供されている bundletool という AAB を弄くり回せるツールがあります。

せっかくオープンソースで公開されていましたのでどのようなことをやっているのかを知りたくて自前でビルドしてみました。
そのときの手順などをまとめておこうと思います。

■ 開発環境

  • bundletool 1.8.0 (masterブランチ)
  • Windows 10 Home (21H1)
  • IntelliJ IDEA Ultimate 2021.2.1
    • 恐らく Community でも動かせると思います。
    • 余談ですが Japanease Language Pack をインストールしています。
  • JRE 11

■ bundletool について

公式ドキュメントにございますのでこちらをご確認ください。

■ ビルド手順の前準備(JRE11の設定)

① GitHub にプッシュされている bundletool のプロジェクトを clone してきます。

② IntelliJ IDEA で ① のプロジェクトを開きます。

③ メニューバーより ファイル(F) -> プロジェクト構成 Ctrl+Alt+Shift+S を選択します。

プロジェクト設定 -> プロジェクト -> プロジェクト SDK(P) で Java のバージョンが11を選択していることを確認します。
もし、してなければ下記へ進んでください。

⑤ プロジェクト SDK(P) 項目のプルダウンメニューを開き、SDKの追加 -> JDK のダウンロード を選択します。

⑥ JDK のダウンロードウィンドウにて下記設定でダウンロードします。
- バージョン:11
- ベンダー:任意(私はデフォルトのAmazon Corretto)
- 場所:任意

⑦ 先程のプロジェクト SDK(P) の項目に 11 が指定されていることを確認してOKでウィンドウを閉じます。

■ ビルド手順

① IntelliJ IDEA で bundletool のプロジェクトを開いておきます。

② Jarファイルを生成します。
Gradleタブ -> bundletool > Tasks > other > executableJar を右クリックし、実行 [executableJar] (U) Ctrl+Shift+F10 を選択し、実行します。

③ 実行タブ内のログに 'executableJar' の実行を完了しました。 と出ているのを確認します。

④ エクスプローラーを開き、下記パスに bundletool-all.jar があればビルド成功です。

.\bundletool\build\libs\bundletool-all.jar

ここまで出来ていれば「実行構成」に bundletool [executableJar] という項目が追加されますので、以降Jarの更新をしたい場合はそちらを使えば簡単にJarファイルを作り直すことが出来ます。

■ 実行手順の前準備

今回は build-apksオプション について調査しやすい環境を作っていきます。

① 検証用に aab ファイルを作っておき、下記フォルダへ配置しておきます。

.\bundletool\test\app.aab

② メニューバーより 実行(U) -> 実行構成の編集(R) を選択します。

新規構成の追加 Alt+Insert -> JAR アプリケーション を選択します。

④ 下記設定を行います。

  • 名前 (N):任意(私はaab2apks)
  • JAR のパス (J):先程生成した bundletool-all.jar までのフルパスを指定
  • VM オプション (V):空欄でOK
  • プログラム引数 (R):build-apks --bundle=$ProjectFileDir$\test\app.aab --output=$ProjectFileDir$\test\app.apks
  • 作業ディレクトリ (W):デフォルトのまま
  • 環境変数(E):空欄でOK
  • JRE (J):ビルド手順の前準備にて準備した物を使う(私は 11 を指定)

■ 実行手順

① IntelliJ IDEA で下記ファイルを開きます。

.\bundletool\src\main\java\com\android\tools\build\bundletool\BundleToolMain.java

② メインメソッド内の適当なところにブレークポイントを貼ります。

③ メニューバーから 実行(U) -> デバッグ'aab2apks'(D) Shift+F9 を選択します。

④ 下記のようにブレークポイントで止まれば成功です。

まとめ

長くなりましたが以上となります。

やはり実際のコードを見ながら動作チェックできると色々捗ります。

ソースコードを見ていると公式には発表していない機能が幾つかありましたので、その辺りの挙動も確認できれば、アプリ開発に役立つと思いますので引き続き調査を進めていこうと思います。