面试题：自定义Kotlin静态检查规则及在大型项目中的集成

Question

假设在一个大型Kotlin项目中，团队有一些特定的代码规范要求，现需要你自定义一套静态检查规则。请阐述如何基于Kotlin现有的静态检查框架（如KtLint的扩展机制）来创建自定义规则，用于检查特定的代码模式、模块间依赖等。同时，说明如何将这些自定义规则集成到项目的CI/CD流程中，确保整个团队代码的一致性和规范性。

Answer 1

基于KtLint扩展机制创建自定义规则

1. 创建规则类：
   • 继承Rule类，例如：

   import com.pinterest.ktlint.core.Rule
   import org.jetbrains.kotlin.com.intellij.lang.ASTNode
   import org.jetbrains.kotlin.psi.KtFile
   
   class CustomCodePatternRule : Rule("custom - code - pattern - rule") {
       override fun visit(file: KtFile, node: ASTNode) {
           // 在这里实现对特定代码模式的检查逻辑
           // 例如，检查特定函数名是否符合规范
           node.acceptChildren { childNode ->
               if (childNode.elementType.toString() == "FUNCTION") {
                   val functionName = childNode.text
                   if (!functionName.matches(Regex("^[a - z]+[A - Z0 - 9]*\$"))) {
                       report(childNode, "Function name should follow the pattern: lowercase start, then alphanumeric.")
                   }
               }
           }
       }
   }
   

2. 注册规则：
   • 创建一个RuleSetProvider实现类，例如：

   import com.pinterest.ktlint.core.Rule
   import com.pinterest.ktlint.core.RuleSet
   import com.pinterest.ktlint.core.RuleSetProvider
   
   class CustomRuleSetProvider : RuleSetProvider {
       override fun get(): RuleSet {
           val customRules = listOf<Rule>(CustomCodePatternRule())
           return RuleSet("custom - rule - set", customRules)
       }
   }
   

3. 配置KtLint使用自定义规则：
   • 在build.gradle.kts中添加依赖：

   dependencies {
       implementation("com.pinterest:ktlint:0.43.2")
   }
   

   • 配置KtLint任务，使其使用自定义规则集：

   tasks.register("ktlintCustomCheck") {
       group = "verification"
       description = "Check Kotlin code style using custom rules"
       doLast {
           val ruleSetProvider = CustomRuleSetProvider()
           val ktlint = KtLint(ruleSetProvider.get())
           ktlint.lint(projectDir)
       }
   }
   

检查模块间依赖

1. 使用工具辅助：
   • 可以使用Detekt等工具辅助检查模块间依赖。首先在build.gradle.kts中添加Detekt依赖：

   plugins {
       id("io.gitlab.arturbosch.detekt") version "1.19.0"
   }
   
   detekt {
       config = files("$rootDir/config/detekt.yml")
       buildUponDefaultConfig = true
       reports {
           xml {
               enabled = true
               destination = file("$buildDir/reports/detekt/detekt.xml")
           }
           html {
               enabled = true
               destination = file("$buildDir/reports/detekt/detekt.html")
           }
       }
   }
   

   • 在detekt.yml配置文件中定义模块间依赖规则，例如限制某个模块不能依赖特定模块：

   rules:
     - name: NoSpecificModuleDependency
       id: no - specific - module - dependency
       active: true
       configuration:
         dependency: "com.example:specific - module"
         message: "This module should not depend on com.example:specific - module"
         severity: error
   

集成到CI/CD流程

1. 使用GitHub Actions：
   • 在.github/workflows目录下创建一个.yaml文件，例如ktlint - detekt - ci.yml：

   name: Kotlin Code Style and Dependency Check
   on:
     push:
       branches:
         - main
   jobs:
     ktlint - check:
       runs - on: ubuntu - latest
       steps:
         - name: Checkout
           uses: actions/checkout@v2
         - name: Set up JDK 11
           uses: actions/setup - java@v2
           with:
             java - version: '11'
         - name: Gradle KtLint Check
           run:./gradlew ktlintCustomCheck
     detekt - check:
       runs - on: ubuntu - latest
       steps:
         - name: Checkout
           uses: actions/checkout@v2
         - name: Set up JDK 11
           uses: actions/setup - java@v2
           with:
             java - version: '11'
         - name: Gradle Detekt Check
           run:./gradlew detekt
   

2. 使用其他CI/CD工具：
   • GitLab CI/CD：在.gitlab-ci.yml中配置类似的检查步骤，例如：

   image: gradle:latest
   
   stages:
     - check
   
   ktlint - check:
     stage: check
     script:
       -./gradlew ktlintCustomCheck
   detekt - check:
     stage: check
     script:
       -./gradlew detekt
   

   • CircleCI：在.circleci/config.yml中配置：

   version: 2.1
   jobs:
     ktlint - check:
       docker:
         - image: cimg/openjdk:11.0.13
       steps:
         - checkout
         - run:./gradlew ktlintCustomCheck
     detekt - check:
       docker:
         - image: cimg/openjdk:11.0.13
       steps:
         - checkout
         - run:./gradlew detekt
   workflows:
     version: 2
     build - and - test:
       jobs:
         - ktlint - check
         - detekt - check
   

通过以上步骤，可以基于Kotlin现有的静态检查框架创建自定义规则，并集成到项目的CI/CD流程中，保证团队代码的一致性和规范性。