面试题：Kotlin 项目使用 Git 时，如何利用钩子（Hooks）实现特定代码规范检查

Question

在一个 Kotlin 项目中，团队有自己的代码规范，例如函数命名必须遵循驼峰命名法，且每行代码长度不能超过 120 字符。请阐述如何在 Git 仓库中设置钩子（Hooks），在代码提交前自动检查 Kotlin 代码是否符合这些规范，如果不符合则阻止提交，并给出具体实现的思路和关键代码示例。

Answer 1

实现思路

1. 安装代码检查工具：例如 ktlint，它是一个 Kotlin 代码格式化和检查工具，可以帮助我们检查函数命名是否遵循驼峰命名法以及代码行长度。
2. 编写钩子脚本：在 Git 仓库的 .git/hooks 目录下创建 pre - commit 钩子脚本。这个脚本会在每次代码提交前执行，调用 ktlint 检查 Kotlin 代码，如果发现不符合规范的代码，就阻止提交。

关键代码示例

1. 安装 ktlint：
   • 如果使用 Gradle，可以在 build.gradle.kts 文件中添加：

   plugins {
       id("org.jlleitschuh.gradle.ktlint") version "11.2.0"
   }
   

   • 然后在命令行执行 ./gradlew ktlintApplyToIdea 来应用配置到 IDE。
2. 编写 pre - commit 钩子脚本：
   • 在 .git/hooks 目录下创建 pre - commit 文件（确保文件有可执行权限，即 chmod +x pre - commit），内容如下：

   #!/bin/sh
   # 检查 Kotlin 文件是否符合 ktlint 规范
   ktlintResult=$(ktlint --relative --reporter=plain src/main/kotlin/**/*.kt 2>&1)
   if [ -n "$ktlintResult" ]; then
       echo "发现不符合代码规范的问题："
       echo "$ktlintResult"
       exit 1 # 非零退出码表示失败，阻止提交
   else
       exit 0 # 零退出码表示成功，允许提交
   fi
   

上述脚本中，ktlint --relative --reporter=plain src/main/kotlin/**/*.kt 命令用于检查项目 src/main/kotlin 目录下所有 Kotlin 文件的代码规范，并以简单文本格式输出结果。如果有不符合规范的地方，输出结果不为空，脚本就会输出错误信息并阻止提交。