Detection and Cleanup of Unused Resources in Android Projects

Importance of Android Resource Management

During Android application development, as projects iterate and features evolve, resource directories often accumulate numerous unused layout files, strings, color definitions, image resources, and more. These unused resources not only increase the application's installation package size but also impact build speed and runtime performance. Therefore, regular cleanup of unused resources is a crucial aspect of maintaining project health.

Utilizing Android Studio Built-in Tools

Android Studio provides convenient graphical interfaces for identifying and cleaning unused resources. Developers can use the keyboard shortcut combination Ctrl+Alt+Shift+i to open the action search box and enter the "unused resources" command to execute Lint checks. For Mac users, the corresponding shortcut is ⌘+Option+Shift+i.

Alternative access is available through the menu bar by selecting Refactor > Remove Unused Resources..., where the system automatically scans all resource files in the project and generates a detailed list of unused resources. In the results interface, developers can review resource items individually, exclude resources that need to be preserved via right-click menu, and finally use the Do Refactor function to batch delete confirmed redundant resources.

Automated Solutions with Gradle Plugins

For projects requiring integration into continuous integration workflows, specialized Gradle plugins can automate resource cleanup. The android-remove-unused-resources-plugin is a practical tool based on Android Lint results, identifying unused resources by parsing XML report files generated by Lint.

Configure the plugin in app/build.gradle.kts:

plugins {
    id("io.github.irgaly.remove-unused-resources") version "2.3.0"
}

Ensure Lint configuration properly enables unused resource checks:

android {
    lint {
        checkGeneratedSources = true
        checkDependencies = true
    }
}

Special Handling for Multi-module Projects

In multi-module Android projects, resource dependency relationships are relatively complex. The plugin ensures cross-module resource references are correctly analyzed by setting checkDependencies = true. For modules using code generation technologies like DataBinding or Epoxy, the checkGeneratedSources = true option must be enabled; otherwise, resources referenced in generated code might be misidentified as unused.

Configuration examples for various submodules:

// Main module configuration
android {
    lint {
        checkGeneratedSources = true
        checkDependencies = true
    }
}

// Other module configuration
android {
    lint {
        checkGeneratedSources = true
    }
}

Execution Process and Command-line Operations

The complete resource cleanup process involves two steps: first running Lint analysis to generate reports, then executing cleanup tasks. Corresponding Gradle commands are:

./gradlew :app:lintDebug
./gradlew :app:removeUnusedResourcesDebug

To optimize execution efficiency, add the -Prur.lint.onlyUnusedResources parameter to make Lint check only unused resource rules:

./gradlew :app:lintDebug -Prur.lint.onlyUnusedResources
./gradlew :app:removeUnusedResourcesDebug

Precise Control Over Resource Cleanup

The plugin provides multiple configuration options for precise control over cleanup behavior:

• Dry Run Mode: Preview cleanup results without actual file deletion using -Prur.dryRun parameter or configuring dryRun = true
• Resource Exclusion Rules: Support excluding specific resources by resource ID, regular expressions, and file path patterns
• XML Structure Preservation: The cleanup process preserves original XML file formats and special characters, ensuring other resource definitions remain unaffected

Configuration example:

removeUnusedResources {
    dryRun = true
    excludeIds.add("R.color.unused_exclude_color")
    excludeIdPatterns.add("R\\..*exclude_pattern.*")
    excludeFilePatterns.add("**/values/exclude_colors.xml")
}

Environment Requirements and Compatibility

This plugin requires Gradle 7.0.2 or higher and runs in JVM 17 environment. Using lower Java versions may encounter dependency resolution errors. It's recommended to specify compatible Gradle versions in the project's gradle-wrapper.properties and ensure CI environments are configured with correct Java versions.

Best Practice Recommendations

When using resource cleanup tools in practical projects, follow these practices:

1. Execute resource cleanup before significant code commits to ensure resources under development aren't accidentally deleted
2. Integrate resource checks into continuous integration workflows for regular automated execution
3. Establish clear resource management standards for team projects to prevent arbitrary addition of unused resources
4. Maintain version control before cleanup to ensure rollback to pre-cleanup state
5. For internationalization projects, pay attention to resource usage across different language versions

Through systematic resource management, not only can application performance be optimized, but team development efficiency and code quality can also be significantly improved.