Urban Airship: Powering Modern Mobile
  • Ask the Community
  • Get Personal Help

Support Center

Deploying your Android App with ProGuard

Last Updated: Mar 26, 2014 11:27AM PDT


ProGuard is a Java obfuscation and minification tool commonly used both to reduce the size of a JAR file as well as to make it more difficult to reverse engineer. In the Android developer documentation, Google recommends using ProGuard to slim down your app prior to deploying it in production.  

The guidelines mentioned in the documentation linked above are sufficient for many uses, but if you choose to use ProGuard on your .apk file prior to launch, there are a few extra steps you will need to follow to maintain compatibility with the Urban Airship library.  Provided below are the contents of a sample proguard.cfg file distributed with our PushSample app, which protects against over-obfuscation.

Sample proguard.cfg file

# This is a configuration file for ProGuard.
# http://proguard.sourceforge.net/index.html#manual/usage.html


# Optimization is turned off by default. Dex does not like code run
# through the ProGuard optimize and preverify steps (and performs some
# of these optimizations on its own).
# Note that if you want to enable optimization, you cannot just
# include optimization flags in your own project configuration file;
# instead you will need to point to the
# "proguard-android-optimize.txt" file instead of this one from your
# project.properties file.

-keepattributes *Annotation*
-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService

# For native methods, see http://proguard.sourceforge.net/manual/examples.html#native
-keepclasseswithmembernames class * {
    native <methods>;

# keep setters in Views so that animations can still work.
# see http://proguard.sourceforge.net/manual/examples.html#beans
-keepclassmembers public class * extends android.view.View {
   void set*(***);
   *** get*();

# We want to keep methods in Activity that could be used in the XML attribute onClick
-keepclassmembers class * extends android.app.Activity {
   public void *(android.view.View);

# For enumeration classes, see http://proguard.sourceforge.net/manual/examples.html#enumerations
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);

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

-keepclassmembers class **.R$* {
    public static <fields>;

# The support library contains references to newer platform versions.
# Don't warn about those in case this app is linking against an older
# platform version.  We know about them, and they are safe.
-dontwarn android.support.**