studio - Android: ¿Cuáles son las configuraciones recomendadas para Proguard?

proguard android studio obfuscation

Question

Estoy desarrollando aplicaciones para Android y usando Proguard para ocultar el código.

Actualmente estoy usando configuraciones 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

Para mantener los nombres de componentes personalizados que se utilizan en los diseños XML:

-keep public class custom.components.**

Para eliminar registros de depuración:

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

Para evitar cambiar los nombres de los métodos invocados en el diseño 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 *;
}

La pregunta es (son):

¿Se recomiendan otras etiquetas? ¿Por qué y para qué?

¿Es posible hacer un comentario en un archivo proguard.cfg? Me gustaría tenerlo con comentarios sobre lo que algunas líneas están haciendo para que otros desarrolladores no tengan dudas sobre por qué agregué.

También en proguard, ¿es posible mantener el encabezado de comentario de un archivo (con el copyright)? Si no es así, o no es una buena política, ¿dónde debería agregar los derechos de autor?

Answer 1

En su archivo de proyecto llamado project.properties , establezca el siguiente valor:

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

Esto tomará la última versión de la configuración de Proguard de Android SDK.

Answer 2

Para versiones estándar con Ant o Eclipse, el SDK de Android (r20 o superior) ya proporciona una configuración adecuada, referenciada por la propiedad proguard.config en el archivo project.properties (como señala Michal en su respuesta). En versiones anteriores, siempre tenía que especificar su propia configuración completa, por lo que los consejos más antiguos (como la primera respuesta) pueden generar cierta confusión.

Para compilaciones personalizadas , puede encontrar la última configuración recomendada en el manual de ProGuard > Ejemplos > Una aplicación completa de Android . La distribución Proguard también contiene un ejemplo de archivo examples / android.pro

En particular, es posible que desee conservar las anotaciones y los configuradores en las extensiones de visualización.

Puede agregar comentarios después de un carácter hash ''#'', como se hace extensamente en los archivos de muestra.

Answer 3

Android SDK (r20 o superior)

Compruebe el proguard.config predefinido en project.properties

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

Más información: http://proguard.sourceforge.net/manual/examples.html#androidapplication

Android SDK (r19 o inferior)

Basado en mi respuesta Habilitando ProGuard en Eclipse para Android , terminé con este archivo genérico. He agregado comentarios para recordar para qué sirve cada línea. Puede ayudar a la gente por ahí, así que aquí está:

-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();
#}