ProGuard介绍

ProGuard是一个Java类文件压缩器,优化器,混淆器和预先文件验证器。 压缩步骤检测和删除未使用的类,字段,方法和属性。 优化步骤分析和优化方法的字节码。 混淆步骤使用短无意义的名称重命名剩余的类,字段和方法。 这些步骤使代码更小,更高效,更难以进行逆向工程。 最终的预验证步骤将预验证信息添加到类,这是Java Micro Edition和Java 6及更高版本所必需的。

所以我们可以通过开启 ProGuard 来去除未使用的类、字段、方法和属性,包括自带代码库中的未使用项,这样就以变通方式解决了 64k 限制的问题。同时ProGuard 还可优化字节码,移除未使用的代码指令,以及用短名称混淆其余的类、字段和方法。这样也在一定程度上减少了Apk的大小。

ShrinkResources资源压缩通过 Android Plugin for Gradle 提供,该插件会移除应用中未使用的资源,包括库中未使用的资源。同样也可减少Apk的大小。

如何启用压缩和混淆?

先上代码,在build.gradle中配置如下:

android {
buildTypes {
release {
minifyEnabled true //启用代码压缩
shrinkResources true //启用资源压缩
proguardFiles getDefaultProguardFile(‘proguard-android.txt'),
'proguard-rules.pro'//混淆规则文件配置
}
}
}
  • getDefaultProguardFile(‘proguard-android.txt’) 
    这个配置的意思是从 Android SDK tools/proguard/ 文件夹获取默认 ProGuard 设置。使用 proguard-android-optimize.txt 可以进一步的压缩代码还包括其他在字节码一级(方法内和方法间)执行分析的优化,可进一步减小 APK 大小和帮助提高其运行速度。
  • proguard-rules.pro 
    可以在这个文件中添加自定义的规则,该文件和build.gradle在同级目录下。

ProGuard的输出文件及用处: 
混淆过程完成后会生成如下几个文件, 
dump.txt 
说明 APK 中所有类文件的内部结构。 
mapping.txt 
提供原始与混淆过的类、方法和字段名称之间的转换。 
seeds.txt 
列出未进行混淆的类和成员。 
usage.txt 
列出从 APK 移除的代码。 
这些文件保存在 /build/outputs/mapping/release/目录下。

这里需要特别注意:每次release新版编译后,最好将这些文件加入git版本库一起保存,因为每次Release编译后这些文件都会被覆盖。

ProGuard配置说明

保留配置(即对配置的内容不进行处理)

-keep [,modifier,…] class_specification 
指定要保留的类和类成员(字段和方法)。

-keepclassmembers [,modifier,…] class_specification 
指定要保留的类成员,如果它们的类也被保留。 例如,你可能希望保留实现Serializable接口的所有序列化字段和类的方法。

-keepclasseswithmembers [,modifier,…] class_specification 
指定要保留的类和类成员,条件是所有指定的类成员都存在。 例如,你可能希望保留所有具有main方法的应用程序,而无需显式列出。

-keepnames class_specification 
-keep的缩写,允许class_specification 
指定要保存的类和类成员的名称(如果它们在压缩阶段不被删除)。 例如,你可能希望保留实现Serializable接口的类的所有类名,以便处理的代码与任何原始的序列化类保持兼容。 根本不使用的类仍然可以删除。 只适用于混淆。

-keepclassmembernames class_specification 
–keepclassmembers的缩写,allowhrinking class_specification 
指定要保存其名称的类成员,如果它们在压缩阶段未被删除。 例如,当处理由JDK 1.2或更旧版本编译的库时,你可能希望保留内部类$ 方法的名称,因此当处理使用已处理库的应用程序时,混淆器可以再次检测它(尽管ProGuard本身不需要 这个)。 只适用于混淆。

-keepclasseswithmembernames class_specification 
–keepclasseswithmembernames的缩写,允许class_specification 
指定要保留其名称的类和类成员,条件是所有指定的类成员在收缩阶段之后都存在。 例如,你可能希望保留所有本机方法名称和其类的名称,以便处理后的代码仍然可以链接到本机库代码。 根本不使用的本地方法仍然可以删除。 如果使用一个类文件,但是它的本机方法都不是,它的名字仍然会被模糊。 只适用于混淆。

-printseeds [filename] 
指定彻底列出由各种保护选项匹配的类和类成员。 列表打印到标准输出或给定文件。 该列表可用于验证是否真正找到预期的类成员,特别是如果你使用通配符。 例如,你可能希望列出所有应用程序或所有保留的小程序。

压缩

-dontshrink 
指定不压缩的类文件。 
-printusage {filename} 
指定需要列出dead code的类文件。 可以列出应用程序的未使用的代码。 只适用于压缩。 
-whyareyoukeeping {class_specification} 
指定打印关于给定类和类成员在压缩步骤中keep的原因的详细信息。 只适用于压缩。

优化

-dontoptimize 
指定不优化输入类文件。 默认情况下,启用优化; 所有方法都以字节码级别进行了优化。

-optimizations optimization_filter 
指定要在更细粒度的级别启用和禁用的优化。 仅适用于优化。 这是一个专家选项。

-optimizationpasses n 
指定要执行的优化通过次数。 默认情况下,执行单程。 多次通过可能会导致进一步的改进。 如果在优化通过后没有找到改进,则优化结束。 仅适用于优化。

-assumenosideeffects class_specification 
指定没有任何副作用的方法(可能返回值除外)。 在优化步骤中,ProGuard会删除对这些方法的调用,如果可以确定不使用返回值。例如,你可以指定方法System.out(),以便 用该选项来删除日志记录代码。 注意,该选项 仅适用于优化。 除非你很清楚这个方法的作用,否则请勿使用这个选项!

-allowaccessmodification 
指定在处理过程中可以扩展类和类成员的访问修饰符。 这可以改善优化步骤的结果。

-mergeinterfacesaggressively 
指定接口可能被合并,即使它们的实现类不实现所有接口方法。 这可以通过减少类的总数来减少输出的大小。

混淆

-dontobfuscate 不混淆输入的类文件 
-obfuscationdictionary {filename} 使用给定文件中的关键字作为要混淆方法的名称 
-overloadaggressively 混淆时应用侵入式重载 
-useuniqueclassmembernames 确定统一的混淆类的成员名称来增加混淆 
-flattenpackagehierarchy {package_name} 重新包装所有重命名的包并放在给定的单一包中 
-repackageclass {package_name} 重新包装所有重命名的类文件中放在给定的单一包中 
-dontusemixedcaseclassnames 混淆时不会产生形形色色的类名 
-keepattributes {attribute_name,…} 保护给定的可选属性,例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses. 
-renamesourcefileattribute {string} 设置源文件中给定的字符串常量

在配置过程中可以使用通配符,关于通配符的说明如下,

通配符 说明
? 匹配任何单字符。
* 匹配除了包分隔符或目录分隔符之外的任何字符。
** 匹配任何字符的名称

自定义要保留的代码

通常来说,默认 ProGuard 配置文件 (proguard-android.txt) 足以满足需要,ProGuard 会移除所有(并且只会移除)未使用的代码。但是对许多情况进行正确分析时,可能会移除有用的代码。 
以下几种情况下它可能错误移除有用代码:

  • 当应用引用的类只来自 AndroidManifest.xml 文件时
  • 当应用调用的方法来自 Java 原生接口 (JNI) 时
  • 当应用在运行时(例如使用反射或自检)操作代码时
  • 当使用Parcelable的子类和Creator静态成员变量时
  • 当使用GSON、fastjson等框架时,所写的JSON对象类如果进行混淆会造成无法将JSON解析成对应的对象
  • 当使用第三方开源库或者引用其他第三方的SDK包时
  • 当有用到WEBView的JS调用时

在进行应用测试时应该能够发现这些因不当移除而导致的错误,具体也可查看 usage.txt 的内容来检查移除了哪些代码。 
例如类似下面这样的错误,我们就需要配置keep这些类不被混淆

10:47:34.635 [ERROR] [system.err] Warning: com.kennyc.view.MultiStateView$1: can't find referenced method 'com.kennyc.view.MultiStateView$ViewState[] values()' in program class com.kennyc.view.MultiStateView$ViewState
10:47:34.636 [ERROR] [system.err] Warning: com.kennyc.view.MultiStateView$1: can't find referenced field 'com.kennyc.view.MultiStateView$ViewState LOADING' in program class com.kennyc.view.MultiStateView$ViewState

配置内容如下即可解决问题:

-keep class com.kennyc.**

在AndroidMainfest中的类不会混淆,四大组件和Application的子类和Framework层下所有的类默认不会进行混淆,android提供的默认配置中都有。以下就是Android SDK中默认的ProGuard配置,即proguard-android.txt的内容

# This is a configuration file for ProGuard.
# http://proguard.sourceforge.net/index.html#manual/usage.html -dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-verbose # 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).
-dontoptimize
-dontpreverify
# 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);
} -keepclassmembers class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator 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.** # Understand the @Keep support annotation.
-keep class android.support.annotation.Keep -keep @android.support.annotation.Keep class * {*;} -keepclasseswithmembers class * {
@android.support.annotation.Keep <methods>;
} -keepclasseswithmembers class * {
@android.support.annotation.Keep <fields>;
} -keepclasseswithmembers class * {
@android.support.annotation.Keep <init>(...);
}

