How-to

よりスマートな keep ルールをリリースする: ライブラリ プロバイダがアプリレベルの DEX コードの最適化を可能にする方法

所要時間: 6 分
Breana Tate さんのプロフィールを表示
Breana Tate デベロッパー リレーションズ エンジニア

Android アプリとライブラリの開発者は、スムーズなユーザー エクスペリエンスを提供するパフォーマンスの高いアプリという同じ目標を目指しています。その大部分は、Android のアプリ オプティマイザーである R8 に関連しています。R8 は、未使用のコードを削除し、残りのコードを最適化して難読化することで、アプリのパフォーマンスを向上させます。

Google Play は最近、アプリとゲームに関する DEX コードの最適化の新しいしきい値を発表しました。これは、起動時間の短縮、メモリ使用量の削減、そして過剰なメモリを使用するアプリからユーザー エクスペリエンスを保護するという Android の取り組みに沿ったものです。これらのしきい値はアプリとゲームに適用されますが、しきい値を満たすことはエコシステム全体での責任の共有です。R8 は、アプリが依存するライブラリにバンドルされているキープルールなど、指定されたパラメータ内でのみアプリを最適化できます。

R8 構成アナライザは、Google Play の技術要件の中核となる、アプリの最適化、圧縮、難読化の割合を評価するための優れたツールです。R8 Configuration Analyzer は、これらの割合を追跡するだけでなく、アプリだけでなく、アプリが依存するライブラリにバンドルされているコンシューマーの Keep ルールに起因する非効率な Keep ルールも検出します。

このガイドでは、ライブラリ プロバイダが直面する一般的な課題を解決し、狭い範囲で高性能なルールを適用して、お客様が Google Play の技術要件を満たせるようにする方法について説明します。

コンシューマー保持ルールとは

コンシューマー保持ルールは、Android ライブラリまたは JAR ライブラリにバンドルされている指示です。この指示は、アプリレベルのコンパイル プロセス中に最適化されない可能性があるライブラリ コードの部分を R8 に伝えます。アーティファクトの圧縮に使用されるアプリまたはライブラリによって記述される標準の keep ルールとは異なり、コンシューマー keep ルールはライブラリ内に埋め込まれ、アプリ全体の最適化中にライブラリがどのように圧縮されるかに影響します。これにより、アプリ デベロッパーが手動で識別しなくても、内部リフレクション ターゲットとネイティブ インターフェースがそのまま維持されます。

意図的に、狭い範囲に限定したコンシューマー保持ルールは、ライブラリとそれを使用するアプリの両方にメリットをもたらす重要なベスト プラクティスです。コンシューマーの保持ルールが広すぎると、未使用のコードが保持され、アプリの最適化とパフォーマンスに影響します。DEX コードの最適化に関する分析情報が Google Play Console に追加されたことで、アプリ デベロッパーに表示される指標は、アプリとその統合ライブラリの両方のルールの複合的な影響を表すようになります。

安定性とパフォーマンスのバランスを取る

ライブラリ プロバイダは、多くの場合、幅広いコンシューマーの保持ルールを配布することを意図しています。リフレクション中にクラスが削除されたことが原因で SDK がクラッシュすることは、誰も望んでいません。

ただし、パッケージ全体またはその他の広範な keep ルールは、R8 のプログラム全体のアプリ最適化の可能性を著しく制限するため、クラッシュ防止の長期的なソリューションとしてはおすすめしません。安定性を損なうことなく、範囲を絞った高パフォーマンスのルールをリリースするためのおすすめの戦略をいくつかご紹介します。

1. 狭いルールのテストとロールアウト

