android - Android：Proguardの推奨構成は何ですか？

Question

私はAndroid用のアプリを開発しており、Proguardを使用してコードを難読化しています。

現在、ProGuard構成を使用しています。

-optimizationpasses 5
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-dontpreverify
-verbose
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*

-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 com.android.vending.licensing.ILicensingService

レイアウトXMLで使用されるカスタムコンポーネント名を維持するには：

-keep public class custom.components.**

デバッグログを削除するには：

-assumenosideeffects class android.util.Log {
    public static *** d(...);
    public static *** v(...);
}

レイアウトのonClickで呼び出されるメソッドの名前を変更しないようにするには：

-keepclassmembers class * {
 public void onClickButton1(android.view.View);
 public void onClickButton2(android.view.View);
 public void onClickButton3(android.view.View);
}

-keepclasseswithmembernames class * {
    native <methods>;
}

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

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

-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}

質問は（あります）：

他のタグをお勧めしますか？なぜそして何のために？

proguard.cfgファイルにコメントを付けることは可能ですか？他の開発者が私が追加した理由について疑問を持たないように、いくつかの行が何をしているのかについてコメントを付けてもらいたいと思います。

また、プロガードでは、ファイルのコメントヘッダーを（著作権で）維持することは可能ですか？そうでない場合、またはそれが適切なポリシーではない場合、どこに著作権を追加する必要がありますか？

Answer 1

Android SDK (r20 以降)

project.properties で参照されている定義済みの proguard.config を確認してください

proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt

詳細: http://proguard.sourceforge.net/manual/examples.html#androidapplication

ここで、私が更新し続けるプロガードの「デフォルト」ファイルを確認できます: https://medium.com/code-procedure-and-rants/android-my-standard-proguard-ffeceaf65521

---

Android SDK (r19 以前)

Android 用の Eclipse で ProGuard を有効にするという私の回答に基づいて、この汎用ファイルを作成しました。各行の目的を覚えておくためにコメントを追加しました。それはそこにいる人々を助けるかもしれないので、ここにあります：

-optimizationpasses 5

#When not preverifing in a case-insensitive filing system, such as Windows. Because this tool unpacks your processed jars, you should then use:
-dontusemixedcaseclassnames

#Specifies not to ignore non-public library classes. As of version 4.5, this is the default setting
-dontskipnonpubliclibraryclasses

#Preverification is irrelevant for the dex compiler and the Dalvik VM, so we can switch it off with the -dontpreverify option.
-dontpreverify

#Specifies to write out some more information during processing. If the program terminates with an exception, this option will print out the entire stack trace, instead of just the exception message.
-verbose

#The -optimizations option disables some arithmetic simplifications that Dalvik 1.0 and 1.5 can't handle. Note that the Dalvik VM also can't handle aggressive overloading (of static fields).
#To understand or change this check http://proguard.sourceforge.net/index.html#/manual/optimizations.html
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*

#To repackage classes on a single package
#-repackageclasses ''

#Uncomment if using annotations to keep them.
#-keepattributes *Annotation*

#Keep classes that are referenced on the AndroidManifest
-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 com.android.vending.licensing.ILicensingService


#To remove debug logs:
-assumenosideeffects class android.util.Log {
    public static *** d(...);
    public static *** v(...);
}

#To avoid changing names of methods invoked on layout's onClick.
# Uncomment and add specific method names if using onClick on layouts
#-keepclassmembers class * {
# public void onClickButton(android.view.View);
#}

#Maintain java native methods 
-keepclasseswithmembernames class * {
    native <methods>;
}

#To maintain custom components names that are used on layouts XML.
#Uncomment if having any problem with the approach below
#-keep public class custom.components.package.and.name.**

#To maintain custom components names that are used on layouts XML:
-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);
}

#Maintain enums
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

#To keep parcelable classes (to serialize - deserialize objects to sent through Intents)
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}

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

###### ADDITIONAL OPTIONS NOT USED NORMALLY

#To keep callback calls. Uncomment if using any
#http://proguard.sourceforge.net/index.html#/manual/examples.html#callback
#-keep class mypackage.MyCallbackClass {
#   void myCallbackMethod(java.lang.String);
#}

#Uncomment if using Serializable 
#-keepclassmembers class * implements java.io.Serializable {
#    private static final java.io.ObjectStreamField[] serialPersistentFields;
#    private void writeObject(java.io.ObjectOutputStream);
#    private void readObject(java.io.ObjectInputStream);
#    java.lang.Object writeReplace();
#    java.lang.Object readResolve();
#}

Answer 2

Ant または Eclipse を使用した標準ビルドの場合、Android SDK (r20 以降) は、ファイル project.properties のプロパティ proguard.config によって参照される適切な構成を既に提供しています (Michal が回答で指摘しているように)。古いリリースでは、常に独自の完全な構成を指定する必要があったため、古いアドバイス (最初の回答など) は混乱を招く可能性があります。

カスタム ビルドの場合、最新の推奨構成はProGuard マニュアル> Examples > A complete Android application にあります。Proguard ディストリビューションには、サンプル ファイルの examples/android.pro も含まれています。

特に、View 拡張機能で注釈とセッターを保持したい場合があります。

サンプル ファイルで広く行われているように、ハッシュ文字「#」の後にコメントを追加できます。

Answer 3

project.propertiesというプロジェクトファイルで、次の値を設定します。

proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt

これにより、AndroidSDKから最新バージョンのProguard設定が取得されます。