列举一些库的混淆配置

##---------------Begin: proguard configuration for Twitter  ----------
-dontwarn com.squareup.okhttp.**
-dontwarn com.google.appengine.api.urlfetch.**
-dontwarn rx.**
-dontwarn retrofit.**
-keepattributes Signature
-keepattributes *Annotation*
-keep class com.squareup.okhttp.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-keep class retrofit.** { *; }
-keepclasseswithmembers class * {
@retrofit.http.* <methods>;
}
##---------------End: proguard configuration for Twitter ----------

  

##---------------Begin: proguard configuration for Gson  ----------
# Gson uses generic type information stored in a class file when working with fields. Proguard
# removes such information by default, so configure it to keep all of it.
-keepattributes Signature # For using GSON @Expose annotation
-keepattributes *Annotation* # Gson specific classes
-keep class sun.misc.Unsafe { *; }
#-keep class com.google.gson.stream.** { *; } # Application classes that will be serialized/deserialized over Gson
-keep class com.google.gson.examples.android.model.** { *; } # Prevent proguard from stripping interface information from TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer
##---------------End: proguard configuration for Gson ----------

  

##---------------Begin: proguard configuration for Glide  ----------
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
**[] $VALUES;
public *;
}
##---------------End: proguard configuration for Glide ----------

  

