web-dev-qa-db-fra.com

Android: Quelles sont les configurations recommandées pour Proguard?

Je développe des applications pour Android et j'utilise Proguard pour masquer le code.

Actuellement, j'utilise des configurations 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

Pour conserver les noms de composants personnalisés utilisés sur les présentations XML:

-keep public class custom.components.**

Pour supprimer les journaux de débogage:

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

Pour éviter de changer les noms des méthodes invoquées sur onClick de la mise en page:

-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 *;
}

La question est (sont):

D'autres balises sont-elles recommandées? Pourquoi et pourquoi?

Est-il possible de faire un commentaire sur un fichier proguard.cfg? Je voudrais l'avoir avec des commentaires sur ce que font certaines lignes pour que les autres développeurs n'aient aucun doute sur la raison pour laquelle j'ai ajouté.

Toujours en cours, est-il possible de conserver l'en-tête de commentaire d'un fichier (avec le copyright)? Si ce n'est pas le cas, ou si ce n'est pas une bonne politique, où dois-je ajouter le droit d'auteur?

androidproguard
64
neteinstein

SDK Android (r20 ou supérieur)

Veuillez vérifier le proguard.config prédéfini référencé dans project.properties

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

Plus d'informations: http://proguard.sourceforge.net/manual/examples.html#androidapplication

Ici, vous pouvez vérifier un fichier proguard "default" que je continue à mettre à jour: https://medium.com/code-procedure-and-rants/Android-my-standard- proguard-ffeceaf65521

SDK Android (r19 ou inférieur)

Basé sur ma réponse Activation de ProGuard dans Eclipse pour Android Je me suis retrouvé avec ce fichier générique. J'ai ajouté des commentaires pour me rappeler à quoi sert chaque ligne. Cela pourrait aider les gens là-bas, alors voici:

-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

Pour les versions standard avec Ant ou Eclipse, le Android SDK (r20 ou supérieur) fournit déjà une configuration appropriée, référencée par la propriété proguard.config dans le fichier project.properties (comme le souligne Michal dans sa réponse). Dans les versions plus anciennes, vous deviez toujours spécifier votre propre configuration complète, donc les conseils plus anciens (comme la première réponse) peuvent conduire à une certaine confusion .

Pour les versions personnalisées , vous pouvez trouver la dernière configuration recommandée dans le manuel ProGuard > Exemples > ne application complète Android . La distribution Proguard contient également des exemples de fichiers/Android.pro

Notamment, vous souhaiterez peut-être conserver les annotations et les paramètres dans les extensions View.

Vous pouvez ajouter des commentaires après un caractère de hachage "#", comme cela a été fait dans les exemples de fichiers.

10
Eric Lafortune

Dans votre fichier de projet appelé project.properties, définissez la valeur suivante:

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

Cela prendra la dernière version des paramètres de Proguard de Android SDK.

2
Michal