Android Studio如何限制Java/Kotlin文件代码行数 构建时超限告警报错

以下三种方案均可以在Android项目构建流程中检查Java/Kotlin文件行数，超出设定阈值时输出警告或直接中断构建抛错，以200行阈值为例配置如下：

方案1：Detekt（Kotlin优先项目推荐） #

Detekt是Kotlin生态主流静态代码检查工具，内置文件长度检查规则，和Android项目适配度高。

• 在模块级（通常为app模块）build.gradle中添加插件依赖：

plugins {
    id("io.gitlab.arturbosch.detekt") version "1.23.4"
}

• 同文件内添加Detekt配置块：

detekt {
    buildUponDefaultConfig = true
    allRules = false
    config.setFrom(files("detekt-config.yml"))
    // 设为true仅输出警告不中断构建，设为false超阈值直接抛错终止构建
    ignoreFailures = false
}

• 在项目根目录新建detekt-config.yml规则配置文件，添加行数限制规则：

style:
  FileLength:
    active: true
    threshold: 200 # 单文件最大行数阈值，按需修改
    excludeAnnotatedFiles: [] # 可配置排除加了特定注解的自动生成文件
  MaxLineLength:
    maxLineLength: 120 # 单行字符数限制，按需调整
complexity:
  LongMethod:
    threshold: 60 # 单方法最大行数，可按需配置

配置完成后，执行./gradlew detekt可手动触发检查，正常执行assemble、install等构建任务时检查会自动运行，超限时会直接输出对应文件路径、实际行数的提示信息。

方案2：Checkstyle（Java优先项目推荐） #

Checkstyle是Java生态成熟的静态检查工具，可同时适配Java、Kotlin文件的行数检查。

• 在模块级build.gradle中添加插件与配置：

plugins {
    id 'checkstyle'
}

checkstyle {
    toolVersion = '10.12.4'
    // 设为true仅输出警告不中断构建，设为false超阈值直接抛错终止构建
    ignoreFailures = false
    configFile = file("checkstyle.xml")
}

• 在项目根目录新建checkstyle.xml规则配置文件，添加行数限制规则：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
    "checkstyle-configuration">
<module name="Checker">
    <module name="FileLength">
        <property name="max" value="200"/> <!-- 单文件最大行数阈值 -->
        <property name="fileExtensions" value="java,kt"/>
    </module>
    <module name="TreeWalker">
        <module name="LineLength">
            <property name="max" value="120"/> <!-- 单行字符数限制 -->
        </module>
    </module>
</module>

配置完成后，执行./gradlew check可手动触发检查，构建流程会自动执行该检查任务。

方案3：自定义Gradle任务（无额外依赖） #

如果不想引入第三方插件，可直接编写轻量Gradle任务实现行数检查，配置灵活性最高。
直接在模块级build.gradle中添加如下代码：

tasks.register("checkFileLineCount") {
    doLast {
        // 单文件行数阈值
        def lineLimit = 200
        def overLimitFiles = []

        // 检查主源码目录
        fileTree("src/main/java").matching {
            include "**/*.java", "**/*.kt"
            // 可在此处添加exclude规则过滤不需要检查的文件/目录
            // exclude "**/generated/**"
        }.each { file ->
            def lineCount = file.readLines().size()
            if (lineCount > lineLimit) {
                overLimitFiles << [path: file.absolutePath, count: lineCount]
            }
        }

        // 如需检查测试目录可放开以下注释
        /*
        fileTree("src/test/java").matching {
            include "**/*.java", "**/*.kt"
        }.each { file ->
            def lineCount = file.readLines().size()
            if (lineCount > lineLimit) {
                overLimitFiles << [path: file.absolutePath, count: lineCount]
            }
        }
        */

        if (overLimitFiles.size() > 0) {
            overLimitFiles.each {
                println("⚠️ 文件 ${it.path} 行数为 ${it.count}，超过阈值 ${lineLimit}")
            }
            // 不需要中断构建就注释掉下一行
            throw new GradleException("共${overLimitFiles.size()}个文件行数超过上限，请拆分优化")
        }
    }
}

// 配置预构建任务依赖，让每次构建自动执行行数检查
tasks.named("preBuild") {
    dependsOn("checkFileLineCount")
}

该方案无需下载额外依赖，可根据项目需求自由调整检查范围、白名单、提示逻辑。

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