##---------------Begin: proguard configuration for EventBus  ----------
-keepattributes *Annotation*
-keepclassmembers class ** {
@org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; } # Only required if you use AsyncExecutor
#-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {
# <init>(java.lang.Throwable);
#}
##---------------End: proguard configuration for EventBus ----------

  

##---------------Begin: proguard configuration for Paper  ----------
#1.Keep data classes:
-keep class com.bloomsky.android.model.** { *; }
#2.alternatively you can implement Serializable for all your data classes and keep all of them using:
#-keep class * implements java.io.Serializable { *; }
##---------------End: proguard configuration for Paper ----------

  

##---------------Begin: proguard configuration for retrofit2  ----------
# Platform calls Class.forName on types which do not exist on Android to determine platform.
-dontnote retrofit2.Platform
# Platform used when running on Java 8 VMs. Will not be used at runtime.
-dontwarn retrofit2.Platform$Java8
# Retain generic type information for use by reflection by converters and adapters.
-keepattributes Signature
# Retain declared checked exceptions for use by a Proxy instance.
-keepattributes Exceptions
##---------------End: proguard configuration for retrofit2 ----------

移除调试log代码的配置

移除Log类打印各个等级日志的代码,打正式包的时候可以做为禁log使用,这里可以作为禁止log打印的功能使用,另外的一种实现方案是通过BuildConfig.DEBUG的变量来控制

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

  

恢复混淆前的堆栈信息

当混淆后的代码输出一个堆栈信息时,方法名是不可识别的,这使得调试变得很困难,甚至是不可能的。幸运的是,当ProGuard运行时,它都会输出一个/build/outputs/mapping/release/mapping.txt文件,而这个文件中包含了原始的类,方法和字段名被映射成的混淆名字。 
retrace.bat脚本(Window)或retrace.sh脚本(Linux,Mac OS X)可以将一个被混淆过的堆栈跟踪信息还原成一个可读的信息。它位于/tools/proguard文件夹中。执行retrace工具的语法如下: 
retrace.bat|retrace.sh [-verbose] mapping.txt [] 
例如: 
./retrace.sh -verbose mapping.txt obfuscated_trace.txt 
如果你没有指定,retrace工具会从标准输入读取。

原文地址:http://blog.csdn.net/ocean20/article/details/67634130 
更多关于ProGuard的信息可以访问, 
https://www.guardsquare.com/en/proguard/manual/examples

  

  

  

  

  

  

