ProGuard

[アーティクル]
03/01/2018

Xamarin.Android ProGuard は、Java クラスファイルのシュリンカー、オプティマイザー、および事前検証機能です。これは、未使用のコードを検出して削除し、バイトコードの分析と最適化を行います。このガイドでは、ProGuard がどのように機能するか、プロジェクトで有効にする方法、および設定方法について説明します。また、ProGuard の設定例もいくつか示します。

概要

ProGuard は、パッケージ化されたアプリケーションから使われていないクラス、フィールド、メソッド、属性を検出して削除します。参照されているライブラリに対して同じ処理を行うこともできます (これは、64k 参照制限を防ぐのに役立つことがあります)。 Android SDK の ProGuard ツールもバイトコードを最適化し、未使用のコードの指示を削除します。 ProGuard は、入力 jar を読み取り、圧縮、最適化、事前検証します。結果を 1 つ以上の出力 jar に書き込みます。

ProGuard は、以下の手順を使って入力 APK を処理します。

縮小ステップ – ProGuard は、使用するクラスとクラスメンバーを再帰的に特定します。他のすべてのクラスおよびクラスメンバーは破棄されます。
最適化ステップ – ProGuard はコードをさらに最適化します。たとえば、エントリポイントではないクラスとメソッドを private、static、または final にし、使われていないパラメーターを削除し、一部のメソッドをインライン化します。
難読化ステップ – ネイティブの Android 開発では、ProGuard がエントリポイントではないクラスおよびクラスメンバーの名前を変更します。エントリポイントの名前は維持し、元の名前でアクセスできるようにします。ただし、アプリは中間言語 (IL) にコンパイルされるため、Xamarin.Android ではこの手順がサポートされません。
事前検証ステップ – 実行前に Java バイトコードのチェックを行い、Java VM のためにクラスファイルに注釈を付けます。これは、エントリポイントを知る必要がない唯一のステップです。

これらの各ステップは "省略可能" です。次のセクションで説明するように、Xamarin.Android の ProGuard はこれらのステップのサブセットのみを使います。

Xamarin.Android での ProGuard

Xamarin.Android ProGuard の構成では、APK は難読化されません。それどころか、ProGuard を使用して難読化を有効にすることはできません (カスタム構成ファイルを使用しても)。したがって、Xamarin.Android の ProGuard は、圧縮ステップと最適化ステップのみを実行します。

ProGuard を使う前に知っておく必要のある重要なことは、Xamarin.Android のビルドプロセスにおけるその動作方法です。このプロセスでは次の 2 つの個別のステップが使われます。

Xamarin Android リンカー
ProGuard

次に各ステップについて詳しく説明します。

リンカーステップ

Xamarin.Android リンカーは、アプリケーションの静的分析を使って次のことを特定します。

実際に使われているアセンブリ。
実際に使われている型。
実際に使われているメンバー。

リンカーは常に ProGuard ステップの前に実行されます。このため、リンカーは、ProGuard で処理されると予想されるアセンブリ/型/メンバーを除去することがあります (Xamarin.Android でのリンクの詳細については、「Linking on Android」(Android でのリンク) をご覧ください)。

ProGuard ステップ

リンカーステップが正常に完了した後は、ProGuard が実行されて未使用の Java バイトコードが削除されます。これは、APK を最適化するステップです。

ProGuard の使用

ProGuard をアプリプロジェクトを使用するには、まず ProGuard を有効にする必要があります。次に、Xamarin.Android のビルドプロセスに既定の ProGuard 構成ファイルを使用させるか、または ProGuard 用に独自のカスタム構成ファイルを作成することができます。

ProGuard の有効化

ProGuard をアプリプロジェクトで有効にするには、次の手順を使います。

プロジェクトがリリース構成に設定されていることを確認してください (これは、ProGuard が実行するにはリンカーが実行している必要があるため重要なことです)。
[プロパティ] > [Android オプション] ウィンドウで、[コード shrinker] ドロップダウンリストから [ProGuard] を選択します。

