Android 使用 ProGuard 代码混淆

2024-05-06 21:18

本文主要是介绍Android 使用 ProGuard 代码混淆,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

ProGuard 是开源的优化 Java 字节码工具。官方称可用减少 10% 体积,并提升 20% 运行效率。将类名、方法名、变量名混淆成a、b、c基本字母,一定程度上提高了反编译的难度。

  • 压缩(Shrinking):从入口开始建立引用关系网,去除网外为使用的代码。

  • 优化(Optimization):对入口点以外所有的方法进行分析,将其中一部分方法变为 final的,static的,private的或内联的,从而提高执行效率。

  • 混淆(Obfuscation):将入口点以外的类、方法、成员重构为简短的名字,可以减小生成文件体积,同时混淆代码。

官网手册: Proguard Manual Usage

一、Android 中配置

  • 在 build.gradle 中的配置

    buildTypes {release {minifyEnabled trueproguardFile getDefaultProguardFile('proguard-android.txt')proguardFile 'proguard-rules.pro'}
    }
    
    • proguard-android.txt 是官方提供的通用混淆配置,文件路径在 \sdk\tools\proguard\proguard-android.txt
    • proguard-rules.pro 即自定义配置文件

二、混淆规则

  • keep 的使用

    • keep [,modifier,…] class_specification 保留指定的类名以及成员
    • keepclassmembers [,modifier,…] class_specification 留住成员而不能保留住类名
    • keepclasseswithmembers [,modifier,…] class_specification 可以根据成员找到满足条件的所有类而不用指定类名,可以保留类名和成员名
  • modifier 可选值

    • allowshrinking 允许其被压缩,就是说指定的内容有可能被移除,但是如果没有被移除的话它也不会在后续过程中被优化或者混淆.
    • allowoptimization 允许其被优化,但是不会被移除或者混淆(使用情况较少)
    • allowobfuscation 允许其被混淆,但是不会被移除或者优化(使用情况较少)
  • class_specification 规则

    是类和成员的一种模板,只有符合此模板的类和成员才会被应用keep规则。

    • 指定类

      • class 可以指代任意类和接口,interface指明为接口,enum指明为枚举
      • classname 必须用全名,例如 java.lang.String,也可以使用正则表达式(?|\*|\*\*)
      • extendsimplements 关键字是等价的
      • @ 指明类或成员具有某些注解
    • 指定成员

      • \<init\> 代表任意构造方法.
      • \<fields\> 代表任意域.
      • \<methods\> 代表任意方法.
      • * 代表任意成员(包括成员变量和方法).
      • 类型描述通配符
        • % 表示任意基本类型(int,char等,但是不包括void).
        • ? 表示类名中的任意单个字符.
        • * 表示类名中的任意多个字符,不包括分隔符(.).
        • ** 表示类名中的任意多个字符,包括分隔符(.).
        • *** 表示任意类型.
        • ... 表示任意多个任意类型的参数.

三、Android 中不要混淆的类

  • Parcelable 中的 Creator 成员

  • Serializable 的多数子类

    • 并不是所有的子类都不能混淆:只短暂的保持数据,对新版本不会有影响的不需要混淆(如 Bundle 的数据,另外相比于 Parcelable,尽量少用 Serializable)
  • JsonBean 对象

    • 可以使用 Gson 中的 @SerializedName("xxx") 给属性添加注释
  • AIDL 接口的类名

  • 另外通用的(native、R资源、四大组件、view等)

四、Log 日志的优化

  • 当 message 的内容没有计算时(追加、调用方法等),可以直接调用打印

  • 当 message 有计算时,建议使用如下方式

    if (BuildConfig.DEBUG){Log.v(TAG, "xxx = " + xxx + "   method = " + method(xxx));
    }
    
    • 当打正式包时 BuildConfig.DEBUG 的值为 false,if 条件中的内容不可能执行,ProGuard 的优化会删除该代码。
    • 如果把这句话封装在方法中,再调用方法。由于在调用方法前先要执行计算操作,虽然不打印但是会多一次无意义的计算

五、使用 @NoProguard 注释

为了方便灵活的配置(类、方法、成员属性)混淆,可以通过定义一个注释标识,让所有引用了该注释的对象都不会混淆。

定义注释:

@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD})
public @interface NotProguard {
}

配置使用了该注释的代码不混淆

# 配置使用了 @NotProguard 注释的类不混淆
-keep @xxx.xxx.NotProguard class * {*;}
# 配置使用了 @NotProguard 注释的成员变量不混淆
-keepclassmembers class * {
@xxx.xxx.NotProguard <fields>;
}
# 配置使用了 @NotProguard 注释的方法不混淆
-keepclassmembers class * {
@xxx.xxx.NotProguard <methods>;
}

六、使用经验补充

