How to use the ProGuard in Android Studio?

Question

This is my first project in Android Studio, and the code of my apps are not obfuscated. Im using this configuration in build.gradle file: enter image description here

I'm using the Build > Generate Signed APK... with the Run Proguard checked. And, when I have tested using the Apk_OneClick.v4.2, my code is completly easy to read:

enter image description here

Please, help-me. :(

show your proguard rules defined in text file for obfuscate code. — Piyush Agarwal, Jan 02 '14 at 16:50

Scott Barta · Accepted Answer · 2014-01-02T18:14:52.513

73

You're probably not actually signing the release build of the APK via the signing wizard. You can either build the release APK from the command line with the command:

./gradlew assembleRelease

or you can choose the release variant from the Build Variants view and build it from the GUI:

IDE main window showing Build Variants

edited Jan 02 '14 at 18:14

answered Jan 02 '14 at 17:37

Scott Barta

79,344
24
180
163

Great! I have tested changing the debug to runProguard true and works perfectly. Now I read your reply, and works!!!! Great man! Thank you. – Felipe Porge Xavier Jan 02 '14 at 18:14
Oops, I accidentally put "assembleDebug" instead of "assembleRelease" in my command-line instructions. I fixed my answer. – Scott Barta Jan 02 '14 at 18:15
What is the path of the .apk file that is exported via command line? – Shajeel Afzal May 13 '15 at 19:06

score 50 · Answer 2 · edited Nov 21 '17 at 15:56

You can configure your build.gradle file for proguard implementation. It can be at module level or the project level.

 buildTypes {

    debug {
        minifyEnabled false
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt'

    }

}

The configuration shown is for debug level but you can write you own build flavors like shown below inside buildTypes:

    myproductionbuild{
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt'
    }

Better to have your debug with minifyEnabled false and productionbuild and other builds as minifyEnabled true.

Copy your proguard-rules.txt file in the root of your module or project folder like

$YOUR_PROJECT_DIR\YoutProject\yourmodule\proguard-rules.txt

You can change the name of your file as you want. After configuration use one of the three options available to generate your build as per the buildType

Go to gradle task in right panel and search for assembleRelease/assemble(#your_defined_buildtype) under module tasks
Go to Build Variant in Left Panel and select the build from drop down
Go to project root directory in File Explorer and open cmd/terminal and run

Linux ./gradlew assembleRelease or assemble(#your_defined_buildtype)

Windows gradlew assembleRelease or assemble(#your_defined_buildtype)

You can find apk in your module/build directory.

More about the configuration and proguard files location is available at the link

http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Running-ProGuard

ya, you are correct :) you can see the same in the build Variant tab on left side panel. — Piyush Agarwal, Jan 02 '14 at 16:43
have you written the configuration in proguard-rule.txt see some examples over here http://proguard.sourceforge.net/index.html#manual/examples.html — Piyush Agarwal, Jan 02 '14 at 17:09
runProguard is deprecated. Instead of using runProguard in your gradle file, try using minifyEnabled. see http://stackoverflow.com/a/27052851/3184778 — kouretinho, Feb 19 '15 at 12:54

score 41 · Answer 3 · answered Jan 21 '15 at 13:35

41

NB.: Now instead of

runProguard false

you'll need to use

minifyEnabled false

answered Jan 21 '15 at 13:35

ViliusK

11,345
4
67
71

6

guess it should be sets to true – anna_manzhula Jan 06 '17 at 19:36

score 3 · Answer 4 · answered Jul 23 '19 at 05:21

Here is Some of Most Common Proguard Rules that you need to add in proguard-rules.pro file in Android Sutdio.

ButterKnife

 -keep class butterknife.** { *; }
 -dontwarn butterknife.internal.**
 -keep class **$$ViewBinder { *; }
 -keepclasseswithmembernames class * {
        @butterknife.* <fields>;
  }
 -keepclasseswithmembernames class * {
        @butterknife.* <methods>;
  }

Retrofit

 -dontwarn retrofit.**
 -keep class retrofit.** { *; }
 -keepattributes Signature
 -keepattributes Exceptions

OkHttp3

 -keepattributes Signature
 -keepattributes *Annotation*
 -keep class okhttp3.** { *; }
 -keep interface okhttp3.** { *; }
 -dontwarn okhttp3.** 
 -keep class sun.misc.Unsafe { *; }
 -dontwarn java.nio.file.*
 -dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement

Gson

 -keep class sun.misc.Unsafe { *; }
 -keep class com.google.gson.stream.** { *; }

Code obfuscation

-keepclassmembers class com.yourname.models** { <fields>; }

score 1 · Answer 5 · answered Jan 02 '14 at 15:15

1

Try renaming your 'proguard-rules.txt' file to 'proguard-android.txt' and remove the reference to 'proguard-rules.txt' in your gradle file. The getDefaultProguardFile(...) call references a different default proguard file, one provided by Google and not that in your project. So remove this as well, so that here the gradle file reads:

buildTypes {
    release {
        runProguard true
        proguardFile 'proguard-android.txt'
    }
}

answered Jan 02 '14 at 15:15

Ken

30,811
34
116
155

Don't work for me. I put my custom proguard-android.txt in the same directory by proguard-rules.txt, but nothing has changed in my code. – Felipe Porge Xavier Jan 02 '14 at 15:38

score 0 · Answer 6 · answered Feb 08 '18 at 18:19

The other answers here are great references on using proguard. However, I haven't seen an issue discussed that I ran into that was a mind bender. After you generate a signed release .apk, it's put in the /release folder in your app but my app had an apk that wasn't in the /release folder. Hence, I spent hours decompiling the wrong apk wondering why my proguard changes were having no affect. Hope this helps someone!

score 0 · Answer 7 · answered May 31 '21 at 14:53

0

Enable ProGuard

[ProGuard flow]

android {
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles 'proguard-rules.pro'
        }
    }
}

[ProGuard artefact]

answered May 31 '21 at 14:53

yoAlex5

29,217
8
193
205

How to use the ProGuard in Android Studio?

7 Answers7

Linked