ほとんどの Xamarin.Android アプリでは、Xamarin.Android によって提供される既定の ProGuard 構成ファイルを使用すると、すべての未使用コード (のみ) を削除するのに十分です。既定の ProGuard 構成を表示するには、obj\Release\proguard\proguard_xamarin.cfg ファイルを開きます。

次の例は、一般的に生成される proguard_xamarin.cfg ファイルを示しています。

# This is Xamarin-specific (and enhanced) configuration.

-dontobfuscate

-keep class mono.MonoRuntimeProvider { *; <init>(...); }
-keep class mono.MonoPackageManager { *; <init>(...); }
-keep class mono.MonoPackageManager_Resources { *; <init>(...); }
-keep class mono.android.** { *; <init>(...); }
-keep class mono.java.** { *; <init>(...); }
-keep class mono.javax.** { *; <init>(...); }
-keep class opentk.platform.android.AndroidGameView { *; <init>(...); }
-keep class opentk.GameViewBase { *; <init>(...); }
-keep class opentk_1_0.platform.android.AndroidGameView { *; <init>(...); }
-keep class opentk_1_0.GameViewBase { *; <init>(...); }

-keep class android.runtime.** { <init>(***); }
-keep class assembly_mono_android.android.runtime.** { <init>(***); }
# hash for android.runtime and assembly_mono_android.android.runtime.
-keep class md52ce486a14f4bcd95899665e9d932190b.** { *; <init>(...); }
-keepclassmembers class md52ce486a14f4bcd95899665e9d932190b.** { *; <init>(...); }

# Android's template misses fluent setters...
-keepclassmembers class * extends android.view.View {
   *** set*(***);
}

# also misses those inflated custom layout stuff from xml...
-keepclassmembers class * extends android.view.View {
   <init>(android.content.Context,android.util.AttributeSet);
   <init>(android.content.Context,android.util.AttributeSet,int);
}

次のセクションでは、カスタマイズした ProGuard 構成ファイルを作成する方法について説明します。

ProGuard のカスタマイズ

必要に応じて、カスタム ProGuard 構成ファイルを追加し、ProGuard ツールをより厳密に制御することができます。たとえば、ProGuard に維持するクラスを明示的に指示できます。そのためには、新しい .cfg ファイルを作成し、[ソリューションエクスプローラー] の [プロパティ] ウィンドウで ProGuardConfiguration ビルドアクションを適用します。

この構成ファイルは Xamarin.Android の proguard_xamarin.cfg ファイルの代わりに使用するものではないことに注意してください。ProGuard は両方のファイルを使用します。

ProGuard がアプリケーションを正しく分析できない場合があります。アプリケーションが実際に必要とするコードが削除される可能性があります。その場合は、-keep 行をカスタム ProGuard 構成ファイルに追加します。

-keep public class MyClass

次の例では、ProGuard でスキップするクラスの実際の名前として MyClass を設定しています。

[Register] 注釈で独自の名前を登録し、その名前を使って ProGuard のルールをカスタマイズすることもできます。 Adapters、Views、BroadcastReceivers、Services、ContentProviders、Activities、Fragments の名前を登録できます。 [Register] カスタム属性の使用の詳細については、「Working with JNI」(JNI の処理) をご覧ください。

ProGuard のオプション

ProGuard には、操作をきめ細かく制御するために構成できる複数のオプションが用意されています。 ProGuard のマニュアルでは、ProGuard を使うための完全なリファレンスドキュメントが提供されています。

Xamarin.Android では、次の ProGuard オプションがサポートされています。

以下のオプションは、Xamarin.Android では "無視" されます。

ProGuard と Android Nougat