使用混淆ProGuard压缩代码和资源/减少方法数量的更多相关文章

  1. apk反编译(6)用ProGuard 混淆、压缩代码,压缩资源。

    1.android官方文档 https://developer.android.com/studio/build/shrink-code  主要内容如下: 1.1 压缩代码 混淆生成的文件:<m ...

  2. Web前端开发最佳实践(3):前端代码和资源的压缩与合并

    一般在网站发布时,会压缩前端HTML.CSS.JavaScript代码及用到的资源文件(主要是图片文件),目的是加快文件在网络中的传输,让网页更快的展现.当然,CDN分发.缓存等方式也是加快代码或资源 ...

  3. Android ProGuard:代码混淆压缩

    写这篇文章的目的 一直以来,在项目中需要进行代码混淆时每次都要去翻文档,很麻烦.也没有像写代码那样记得那么多.既然要查来查去,就不如自己捋一捋这个知识点了,被人写的终究还是别人的.所以自己去翻看了很多 ...

  4. 使用Egret插件压缩代码包体积,减少请求数量的实战教程

    在白鹭引擎发布了5.2.7版本中新增加了命令行,增加自动合图插件TextureMergerPlugin功能.今天,我们以一个EUI案例来展示自动合图插件的具体使用方法和注意事项. 此外,我们在本文还融 ...

  5. 4.2、Android Studio压缩你的代码和资源

    为了让你的APK文件尽可能的小,你需要在构建的时候开启压缩来移除无用的代码和资源. 代码压缩可在ProGuard中使用,可以检测和清除无用的类,变量,方法和属性,甚至包括你引用的库.ProGuard同 ...

  6. ProGuard之——代码混淆

    ProGuard之——代码混淆 2015年11月03日 21:39:40 阅读数:2756 标签: JavaProGuard 更多 个人分类: JAVA 所属专栏: Java 版权声明:本文为博主原创 ...

  7. 转:Android 2.3 代码混淆proguard技术介绍

    ProGuard简介 ProGuard是一个SourceForge上非常知名的开源项目.官网网址是:http://proguard.sourceforge.net/. Java的字节码一般是非常容易反 ...

  8. 自写脚本实现上线前本地批量压缩混淆 js , css 代码。

    最近做项目遇到一个要求,就是把本地的 js 和 css 进行压缩后再上线,由于之前项目并没有使用 webpack 之类的库,项目上也因为一些机密不能在线上压缩,这无疑给代码打包压缩带来了很大麻烦,于是 ...

  9. 【转】javascript代码混淆和压缩

    隐藏 JavaScript 源代码?不,你只能混淆和压缩JavaScript源代码 http://www.yaohaixiao.com/tools/confuse-and-compressing-ja ...

随机推荐

  1. Anaconda下载地址

    Anaconda installer archive:地址1: https://repo.continuum.io/archive/地址2:https://mirrors.tuna.tsinghua. ...

  2. [django]date类型和datetime类型过滤

    搞清楚datetime.datetime和datetime.date模块 他们两个的格式区别 datetime模块 In [1]: from datetime import datetime In [ ...

  3. .NET Core 获取 HttpContext.Current 以及 AsyncLocal 与 ThreadLocal

    在 DotNetCore 当中不再像 MVC5 那样可以通过 HttpContext.Current 来获取到当前请求的上下文. 不过微软提供了一个 IHttpContextAccessor 来让我们 ...

  4. asp.net MVC 上传文件 System.Web.HttpException: 超过了最大请求长度

    APS.NET MVC 上传文件出现  System.Web.HttpException: 超过了最大请求长度 这个问题 原因是 默认最大上传文件大小为4096,而我提交的文件太大了. 解决方案:修改 ...

  5. RPC框架--missian框架

    Missian简介 注:(创始者不明,应用于sina下面的公司(爱问)) Missian是一个构建于Mina和Hessian基础上的异步RPC框架,能够兼容HTTP协议和TCP协议,能和Hessian ...

  6. spring-boot(二)

    学习文章来自:http://www.ityouknow.com/spring-boot.html web开发 spring boot web开发非常的简单,其中包括常用的json输出.filters. ...

  7. MySQL索引建立和使用的基本原则

    合理设计和使用索引 在关键字段的索引上,建与不建索引,查询速度相差近100倍.   差的索引和没有索引效果一样.   索引并非越多越好,因为维护索引需要成本.   每个表的索引应在5个以下,应合理利用 ...

  8. [转]phpredis中文手册

    本文是参考<redis中文手册>,将示例代码用php来实现,注意php-redis与redis_cli的区别(主要是返回值类型和参数用法). 目录(使用CTRL+F快速查找命令): Key ...

  9. scala的安装及使用

    前提你的集群机器已经安装好jdk1.7.0_79.hadoop-2.7.3: 配置中使用了master01.slave01.slave02.slave03: 文中的所有操作都是在之前的文章http:/ ...

  10. java开发各层对象含义

    综述 java的几种对象(PO,VO,DAO,BO,POJO)解释: 一.PO:persistant object 持久对象,可以看成是与数据库中的表相映射的java对象.最简单的PO就是对应数据库中 ...