各種の API レベル用の APK を複数作成する

アプリを Google Play に公開する場合、Android App Bundle を作成してアップロードする必要があります。こうすることで、各ユーザーのデバイス設定に合わせて最適化された APK が Google Play によって自動的に生成、配信されるため、ユーザーはアプリの実行に必要なコードとリソースをダウンロードするだけで済みます。複数の APK の公開は、Google Play に公開しない場合は便利ですが、各 APK のビルド、署名、管理を自分で行う必要があります。

Android アプリを開発して Google Play で複数の APK を利用する場合は、最初から適切な方法を採用し、開発プロセスで不必要なトラブルが生じるのを避けることが重要です。このレッスンでは、アプリの APK を複数作成し、各 APK で若干異なる範囲の API レベルをカバーする方法を説明します。また、複数 APK のコードベースをできるだけ効率的に管理するために必要なツールも紹介します。

複数 APK の必要性を確認する

さまざまな世代の Android プラットフォームで動作するアプリを作成する場合、下位互換性を犠牲にすることなく、新しいデバイスの最新機能をアプリで利用したいと考えるのが自然です。最初は複数 APK をサポートすることが最善のように思えるかもしれませんが、多くの場合そうではありません。複数 APK のデベロッパー ガイドの単一 APK を代わりに使用するセクションには、Google のサポート ライブラリの使用など、単一 APK で目的を達成する方法に関する有用な情報が含まれています。また、この記事にあるリフレクションのようなコンピューティング コストの高い手法に頼らずに、単一 APK で特定の API レベルでのみ実行されるコードを作成する方法を学ぶこともできます。

アプリを単一 APK に限定できるのであれば、次のような利点があります。

  • 公開とテストがより簡単になります
  • 管理するコードベースは 1 つだけです
  • アプリはデバイス構成の変更に適応できます
  • 複数のデバイスにまたがるアプリの復元が機能します
  • 市場選好、ある APK から次の APK への「アップグレード」の動作、どの APK がどのクラスのデバイスに対応するかなどを考慮する必要がありません

この後のレッスンでは、トピックを調査し、リンク先のリソースの資料を慎重に吟味したうえで、複数 APK がアプリにとって正しい選択であると判断したという前提に立って説明を進めます。

要件を図示する

はじめに、単純な図を作成して、必要な APK の数と各 APK がカバーする API の範囲を手早く決定します。便利な参考資料として、Android デベロッパー ウェブサイトのプラットフォーム バージョン ページには、Android プラットフォームの特定のバージョンを実行する有効なデバイスの比率に関するデータが掲載されています。各 APK がターゲットとする API レベルのセットを把握し続けることは、最初は簡単に思えるかもしれませんが、重複がある場合は特に(重複はよくあります)、まもなく困難になります。要件の図は短時間で簡単に作成でき、後で手軽に参照できるので便利です。

複数 APK の図を作成するには、Android プラットフォームの各種の API レベルを表すセルの行をはじめに作図します。行の末尾には、Android の将来のバージョンを表すセルを追加します。

3 4 5 6 7 8 9 10 11 12 13 +

次に、個々の APK を表す色をセルに塗ります。次の図は、各 APK を API レベルの特定の範囲に適用する 1 つの例を示しています。

3 4 5 6 7 8 9 10 11 12 13 +

この図が完成したら、チームに配布します。そうすれば、プロジェクトに関するチーム内のコミュニケーションがすぐに簡単になります。たとえば、「API レベル 3 から 6 の APK はどう?Android 1.x のあれはうまくいってる?」と尋ねる代わりに、「青の APK はうまくいってる?」と言えば済みます。

ライブラリ プロジェクトにすべての共通のコードとリソースを配置する

これは、既存の Android アプリを変更する場合でもゼロから作成する場合でも、コードベースに対して最初に実施すべき非常に重要な作業です。ライブラリ プロジェクトに配置したものはすべて、更新が一度だけで済みます(言語別にローカライズされた文字列、色のテーマ、共有コードのバグの修正を考えてください)。これにより、開発時間が短縮され、簡単に回避できたはずの誤りが生じる可能性が減少します。

注: ライブラリ プロジェクトを作成してインクルードする実装の詳細はこのレッスンでは取り上げませんが、Android ライブラリの作成を参照すれば、効率的に実装できます。