狭いルールを安心してリリースできるように、次のベスト プラクティスを検討してください。

  • サンプルアプリでテストする: 最適化をテストするのローカルテスト ガイダンスは、サンプルアプリにも適用されます。R8 を有効にした後、クリティカル ユーザー ジャーニーをテストして、機能が想定どおりに動作することを確認します。
  • サンプルアプリで R8 構成アナライザを実行して、アプリ デベロッパーが R8 構成を監査するときに表示される内容を確認します。これにより、保持ルールが下流のアプリに与える影響を簡単に可視化できます。
  • Android CLI の analyze コマンドを使用して、保持されているメソッド、クラス、フィールドなど、AAR または JAR の最適化を評価します。これらの数値をリリース間で比較して、回帰をモニタリングできます。
  • Google Play SDK Console でライブラリ バージョンの使用状況とクラッシュをモニタリングする。
  • ベスト プラクティスについては、ライブラリ作成者向けの最適化のガイダンスと R8 のドキュメントをご覧ください。

2. 広範な keep ルールを使用せずにリフレクションと JNI ターゲットを保持する

広範な keep ルールやパッケージ全体の keep ルールを適用したライブラリを配布すると、SDK に影響するだけでなく、デベロッパーはコードの肥大化を受け入れざるを得なくなります。その結果、アプリの起動時間が遅くなり、アプリのダウンロード サイズ、メモリ使用量、ANR 発生率が増加します。また、パフォーマンスを重視するアプリでは、ライブラリにバンドルされているルールを置き換えるカスタムルールを作成する可能性もあります。これにより、リスクを軽減するために、これらのアプリが将来のライブラリ アップデートを採用するのを妨げることにもなります。

SDK がゲームや写真 / 動画エディタなどのネイティブ コードをターゲットにしている場合は、JNI を使用するすべてのクラスのルールを指定します。ほとんどのゲームは、Unity や Unreal などのゲームエンジン上で動作し、ゲームをネイティブ コードにコンパイルします。ゲームのネイティブ コードとプラグインは、JNI 呼び出しを介して Android フレームワークと通信します。

Jetpack Keep アノテーション(アルファ版)を使用すると、リフレクションの使用にアノテーションを付けることで、リフレクションに必要なメンテナンスを削減できます。このアノテーションは、ビルド時に保持ルールを生成するために使用できます。

リフレクションよりもコード生成を検討する

リフレクションによるクラッシュを回避するための最大のヒントは、リフレクションを避け、可能な限り codegen を使用することです。

ランタイム リフレクションは、コンパイル中に R8 からコードの使用を隠すため、クラッシュを回避するには keep ルールが必要です。codegen を使用すると、ビルドプロセス中にコードが最適化されるため、R8 は最小限の keep ルールでコードを安全に最適化するために必要な可視性を得ることができます。codegen が適している一般的なシナリオとしては、シリアル化と逆シリアル化、依存関係インジェクション(codegen を使用するライブラリの例として Hilt があります)などがあります。

ただし、codegen がすべてのシナリオに適しているわけではありません。オプションの依存関係などのパターンでは、リフレクションが引き続き必要です。オプションの依存関係をサポートするリフレクションのガイダンスで説明されているように、リフレクションと、必要なエントリ ポイントのみを保護する狭い keep ルールを組み合わせることをおすすめします。

事前最適化されたライブラリ ビルドであっても、ルールのスコープを狭くする

リフレクションを回避できない場合は、コンシューマーの keep ルールで、ライブラリがリフレクションする対象のみを指定するようにします。ライブラリがクラスまたはメソッドに動的にアクセスする場合は、エントリ ポイントを指定するだけで、残りは R8 が処理します。R8 は、エントリ ポイントを使用して参照されるコードのグラフを作成し、参照されていないクラス、メソッド、フィールドを削除します。

これは、ライブラリ ビルドをすでに最適化または難読化している場合にも当てはまります。これは、パフォーマンスが高く軽量な SDK を実現するための優れた方法です。ルールはアプリのコンパイル ステップで適用されるため、R8 は、ダウンストリーム アプリで使用される実際のクラスとメソッドに基づいて、ライブラリをさらに最適化できます。Android CLI の analyze コマンドは、最適化の妨げとなっている、使用されているパッケージ全体の keep ルールと使用されていないパッケージ全体の keep ルールの両方を事前に検出します。

