Mess - GitLite

KO | EN

gitlite — search

#python #ai #typescript #llm #android #docker #macos #java #awesome #cli #kubernetes #security #mcp #openai

Mess

(★ 686)

a gradle plugin for minifying activities, services, receivers, providers and custom view

File Explorer

Download Latest Version (.zip)

- .gitignore
- build.gradle
- debug.keystore
- proguard-rules.pro
- build.gradle
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.gitignore
.gitmodules
build.gradle
ButterMess
gradle.properties
LICENSE
README.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/eleme/Mess

Downloads the entire project code from GitHub to your computer.

cd Mess

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

cd app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mess

**mess** is a gradle plugin for obfuscating all code including activity, service, receiver, provider and custom view. It's really very cool to obfuscate all codes, lowers code readability after reverse engineering and ensures code's safety.

**mess** is super easy to integrate with your app, its implementation is also clear to understand. During android gradle assemble task execution, It has a lot of tasks to do,  and can be divided to resource process & code process briefly.

**process\**Resources** is the last task in resource process, it will generate a merged **AndroidManifest.xml**,  **aapt_rules.txt**  and  a merged **res** directory in project build dir.  aapt_rules.txt is the output file after aapt, it contains all classes in xml files, and then this file is delivered to proguard task as a list of keeps. 
 **transformClassesAndResourcesWithProguardFor\**** is the proguard task which obfuscates code,  it generates a **mapping.txt** file which contains all mapping relation between origin and obfuscated classes. 
 
 **mess** hooks two android gradle tasks: **process\**Resources** & **package\****, hook processResources task is to clear aapt_rules.txt,  tells proguard not to obfuscate all the classes in xml;  package task is the last task before package code & resource into apk, it runs after proguard, mess hooks it just to read the obfuscation mapping relation, then rewrite these into resources again, finally execute processResources task again. If your app sets **shrinkResources** to be true, then execute shrink task one more time.

## Usage

```groovy
dependencies {
   ...
   classpath 'me.ele:mess-plugin:1.1.5'
 }
  
apply plugin: 'com.android.library'
apply plugin: 'me.ele.mess'

```

In some cases, you want to ignore some proguard configuration provided by aar. E.g. latest Butter Knife is an aar which contains proguard.txt, so users do not need to configure its proguard manually.
However, we would like to still obfuscate classes used with Butter Knife. So we provide an extension for such scenario.

```groovy
mess {
    ignoreProguard 'com.jakewharton:butterknife'
}
```

If you are using AAPT2, please disable AAPT2 by setting `android.enableAapt2=false` in your gradle.properties file.

As a result, the Butter Knife's proguard configuration will be ignored. And those activities, views, fragments will be obfuscated by Mess.

That's all, just simple as that

## Note
As almost every Android project uses [Butter Knife](https://jakewharton.github.io/butterknife/) for view injection. And Butter Knife has its own proguard rules which keeps every class using Butter Knife. As as result, almost every android activity, fragment, custom view would be kept. And out Mess plugin is useless.

But good news is that we studied Butter Knife source code and figured it out. And the solution is also a gradle plugin [ButterMess](https://github.com/peacepassion/ButterMess) which has been a submodule of this project.

## feel free to use, welcome issue and comment