面试题：Kotlin与Gradle集成时自定义构建逻辑的深度实现

Question

在Kotlin项目的Gradle构建中，要求在每次构建时对特定目录下的Kotlin源文件进行自定义的代码检查和预处理（比如检查是否遵循特定的代码规范，并对符合条件的代码进行特殊标记）。请详细说明如何在Gradle构建脚本中通过自定义任务和插件来实现这一复杂的构建逻辑，包括如何与Kotlin编译过程集成，以及处理过程中的错误处理机制。

Answer 1

1. 自定义任务

1. 创建自定义任务类：

   import org.gradle.api.DefaultTask
   import org.gradle.api.file.Directory
   import org.gradle.api.tasks.InputDirectory
   import org.gradle.api.tasks.TaskAction
   class CustomKotlinCodeCheckTask : DefaultTask() {
       @get:InputDirectory
       lateinit var sourceDir: Directory
       @TaskAction
       fun checkAndPreprocess() {
           // 遍历sourceDir目录下的Kotlin源文件
           sourceDir.asFileTree.files.forEach { file ->
               if (file.extension == "kt") {
                   // 这里进行代码检查和预处理逻辑
                   val content = file.readText()
                   // 例如，检查是否包含特定关键字，并进行标记
                   val newContent = if (content.contains("specificKeyword")) {
                       content.replace("specificKeyword", "specificKeyword [MARKED]")
                   } else {
                       content
                   }
                   file.writeText(newContent)
               }
           }
       }
   }
   

2. 在Gradle构建脚本中注册任务：

   tasks.register('customKotlinCodeCheck', CustomKotlinCodeCheckTask::class) {
       sourceDir = layout.projectDirectory.dir('src/main/kotlin/specificDir')
   }
   

2. 自定义插件

1. 创建插件类：

   import org.gradle.api.Plugin
   import org.gradle.api.Project
   class CustomKotlinPlugin : Plugin<Project> {
       override fun apply(project: Project) {
           project.tasks.register('customKotlinCodeCheck', CustomKotlinCodeCheckTask::class) {
               sourceDir = project.layout.projectDirectory.dir('src/main/kotlin/specificDir')
           }
       }
   }
   

2. 发布插件（如果需要共享）：
   • 可以将插件发布到Maven仓库，以便其他项目使用。
3. 应用插件：
   • 在项目的build.gradle.kts文件中应用插件：

   plugins {
       id("your.custom.plugin.id") version "1.0.0"
   }
   

3. 与Kotlin编译过程集成

1. 在编译前执行自定义任务：
   • 在build.gradle.kts文件中，将自定义任务配置为kotlinCompile任务的依赖：

   tasks.named("kotlinCompile") {
       dependsOn("customKotlinCodeCheck")
   }
   

   • 这样，每次执行kotlinCompile任务时，会先执行customKotlinCodeCheck任务，确保代码在编译前经过检查和预处理。

4. 错误处理机制

1. 在自定义任务中处理错误：
   • 在CustomKotlinCodeCheckTask的checkAndPreprocess方法中捕获异常：

   @TaskAction
   fun checkAndPreprocess() {
       try {
           sourceDir.asFileTree.files.forEach { file ->
               if (file.extension == "kt") {
                   val content = file.readText()
                   val newContent = if (content.contains("specificKeyword")) {
                       content.replace("specificKeyword", "specificKeyword [MARKED]")
                   } else {
                       content
                   }
                   file.writeText(newContent)
               }
           }
       } catch (e: Exception) {
           logger.error("Error during code check and preprocess: ${e.message}", e)
           // 可以选择抛出异常，使构建失败
           throw RuntimeException("Code check and preprocess failed", e)
       }
   }
   

2. 在Gradle构建脚本中处理任务失败：
   • Gradle默认会在任务失败时停止构建，并输出错误信息。如果需要更复杂的处理，可以在构建脚本中添加失败处理逻辑：

   tasks.whenTaskFailed { task, exception ->
       if (task.name == "customKotlinCodeCheck") {
           logger.error("Custom Kotlin code check task failed: ${exception.message}", exception)
           // 可以进行一些额外的操作，如发送通知等
       }
   }