サードパーティの依存関係の保持ルールを狭く設定する

よく見られるパターンは次のとおりです。

-keep public class com.google.android.gms.** { *; }

SDK を統合するアプリが別の GMS ライブラリも使用しており、保持するコードの量を制限する keep ルールが含まれている場合、この広範なルールが優先され、アプリが不必要に肥大化する原因となります。

外部ライブラリを呼び出す場合は、ライブラリがリフレクションを介してアクセスする特定の要素のみを厳密に保持する keep ルールを設計する必要があります。さらに、実際には、多くのライブラリ(GMS を含む)が独自のコンシューマー保持ルールをすでに提供しています。パッケージ全体の保持ルールを導入すると、ダウンストリーム ライブラリから、慎重に作成された、範囲の狭いコンシューマー ルールも取り込まれる可能性があります。

広告メディエーション アダプターの条件付き保持ルールを検討する

広告ライブラリがメディエーション アダプタを使用して読み込まれる場合は、限定的な keep ルールを使用することもできます。このシナリオでは、条件付き保持ルールを使用して、アプリに対応するアダプターが含まれている場合にのみ、特定の機能またはフォーマットを保持することをおすすめします。これにより、R8 はアプリで使用されていない機能を圧縮できます。別の方法として、複雑なルールを手動で作成する代わりに、Jetpack Keep アノテーションを使用して、ソースコード内でリフレクション呼び出しに直接アノテーションを付け、条件付きのコンシューマー保持ルールを自動的に生成することもできます。これには、オプションのアドオン モジュールも含まれます。

ドキュメントではなく、コンシューマー ルールでルールを配布する

ライブラリにコンシューマー ルールを同梱することで、R8 対応ビルドのアプリがライブラリをすぐに使用できるようになり、最適化を最大限に活用できます。

ドキュメントでルールを指定すると、手動設定の摩擦が増え(特に、バンドルされたコンシューマーの保持ルールが AAR と JAR で長年サポートされているため)、継続的なメンテナンス オーバーヘッドが発生します。ライブラリを更新する(リファクタリング、クラス名の変更、リフレクションの使用方法の変更など)場合は、ドキュメントを更新する必要があります。また、アプリは新しいルールを確認する必要があります。時間の経過とともに、アプリがライブラリの複数のバージョンにアップグレードされると、不要になった以前の keep ルールが蓄積され、アプリが不必要に肥大化する可能性があります。

3. リリース スタック トレースの読み取り

難読化されたコードが原因で、スタック トレースが読み取れなかった可能性があります。重要な分析をブロック解除するために、keepnames を使用したくなるかもしれません。これは圧縮を可能にしますが、スタック トレースのデバッグ時に必要な正確な値である、ユーザーアプリでの名前変更などの追加の最適化を妨げます。

読み取り可能なスタック トレースを取得するために、追加の最適化を防止する必要はありません。

Firebase Crashlytics、Google Play Console、Android Studio の Logcat は、アプリ デベロッパー向けにスタック トレースを難読化解除します。つまり、アプリ デベロッパーがスタック トレースを共有する場合、難読化を防止しなくても読み取ることができます。

マッピング ファイルを SDK Console にアップロードすると、SDK Console で難読化解除されたスタック トレースを確認できるようになります。

最適化の推測を排除する

ライブラリの最適化は、試行錯誤のゲームのように感じるべきではありません。

コンシューマーの保持ルールを維持することで、ライブラリ プロバイダは、エコシステム全体のアプリが最適化からブロックされないようにすることができます。

ライブラリがより優れたルールを提供すると、アプリはより小さく、より高速になります。コンシューマー保持ルールの監査を今すぐ開始して、ライブラリに依存するアプリが最高のパフォーマンスを発揮できるようにしましょう。

作成者:
続きを読む