Lint Cleaner Plugin配置教程：exclude、ignoreResFiles等高级选项全解析

Lint Cleaner Plugin配置教程：exclude、ignoreResFiles等高级选项全解析

【免费下载链接】lint-cleaner-pluginA Gradle Plugin that removes unused resources in Android projects.项目地址: https://gitcode.com/gh_mirrors/li/lint-cleaner-plugin

Lint Cleaner Plugin是一款专为Android项目设计的Gradle插件，能够自动移除Android Lint报告中标记的未使用资源，包括字符串、颜色和尺寸等。本文将详细解析exclude、ignoreResFiles等高级配置选项，帮助开发者更灵活地管理项目资源。

插件简介与基础使用

Lint Cleaner Plugin通过分析Android Lint生成的报告文件，自动识别并删除项目中未被使用的资源文件，有效减小APK体积并优化项目结构。使用该插件只需在build.gradle中添加依赖并应用插件，然后执行gradle lintClean命令即可完成资源清理。

基础配置步骤

1. 在项目根目录的build.gradle中添加插件依赖：

buildscript { repositories { mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:0.12.+' classpath 'com.droidtitan:lint-cleaner-plugin:0.3.0' } } apply plugin: 'android' apply plugin: 'com.droidtitan.lintcleaner'

2. 执行清理命令：

gradle lintClean

高级配置选项全解析

exclude：排除特定文件

通过exclude配置可以指定不需要清理的资源文件，适用于那些虽然未被代码引用但仍需保留的特殊文件（如第三方库依赖的配置文件）。

配置示例：

lintCleaner { // 排除Crashlytics配置文件和应用配置文件 exclude = ['com_crashlytics_export_strings.xml', 'config.xml'] }

实现原理：在LintCleanerTask.groovy中，插件会检查每个待清理文件的名称是否包含在excludes列表中，若匹配则跳过该文件：

if (excludes.contains(sourceFile.name)) { // 跳过排除文件 }

ignoreResFiles：忽略所有资源文件

ignoreResFiles是一个布尔值配置，默认为false。当设置为true时，插件将忽略所有资源文件的清理操作，适用于仅需清理代码文件或临时禁用资源清理的场景。

配置示例：

lintCleaner { // 忽略所有资源文件 ignoreResFiles = true }

参数来源：该配置在LintCleanerPluginExtension.groovy中定义默认值，并通过LintCleanerPlugin.groovy映射到任务属性：

// 扩展属性定义 boolean ignoreResFiles = false // 任务属性映射 conventionMapping.ignoreResFiles = { extension.ignoreResFiles }

lintXmlFilePath：自定义Lint报告路径

默认情况下，插件会读取build/outputs/lint-results.xml作为Lint报告来源。通过lintXmlFilePath可以指定自定义的报告路径，适用于非标准项目结构或自定义Lint输出位置的场景。

配置示例：

lintCleaner { // 指定自定义Lint报告路径 lintXmlFilePath = 'path/to/custom-lint-results.xml' }

实际应用场景与注意事项

与Android Studio原生功能的配合

虽然Android Studio 2.0+已内置Refactor -> Remove Unused Resources功能（如图所示），但Lint Cleaner Plugin通过Gradle任务实现了自动化集成，更适合CI/CD流程或批量处理场景。

图：Android Studio中通过Refactor菜单手动移除未使用资源的操作界面

版本兼容性

插件当前最新版本为0.3.0，兼容Gradle0.12.+及以上版本。使用时需注意与Android Gradle Plugin的版本匹配，避免出现兼容性问题。

数据安全建议

在执行资源清理前，建议先提交代码到版本控制系统，或备份重要资源文件，防止误删必要文件。插件虽然提供了exclude机制，但复杂项目中仍可能存在特殊依赖关系。

总结

Lint Cleaner Plugin通过灵活的配置选项，为Android开发者提供了自动化的资源清理解决方案。合理使用exclude、ignoreResFiles等高级选项，能够在保证项目功能完整的前提下，有效优化资源结构并减小APK体积。无论是日常开发还是构建流程集成，该插件都是提升项目质量的实用工具。

【免费下载链接】lint-cleaner-pluginA Gradle Plugin that removes unused resources in Android projects.项目地址: https://gitcode.com/gh_mirrors/li/lint-cleaner-plugin