ProGuard を Android 7.0 以降に対して使用する場合は、Android SDK には JDK 1.8 と互換性がある新しいバージョンが含まれていないため、ProGuard の新しいバージョンをダウンロードする必要があります。

この NuGet パッケージを使用して、proguard.jar の新しいバージョンをインストールできます。 Android SDK の既定の proguard.jar の更新の詳細については、こちらの Stack Overflow をご覧ください。

SourceForge ページで ProGuard のすべてのバージョンを見つけることができます。

ProGuard の構成例

ProGuard 構成ファイルの 2 つの例を次に示します。これらの例では、Xamarin.Android ビルドプロセスが入力、出力、ライブラリの各 jar を提供することに注意してください。したがって、-keep などの他のオプションに集中できます。

簡単な Android アクティビティ

単純な Android アクティビティの構成例を次に示します。

-injars  bin/classes
-outjars bin/classes-processed.jar
-libraryjars /usr/local/java/android-sdk/platforms/android-9/android.jar

-dontpreverify
-repackageclasses ''
-allowaccessmodification
-optimizations !code/simplification/arithmetic

-keep public class mypackage.MyActivity

完全な Android アプリケーション

機能が一式そろった Android アプリの構成例を次に示します。

-injars  bin/classes
-injars  libs
-outjars bin/classes-processed.jar
-libraryjars /usr/local/java/android-sdk/platforms/android-9/android.jar

-dontpreverify
-repackageclasses ''
-allowaccessmodification
-optimizations !code/simplification/arithmetic
-keepattributes *Annotation*

-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-keep public class * extends android.app.Service
-keep public class * extends android.content.BroadcastReceiver
-keep public class * extends android.content.ContentProvider

-keep public class * extends android.view.View {
public <init>(android.content.Context);
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
public void set*(...);
}

-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet);
}

-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet, int);
}

-keepclassmembers class * implements android.os.Parcelable {
static android.os.Parcelable$Creator CREATOR;
}

-keepclassmembers class **.R$* {
public static <fields>;
}

ProGuard と Xamarin.Android のビルドプロセス

次のセクションでは、Xamarin.Android のリリース ビルドの間の ProGuard の動作について説明します。

ProGuard が実行するコマンド

ProGuard は単に、Android SDK で提供される .jar です。したがって、コマンドで呼び出されます。

java -jar proguard.jar options ...

ProGuard タスク

ProGuard タスクは Xamarin.Android.Build.Tasks.dll アセンブリ内にあります。 _CompileToDalvikWithDx ターゲットの一部であり、これは _CompileDex ターゲットの一部です。

次のリストでは、[ファイル] > [新しいプロジェクト] を使用して新しいプロジェクトを作成した後に生成される既定のパラメーターの例を示します。

ProGuardJarPath = C:\Android\android-sdk\tools\proguard\lib\proguard.jar
AndroidSdkDirectory = C:\Android\android-sdk\
JavaToolPath = C:\Program Files (x86)\Java\jdk1.8.0_92\\bin
ProGuardToolPath = C:\Android\android-sdk\tools\proguard\
JavaPlatformJarPath = C:\Android\android-sdk\platforms\android-25\android.jar
ClassesOutputDirectory = obj\Release\android\bin\classes
AcwMapFile = obj\Release\acw-map.txt
ProGuardCommonXamarinConfiguration = obj\Release\proguard\proguard_xamarin.cfg
ProGuardGeneratedReferenceConfiguration = obj\Release\proguard\proguard_project_references.cfg
ProGuardGeneratedApplicationConfiguration = obj\Release\proguard\proguard_project_primary.cfg
ProGuardConfigurationFiles

    {sdk.dir}tools\proguard\proguard-android.txt;
    {intermediate.common.xamarin};
    {intermediate.references};
    {intermediate.application};
    ;

