FreeProGuard 项目使用教程

FreeProGuard 项目使用教程

1. 项目目录结构及介绍

FreeProGuard 项目旨在帮助 Android 开发者简化混淆配置。以下是项目的目录结构及各部分的功能介绍：

Blankj/FreeProGuard/
├── build.gradle          # 项目构建文件
├── gradle/
│   └── wrapper/          # Gradle 包装器文件夹
├── gitignore             # Git 忽略配置文件
├── CHANGELOG.md          # 项目更新日志
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── gradlew               # Gradle 命令行工具
├── gradlew.bat           # Gradle 命令行工具（Windows 版本）
└── settings.gradle       # 项目设置文件

• build.gradle: 项目的主要构建文件，定义了项目依赖、构建任务等。
• gradle/wrapper/: 包含了 Gradle 包装器配置文件，用于确保构建环境的兼容性。
• gitignore: 配置 Git 忽略的文件和目录，以避免将不必要的文件提交到版本控制。
• CHANGELOG.md: 记录了项目的所有更新和修改历史。
• LICENSE: 项目使用的许可证信息，本项目采用 Apache-2.0 许可证。
• README.md: 项目说明文件，介绍了项目的功能、使用方法和配置方式。
• gradlew 和 gradlew.bat: 分别是 Linux/macOS 和 Windows 系统下的 Gradle 命令行工具，用于执行构建任务。
• settings.gradle: 项目设置文件，用于配置 Gradle 的多项目构建。

2. 项目的启动文件介绍

本项目没有特定的启动文件，因为它是作为一个库项目被其他 Android 项目依赖使用的。在您的 Android 项目中，您需要添加如下依赖来使用 FreeProGuard：

implementation "com.blankj:free-proguard:1.0.2"

然后在您的项目的 proguard-rules.pro 文件中，按照以下说明进行配置。

3. 项目的配置文件介绍

项目的核心配置文件是 proguard-rules.pro，在该文件中，您需要添加以下内容：

• 添加项目中的实体类到混淆规则中，通常形式为 -keep class your.package.name.bean.Entity**。
• 如果使用注解，则可以在实体类上使用 @Keep 注解来避免混淆。
• 将项目中需要混淆的第三方库的 jar 文件添加到混淆规则中，例如 -libraryjars libs/alipaySDK-20150602.jar。
• 如果您希望将所有第三方库都加入混淆，可以使用 -libraryjars libs/*。

确保在开启混淆功能时（设置 minifyEnabled true），您的项目配置正确，以便 FreeProGuard 能够正常工作。