既存のアプリを変換して複数 APK のサポートに使用する場合は、ローカライズされたすべての文字列ファイル、値のリスト、テーマの色、メニュー アイコン、APK 全体で変更されないレイアウトをコードベースで調べて、それらをすべてライブラリ プロジェクトに配置します。ほとんど変更されないコードもライブラリ プロジェクトに配置する必要があります。そうしたクラスを拡張して、APK ごとにメソッドを 1 つか 2 つ追加できます。

一方、アプリをゼロから作成する場合は、最初にできるだけ多くのコードをライブラリ プロジェクト内で作成し、必要なときだけ個々の APK に移動します。コードを個別に APK に追加していき、数か月経った後でどうすれば大量のコードをライブラリ セクションに移動できるかに頭を悩ませるより、上記のように長期的な視野に立って管理する方がはるかに簡単です。

新しい APK プロジェクトを作成する

リリースする APK ごとに別個の Android プロジェクトが必要です。整理しやすいように、ライブラリ プロジェクトと、すべての関連する APK プロジェクトを同じ親フォルダの下に配置します。また、各 APK は同じパッケージ名を持つ必要がありますが、必ずしもパッケージ名をライブラリと共有する必要はありません。前述のスキームに従って 3 つの APK を使用する場合、ルート ディレクトリは次のようになります。

    alexlucas:~/code/multi-apks-root$ ls
    foo-blue
    foo-green
    foo-lib
    foo-red
    

プロジェクトを作成したら、ライブラリ プロジェクトを各 APK プロジェクトへの参照として追加します。可能であれば、ライブラリ プロジェクトで開始アクティビティを定義し、APK プロジェクトでそのアクティビティを拡張します。ライブラリ プロジェクトで開始アクティビティを定義すると、アプリの初期化をすべて 1 か所にまとめることができるため、アナリティクスの初期化、ライセンス チェックの実行、各 APK でほとんど変わらないその他の初期化手続きなどの「汎用的」なタスクを個々の APK で再実装する必要がなくなります。

マニフェストを調整する

ユーザーが複数 APK を使用するアプリを Google Play でダウンロードする場合、次の 2 つの単純なルールで適切な APK が選択されます。

  • マニフェストで特定の APK が適格であることが示されている必要がある
  • 適格な APK のうち、バージョン番号が最も大きいものが優先される

例として、前述の複数 APK のセットを取り上げます。どの APK の最大 API レベルも設定していないと仮定します。個々の APK の考えられる範囲は次のようになります。

3 4 5 6 7 8 9 10 11 12 13 +
3 4 5 6 7 8 9 10 11 12 13 +
3 4 5 6 7 8 9 10 11 12 13 +

minSdkVersion が大きい APK の方がより大きいバージョン コードを持つ必要があるというルールもあるため、versionCode 値については赤 ≥ 緑 ≥ 青であることがわかっています。したがって、結果的にこの図は次のように簡略化できます。

3 4 5 6 7 8 9 10 11 12 13 +

さらに、赤の APK には他の 2 つにない要件があると仮定します。 Android デベロッパー ガイドの Google Play 上のフィルタページには、考えられる要因の完全なリストがあります。例として、赤には前面カメラが必要であるとします。つまり、赤の主要な目的は、API 11 で追加された魅力的な新機能と前面カメラを組み合わせることです。しかし、実のところ、API 11 をサポートするすべてのデバイスに前面カメラが搭載されているわけではありません。その場合はどうなるでしょうか?

幸いなことに、ユーザーがそのようなデバイスで Google Play を閲覧している場合、Google Play はマニフェストを参照して、赤が前面カメラを要件として挙げていることを認識できます。赤とそのデバイスは要件が一致しないと判断され、赤は単純に無視されます。次に、Google Play は、緑が(maxSdkVersion が定義されていないため)API 11 を実行するデバイスと上位互換性があるだけでなく、前面カメラの有無を気にしないことを認識します。この場合、ユーザーは Google Play からアプリをダウンロードできます。デバイスに前面カメラがないのは残念ですが、特定の API レベルをサポートする APK が存在するからです。

すべての APK を別個の「トラック」で保存するには、適切なバージョン コードのスキームを用意することが重要です。デベロッパー ガイドのバージョン コード セクションに記載されているスキームの使用をおすすめします。上記の例の APK セットは 3 つの可能なディメンションのうち 1 つのみを扱うので、各 APK を 1,000 単位で区切り、最初の 2 桁をその特定の APK の minSdkVersion に設定して、そこから増分すれば十分です。次に例を示します。

