XmlClassGuard

By default, xmlClassGuard produces deterministic results: package names are derived via a hash algorithm, and class names start from 'A' and increment (A, B, C... Z, BA, BB...).

To ensure every obfuscation run produces different results, you must manually specify mappings in your mappingFile for:

1. Package names: Define specific target packages in dir mapping.
2. Class names: Define specific target classes in class mapping. If you have too many classes to list individually, defining a single package in dir mapping is sufficient to force the class names to start from a custom point (e.g., starting from 'Z' instead of 'A').

// Custom mapping to force different results
dir mapping:
    com.ljx.example -> hh
    com.ljx.example.activity -> jk
    com.ljx.example.test -> et

class mapping:
    com.ljx.example.AppHolder -> hh.Z

To use XmlClassGuard, you need to configure it in both your root project's build.gradle and your application's build.gradle.

Warning: The tasks performed by this plugin are irreversible and operate directly on your local files. Always ensure you have a code backup before running it.

// 1. In build.gradle (root project)
buildscript {
    repositories {
        maven { url 'https://jitpack.io' }
    }
    dependencies {
        classpath "com.github.liujingxing:XmlClassGuard:1.2.6"
    }
}

// 2. In build.gradle (application)
apply plugin: "xml-class-guard"

To use XmlClassGuard, apply the plugin to your Android project. Configuration is handled through the xmlClassGuard extension block in your build.gradle file. The plugin automatically creates tasks for each Android application variant.

Note: This plugin requires the com.android.application plugin to be applied to the project.

// Example configuration structure
xmlClassGuard {
    // Configuration options are defined in GuardExtension
    findAndConstraintReferencedIds = true
    findAabConstraintReferencedIds = true
}

The xmlClassGuard task obfuscates classes referenced in XML files (such as Android 4 components and custom Views) found in AndroidManifest.xml, navigation, layout, and other XML folders. It changes their package and class names and synchronizes these changes across files.

To enable incremental obfuscation or obfuscate specific classes, provide a mappingFile containing dir mapping and class mapping rules.

xmlClassGuard {
    mappingFile = file("xml-class-mapping.txt")
}

XmlClassGuard can integrate with resource guarding plugins to find and constrain referenced IDs. However, these features have external dependencies:

1. To use findAndConstraintReferencedIds: You must have the AndResGuard plugin applied to your project. The task andFindConstraintReferencedIds<VariantName> will depend on the resguard<VariantName> task.
2. To use findAabConstraintReferencedIds: You must have the AabResGuard plugin applied to your project. The task aabFindConstraintReferencedIds<VariantName> will depend on the aabresguard<VariantName> task.

If these plugins are missing when the corresponding flags are enabled, the build will fail with a GradleException.

The plugin registers several tasks for each Android application variant (e.g., for a variant named debug, the task will be xmlClassGuardDebug).

Core Tasks

• xmlClassGuard<VariantName>: The primary task for XML class guarding.
• packageChange<VariantName>: Handles package changes.
• moveDir<VariantName>: Handles directory movement tasks.

Conditional Tasks

If specific flags are enabled in the xmlClassGuard extension, the following tasks are also created:

• andFindConstraintReferencedIds<VariantName>: Created if findAndConstraintReferencedIds is true. Requires the AndResGuard plugin.
• aabFindConstraintReferencedIds<VariantName>: Created if findAabConstraintReferencedIds is true. Requires the AabResGuard plugin.