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

相关文章

vue使用docxtemplater导出word

《vue使用docxtemplater导出word》docxtemplater是一种邮件合并工具,以编程方式使用并处理条件、循环,并且可以扩展以插入任何内容,下面我们来看看如何使用docxtempl... 目录docxtemplatervue使用docxtemplater导出word安装常用语法 封装导出方

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON(序列化)2.2 JSON 转对象(反序列化)3.

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

Android中Dialog的使用详解

《Android中Dialog的使用详解》Dialog(对话框)是Android中常用的UI组件,用于临时显示重要信息或获取用户输入,本文给大家介绍Android中Dialog的使用,感兴趣的朋友一起... 目录android中Dialog的使用详解1. 基本Dialog类型1.1 AlertDialog(