使用版本:
Gradle: gradle-4.1-all
android.build: 2.3.2

  • 查看最终的混淆配置文件,如下代码配置输出路径

    -printconfiguration "build/outputs/mapping/configuration.txt"
    
    • 自动生成了 layout 中被引用 View 的构造函数不会混淆的规则

      # view res/layout/fragment_pay_track_list.xml #generated:14
      -keep class com.xxx.ui.view.RichTextView {<init>(...);
      }
      

      因此让继承了 View 的类不被混淆的规则是多余的,在代码中被引用的 View 依然可以混淆。

    • 自动生成了使用 @Keep 不被混淆的规则,替代了前面提到的 @NotProguard

      # Understand the @Keep support annotation.
      -keep class android.support.annotation.Keep-keep @android.support.annotation.Keep class * {<fields>;<methods>;
      }-keepclasseswithmembers class * {@android.support.annotation.Keep<methods>;
      }-keepclasseswithmembers class * {@android.support.annotation.Keep<fields>;
      }-keepclasseswithmembers class * {@android.support.annotation.Keep<init>(...);
      }
      
    • 自动生成了 AndroidManifest 文件中注册的四大组件类名不混淆规则

      # view AndroidManifest.xml #generated:35
      -keep class com.xxx.ui.activity.PlayerActivity {<init>(...);
      }
      
    • 自动生成了 xml 文件中控件使用了 onclick 属性的方法不混淆规则

      # onClick res/layout/patch_player_control.xml #generated:8
      -keepclassmembers class * {*** onClick(...);
      }
      
    • 其它…

  • Retrofit 的 service 接口定义的参数被 Shrinking,导致参数被删除。可以用 -keepclassmembers 保持这些参数。

注:本博客 android.build.gradle 2.x 版本,3.x或更高版本依赖的混淆配置较高,存在部分差异,待后续完善!

这篇关于Android 使用 ProGuard 代码混淆的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/965398

相关文章

使用Python构建智能BAT文件生成器的完美解决方案

《使用Python构建智能BAT文件生成器的完美解决方案》这篇文章主要为大家详细介绍了如何使用wxPython构建一个智能的BAT文件生成器,它不仅能够为Python脚本生成启动脚本,还提供了完整的文... 目录引言运行效果图项目背景与需求分析核心需求技术选型核心功能实现1. 数据库设计2. 界面布局设计3

使用IDEA部署Docker应用指南分享

《使用IDEA部署Docker应用指南分享》本文介绍了使用IDEA部署Docker应用的四步流程:创建Dockerfile、配置IDEADocker连接、设置运行调试环境、构建运行镜像,并强调需准备本... 目录一、创建 dockerfile 配置文件二、配置 IDEA 的 Docker 连接三、配置 Do

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.

python使用try函数详解

《python使用try函数详解》Pythontry语句用于异常处理,支持捕获特定/多种异常、else/final子句确保资源释放,结合with语句自动清理,可自定义异常及嵌套结构,灵活应对错误场景... 目录try 函数的基本语法捕获特定异常捕获多个异常使用 else 子句使用 finally 子句捕获所

C++11右值引用与Lambda表达式的使用

《C++11右值引用与Lambda表达式的使用》C++11引入右值引用,实现移动语义提升性能,支持资源转移与完美转发;同时引入Lambda表达式,简化匿名函数定义,通过捕获列表和参数列表灵活处理变量... 目录C++11新特性右值引用和移动语义左值 / 右值常见的左值和右值移动语义移动构造函数移动复制运算符

Python对接支付宝支付之使用AliPay实现的详细操作指南

《Python对接支付宝支付之使用AliPay实现的详细操作指南》支付宝没有提供PythonSDK,但是强大的github就有提供python-alipay-sdk,封装里很多复杂操作,使用这个我们就... 目录一、引言二、准备工作2.1 支付宝开放平台入驻与应用创建2.2 密钥生成与配置2.3 安装ali

C#中lock关键字的使用小结

《C#中lock关键字的使用小结》在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时,其他线程无法访问同一实例的该代码块,下面就来介绍一下lock关键字的使用... 目录使用方式工作原理注意事项示例代码为什么不能lock值类型在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时

MySQL 强制使用特定索引的操作

《MySQL强制使用特定索引的操作》MySQL可通过FORCEINDEX、USEINDEX等语法强制查询使用特定索引,但优化器可能不采纳,需结合EXPLAIN分析执行计划,避免性能下降,注意版本差异... 目录1. 使用FORCE INDEX语法2. 使用USE INDEX语法3. 使用IGNORE IND

C# $字符串插值的使用

《C#$字符串插值的使用》本文介绍了C#中的字符串插值功能,详细介绍了使用$符号的实现方式,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧... 目录$ 字符使用方式创建内插字符串包含不同的数据类型控制内插表达式的格式控制内插表达式的对齐方式内插表达式中使用转义序列内插表达式中使用

flask库中sessions.py的使用小结

《flask库中sessions.py的使用小结》在Flask中Session是一种用于在不同请求之间存储用户数据的机制,Session默认是基于客户端Cookie的,但数据会经过加密签名,防止篡改,... 目录1. Flask Session 的基本使用(1) 启用 Session(2) 存储和读取 Se