Android自定义Lint规则无法检测导入类问题求助

我之前也碰到过自定义Lint规则不生效的问题，结合你的配置和已尝试的操作，给你梳理几个排查方向和解决方案：

你的问题场景 #

我在Android项目中创建了customlint自定义Lint模块，用来检测特定导入类的问题（包含SyntheticImportIssue和AndroidLogImportIssue），在App模块通过lintChecks project(':customlint')引入后，规则完全无法检测到任何导入相关问题。

相关配置与代码 #

App模块配置 #

lintChecks project(':customlint')

ImportsIssueRegistry.kt #

class ImportsIssueRegistry : IssueRegistry() {
    override val issues: List<Issue> get() = listOf(
        SyntheticImportIssue.ISSUE, AndroidLogImportIssue.ISSUE
    )
    override val api: Int get() = CURRENT_API
}

customlint/build.gradle #

apply plugin: 'java-library'
apply plugin: 'kotlin'
ext.lintVersion = '26.4.2'
dependencies {
    //noinspection DifferentStdlibGradleVersion
    compileOnly "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
    compileOnly "com.android.tools.lint:lint-api:$lintVersion"
    compileOnly "com.android.tools.lint:lint-checks:$lintVersion"
    testImplementation 'junit:junit:4.13-beta-3'
    testImplementation "com.android.tools.lint:lint:$lintVersion"
    testImplementation "com.android.tools.lint:lint-tests:$lintVersion"
    testImplementation "com.android.tools:testutils:$lintVersion"
}
sourceCompatibility = "1.8"
targetCompatibility = "1.8"
jar{
    manifest{
        attributes 'Lint-Registry-V2': '[package name].ImportsIssueRegistry'
    }
}

已尝试的操作 #

• 确认Gradle版本为3.4.2
• 将Lint-Registry改为Lint-Registry-V2
• 尝试通过本地Jar包引入：lintChecks fileTree(dir: 'libs', include: ['customlint.jar'] )

排查与解决方案 #

1. 确认Registry的包名配置正确 #

这是最容易踩坑的点！你在jar任务的manifest里写的[package name].ImportsIssueRegistry必须替换成实际的包名。比如你的ImportsIssueRegistry.kt放在com.yourcompany.lint.checks包下，这里就应该写成com.yourcompany.lint.checks.ImportsIssueRegistry。如果包名写错，Lint根本找不到你的规则注册类，自然不会加载任何自定义规则。

2. 检查Lint规则的实现逻辑 #

确保你的检测规则本身是正确的：

• 对于导入检测，要正确实现Detector的导入处理方法。比如针对Java/Kotlin文件，需要实现SourceCodeScanner，并重写getApplicableUastTypes指定监听UImportStatement，然后在visitImport里编写检测逻辑：

  class AndroidLogImportDetector : Detector(), SourceCodeScanner {
      override fun getApplicableUastTypes() = listOf(UImportStatement::class.java)
  
      override fun visitImport(context: JavaContext, import: UImportStatement) {
          val importPath = import.importReference?.asSourceString()
          if (importPath == "android.util.Log") {
              context.report(
                  AndroidLogImportIssue.ISSUE,
                  import,
                  context.getLocation(import),
                  "请使用项目封装的日志工具，不要直接导入android.util.Log"
              )
          }
      }
  }
  

• 确认Issue的implementation关联了正确的Detector，并且scope设置正确（比如检测Java文件用Scope.JAVA_FILE_SCOPE，Kotlin文件用Scope.KOTLIN_FILE_SCOPE）：

  object AndroidLogImportIssue {
      val ISSUE = Issue.create(
          id = "AndroidLogImport",
          briefDescription = "禁止直接导入android.util.Log",
          explanation = "使用封装的日志工具便于统一管理日志输出格式和开关",
          category = Category.CORRECTNESS,
          priority = 6,
          severity = Severity.WARNING,
          implementation = Implementation(
              AndroidLogImportDetector::class.java,
              Scope.JAVA_FILE_SCOPE
          )
      )
  }
  

3. 手动执行Lint任务并验证规则加载情况 #

在终端运行以下命令手动触发Lint检查：

./gradlew app:lintDebug

执行完成后，打开app/build/reports/lint-results-debug.html报告，在「Custom Checks」区域查看是否有你的自定义规则。如果没有，说明Lint未加载到你的规则，回到第一步检查Registry配置。

4. 检查版本兼容性 #

你的lintVersion是26.4.2，对应Android Gradle Plugin 3.4.2是匹配的，但要确保kotlin_version和项目主模块使用的Kotlin版本完全一致，避免版本不兼容导致Detector无法加载。

5. 清理缓存并重建项目 #

缓存问题也可能导致规则不生效，执行以下命令清理后重建：

./gradlew clean
./gradlew assembleDebug
./gradlew app:lintDebug

6. 检查App模块是否禁用了自定义规则 #

查看App模块的build.gradle中是否有lintOptions禁用了你的规则：

lintOptions {
    disable 'AndroidLogImport', 'SyntheticImport'
}

如果有这类配置，需要移除对应的disable项。

内容的提问来源于stack exchange，提问作者kaushalyap