web-dev-qa-db-ja.com

Android:Proguardの推奨構成は何ですか?

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ファイルにコメントすることは可能ですか?他の開発者が私が追加した理由について疑問を持たないように、いくつかの行が何をしているのかについてコメントを付けたいと思います。

また、プロガードでは、ファイルのコメントヘッダーを(著作権付きで)維持できますか?そうでない場合、またはそれが良いポリシーではない場合、どこで著作権を追加すべきですか?

64
neteinstein

Android SDK(r20以降)

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

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

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

ここでは、proguard "default"ファイルを確認できます。このファイルは更新を続けます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();
#}
84
neteinstein

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

カスタムビルドの場合、 ProGuardマニュアル > >で最新の推奨構成を見つけることができます A complete Android applicationProguard distribution には、サンプルファイルexamples/Android.proも含まれています。

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

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

10
Eric Lafortune

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

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

これにより、Android SDK。のProguard設定の最新バージョンが使用されます。

2
Michal