青: 03001, 03002, 03003, 03004...
緑: 07001, 07002, 07003, 07004...
赤: 11001, 11002, 11003, 11004...

以上をまとめると、Android マニフェストは次のようになります。

青:

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        android:versionCode="03001" android:versionName="1.0" package="com.example.foo">
        <uses-sdk android:minSdkVersion="3" />
        ...
    

緑:

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        android:versionCode="07001" android:versionName="1.0" package="com.example.foo">
        <uses-sdk android:minSdkVersion="7" />
        ...
    

赤:

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        android:versionCode="11001" android:versionName="1.0" package="com.example.foo">
        <uses-sdk android:minSdkVersion="11" />
        ...
    

リリース前チェックリストを確認する

Google Play にアップロードする前に、次の項目を念入りにチェックしてください。次に示すのは複数 APK と特に関連の深い項目であり、Google Play にアップロードするすべてのアプリ用の完全なチェックリストではないことにご注意ください。

  • すべての APK は同じパッケージ名を持つ必要があります
  • すべての APK は同じ証明書で署名する必要があります
  • プラットフォーム バージョンで APK が重複している場合、minSdkVersion が大きい APK の方が、大きいバージョン コードを持つ必要があります
  • マニフェスト フィルタを念入りにチェックして競合する情報がないことを確認します(Cupcake バージョンの特大画面のみをサポートする APK は誰も見ることができません)
  • 各 APK のマニフェストは、サポートされる画面、OpenGL のテクスチャ、プラットフォーム バージョンのうち、少なくとも 1 つで一意であることが必要です
  • 1 台以上のデバイスで各 APK をテストします。それとは別に、開発マシンには、業界で最もカスタマイズしやすいデバイス エミュレータの 1 つが搭載されています。ぜひ利用してください。

また、市場に出す前にコンパイル済みの APK を検査して、アプリが Google Play に表示されるのを妨げるような不測の要因がないかを確認することも重要です。そのためには、「aapt」ツールを使用すると非常に便利です。Aapt(Android Asset Packaging Tool)は、Android アプリを作成およびパッケージ化するビルドプロセスの一部であり、アプリを手軽に検査できるツールでもあります。

    >aapt dump badging
    package: name='com.example.hello' versionCode='1' versionName='1.0'
    sdkVersion:'11'
    uses-permission:'android.permission.SEND_SMS'
    application-label:'Hello'
    application-icon-120:'res/drawable-ldpi/icon.png'
    application-icon-160:'res/drawable-mdpi/icon.png'
    application-icon-240:'res/drawable-hdpi/icon.png'
    application: label='Hello' icon='res/drawable-mdpi/icon.png'
    launchable-activity: name='com.example.hello.HelloActivity'  label='Hello' icon=''
    uses-feature:'android.hardware.telephony'
    uses-feature:'android.hardware.touchscreen'
    main
    supports-screens: 'small' 'normal' 'large' 'xlarge'
    supports-any-density: 'true'
    locales: '--_--'
    densities: '120' '160' '240'
    

aapt の出力を調べる際は、supports-screens と compatible-screens の値が競合していないか、マニフェストで設定した権限の結果として意図しない「uses-feature」値が追加されていないかを確認してください。上記の例では、APK は多くのデバイスで表示されません。

その原因は、必要な SEND_SMS 権限の追加により、android.hardware.telephony の機能要件が暗黙的に追加されたことにあります。API 11 は Honeycomb(タブレット向けに最適化された Android のバージョン)であり、Honeycomb デバイスにはテレフォニー ハードウェアがないため、すべてのケースで Google Play はこの APK を除外します。ただしこれは、将来、より上位の API レベルとテレフォニー ハードウェアの両方を備えたデバイスが登場するまでのことです。

幸いにも、上記の問題は、マニフェストに次の行を追加すれば簡単に解決できます。

    <uses-feature android:name="android.hardware.telephony" android:required="false" />
    

また、android.hardware.touchscreen 要件も暗黙的に追加されます。タッチスクリーンがないデバイスの TV で APK を表示するには、マニフェストに次の行を追加する必要があります。

    <uses-feature android:name="android.hardware.touchscreen" android:required="false" />
    

リリース前チェックリストの確認が完了したら、Google Play に APK をアップロードします。Google Play を閲覧したときにアプリが表示されるまで少し時間がかかることがあります。表示されたら、最後にもう一度チェックを行います。APK が目的のデバイスをターゲットにしていることを確認するため、該当のテストデバイスにアプリをダウンロードします。これで完了です。