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? Я хотел бы иметь его с комментариями о том, что делают некоторые строки, чтобы у других разработчиков не было сомнений относительно того, почему я добавил.

Также в proguard можно ли сохранить заголовок комментария к файлу (с авторскими правами)? Если это не так, или это не очень хорошая политика, где я должен добавить авторские права?


person neteinstein    schedule 21.02.2011    source источник


Ответы (3)


Android SDK (версия 20 или выше)

Пожалуйста, проверьте предопределенный proguard.config, указанный в project.properties.

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

Дополнительная информация: http://proguard.sourceforge.net/manual/examples.html#androidapplication

Здесь вы можете проверить файл proguard "по умолчанию", который я постоянно обновляю: https://medium.com/code-procedure-and-rants/android-my-standard-proguard-ffeceaf65521


Android SDK (версия 19 или более ранняя)

Основываясь на моем ответе Включение ProGuard в Eclipse для Android, я в конечном итоге с этим общим файлом. Я добавил комментарии, чтобы помнить, для чего предназначена каждая строка. Это может помочь людям, поэтому вот оно:

-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();
#}
person neteinstein    schedule 27.06.2011
comment
:Здравствуйте, я пытаюсь прочитать, как реализовать proguard в своем приложении, но я не могу точно понять, что я должен делать. Включаю строку proguard.config=${sdk.dir}/tools/proguard/proguard-android. txt:proguard-project.txt достаточно?Это будет сделано автоматически?Или я должен сделать что-то еще?Вы знаете, где я могу найти руководство для этого?Потому что я не понимаю с сайта разработчиков.Спасибо! - person George; 28.05.2013
comment
Достаточно ли включить строку proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project‌​.txt? Да, если вам не нужны определенные конфигурации. - person neteinstein; 26.02.2014

Для стандартных сборок с Ant или Eclipse Android SDK (r20 или выше) уже предоставляет подходящую конфигурацию, на которую ссылается свойство proguard.config в файле project.properties (как указывает Михал в своем ответе ). В более старых версиях вам всегда приходилось указывать свою полную конфигурацию, поэтому старый совет (например, первый ответ) может привести к некоторой путанице.

Для пользовательских сборок последнюю рекомендуемую конфигурацию можно найти в руководстве по ProGuard > Примеры > Полное приложение для Android. дистрибутив Proguard также содержит образец файла examples/android.pro.

В частности, вы можете захотеть сохранить аннотации и сеттеры в расширениях представления.

Вы можете добавлять комментарии после решетчатого символа '#', как это часто делается в примерах файлов.

person Eric Lafortune    schedule 21.02.2011

В файле проекта с именем project.properties установите следующее значение:

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

Для этого потребуется последняя версия настроек Proguard из Android SDK.

person Michal    schedule 20.03.2013
comment
Я хочу попробовать этот метод. Однако в папке моего проекта нет файла «project.properties». Должен ли я создать его в корневой папке проекта? - person Hendra Anggrian; 28.06.2016