JavaLibrariesToEmbed = C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\MonoAndroid\v7.0\mono.android.jar
ProGuardJarInput = obj\Release\proguard\__proguard_input__.jar
ProGuardJarOutput = obj\Release\proguard\__proguard_output__.jar
DumpOutput = obj\Release\proguard\dump.txt
PrintSeedsOutput = obj\Release\proguard\seeds.txt
PrintUsageOutput = obj\Release\proguard\usage.txt
PrintMappingOutput = obj\Release\proguard\mapping.txt

次の例では、IDE から実行される一般的な ProGuard コマンドを示します。

C:\Program Files (x86)\Java\jdk1.8.0_92\\bin\java.exe -jar C:\Android\android-sdk\tools\proguard\lib\proguard.jar -include obj\Release\proguard\proguard_xamarin.cfg -include obj\Release\proguard\proguard_project_references.cfg -include obj\Release\proguard\proguard_project_primary.cfg "-injars 'obj\Release\proguard\__proguard_input__.jar';'C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\MonoAndroid\v7.0\mono.android.jar'" "-libraryjars 'C:\Android\android-sdk\platforms\android-25\android.jar'" -outjars "obj\Release\proguard\__proguard_output__.jar" -optimizations !code/allocation/variable

トラブルシューティング

ファイルの問題

ProGuard が構成ファイルを読み取るときに、次のエラーメッセージが表示されることがあります。

Unknown option '-keep' in line 1 of file 'proguard.cfg'

Windows でこの問題が発生するのは、通常、.cfg ファイルのエンコーディングが正しくないためです。 ProGuard は、テキストファイルに存在する可能性がある "バイトオーダーマーク" (BOM) を処理できません。 BOM が存在する場合、ProGuard は上記のエラーで終了します。

Visual Studio
Visual Studio for Mac

この問題を回避するには、BOM なしでファイルを保存できるテキストエディターでカスタム構成ファイルを編集します。この問題を解決するには、テキストエディターのエンコードを UTF-8 に設定します。たとえば、Notepad++ テキストエディターでは、[Encoding]\(エンコード\) > [Encode in UTF-8 Without BOM]\(BOM なしの UTF-8 でエンコードする\) を選ぶことにより、BOM を使わずにファイルを保存できます。

その他の問題

ProGuard を使うと発生する可能性がある一般的な問題と解決策については、ProGuard の「Troubleshooting」(トラブルシューティング) ページをご覧ください。

まとめ

このガイドでは、Xamarin.Android での ProGuard の機能、アプリプロジェクトで有効にする方法、および設定方法について説明しました。 ProGuard の構成の例を示し、一般的な問題の対処方法を説明します。 ProGuard ツールと Android の詳細については、「Shrink Your Code and Resources」(コードとリソースの圧縮) をご覧ください。

リリースに向けてアプリケーションを準備する

次の方法で共有

ProGuard

概要

Xamarin.Android での ProGuard

リンカーステップ

ProGuard ステップ

ProGuard の使用

ProGuard の有効化

ProGuard のカスタマイズ

ProGuard のオプション

ProGuard と Android Nougat

ProGuard の構成例

簡単な Android アクティビティ

完全な Android アプリケーション

ProGuard と Xamarin.Android のビルドプロセス

ProGuard が実行するコマンド

ProGuard タスク

トラブルシューティング

ファイルの問題

その他の問題

まとめ

その他のリソース

次の方法で共有

ProGuard

概要

Xamarin.Android での ProGuard

リンカー ステップ

ProGuard ステップ

ProGuard の使用

ProGuard の有効化

ProGuard のカスタマイズ

ProGuard のオプション

ProGuard と Android Nougat

ProGuard の構成例

簡単な Android アクティビティ

完全な Android アプリケーション

ProGuard と Xamarin.Android のビルド プロセス

ProGuard が実行するコマンド

ProGuard タスク

トラブルシューティング

ファイルの問題

その他の問題

まとめ

関連リンク

その他のリソース

リンカーステップ

ProGuard と Xamarin.Android のビルドプロセス