钩子执行机制

钩子执行机制

Git钩子是在特定事件发生时自动触发的脚本，用于自定义或扩展Git工作流。这些脚本位于.git/hooks目录下，默认包含一系列示例文件，通过修改或创建这些文件可以实现自动化操作。钩子分为客户端钩子和服务端钩子，分别作用于本地仓库和远程仓库。

钩子的类型与触发时机

Git钩子主要分为两大类：客户端钩子和服务端钩子。客户端钩子由本地操作触发，如提交代码、合并分支等；服务端钩子则在远程仓库接收到推送时执行。

客户端钩子

1. pre-commit：在提交消息被输入前运行，常用于检查代码风格或运行测试
2. prepare-commit-msg：在默认提交消息创建后、编辑器启动前执行
3. commit-msg：接收一个包含提交消息的文件路径参数，用于验证消息格式
4. post-commit：在整个提交过程完成后触发

#!/bin/sh
# pre-commit示例：检查是否有调试语句
if git diff --cached | grep 'console.log'; then
  echo "发现调试语句，请移除后提交"
  exit 1
fi

服务端钩子

1. pre-receive：处理来自客户端的推送操作时最先触发
2. update：类似于pre-receive，但会为每个推送的分支各运行一次
3. post-receive：在推送操作完成后执行，可用于通知CI系统

钩子的创建与配置

默认情况下，Git仓库的.git/hooks目录包含示例脚本，这些脚本以.sample结尾。要启用某个钩子，需要移除.sample后缀并确保脚本有可执行权限。

# 启用pre-commit钩子
mv .git/hooks/pre-commit.sample .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

对于复杂的钩子逻辑，可以考虑使用Node.js等脚本语言编写：

#!/usr/bin/env node
// commit-msg钩子：验证提交消息格式
const fs = require('fs');
const msg = fs.readFileSync(process.argv[2], 'utf-8').trim();

const commitRegex = /^(feat|fix|docs|style|refactor|test|chore)\(.*\): .+/;

if (!commitRegex.test(msg)) {
  console.error(`无效的提交消息格式："${msg}"`);
  console.error('示例: feat(authentication): 添加登录功能');
  process.exit(1);
}

钩子的执行环境与限制

Git钩子在特定环境下执行，需要注意以下几点：

1. 钩子脚本的工作目录始终是Git仓库的根目录
2. 标准输入可能被重定向，不能依赖交互式输入
3. 退出状态码决定是否继续Git操作：0表示成功，非0将中止当前操作

对于需要共享的钩子，可以考虑以下方案：

1. 将钩子脚本存储在项目目录中（如scripts/hooks）
2. 通过符号链接或安装脚本复制到.git/hooks
3. 使用husky等工具管理Git钩子

# 创建符号链接示例
ln -s ../../scripts/hooks/pre-commit .git/hooks/pre-commit

高级钩子使用场景

多钩子管理

大型项目可能需要组织多个钩子脚本，可以通过主钩子调用其他脚本：

#!/bin/sh
# pre-commit主钩子
./scripts/hooks/linter.sh && \
./scripts/hooks/tests.sh && \
./scripts/hooks/security-check.sh

条件执行

有时需要根据环境或分支决定是否执行钩子：

#!/usr/bin/env node
// 仅在master分支执行严格检查
const branch = require('child_process').execSync('git symbolic-ref --short HEAD').toString().trim();
if (branch === 'master') {
  // 执行严格验证
} else {
  process.exit(0);
}

跨平台兼容性

使用Shell脚本时需考虑跨平台兼容性，可以在脚本开头指定解释器：

#!/usr/bin/env bash
# 使用env查找bash位置，提高可移植性

钩子的调试与问题排查

调试Git钩子可能具有挑战性，因为它们在Git命令执行期间运行。以下方法可以帮助调试：

1. 在脚本中添加调试输出
2. 捕获并记录标准错误
3. 使用set -x启用Shell脚本调试模式

#!/bin/bash
# 启用调试模式
set -x

# 钩子逻辑...
echo "Debug info" >&2

# 禁用调试模式
set +x

对于复杂的调试场景，可以临时重定向输出到文件：

exec 1> /tmp/git-hook-debug.log 2>&1
echo "Starting hook execution at $(date)"

钩子的性能考量

钩子执行会增加Git操作的延迟，特别是当它们执行耗时任务时。优化建议包括：

1. 对于频繁触发的钩子（如pre-commit），保持轻量级
2. 将耗时检查移至后台进程或CI系统
3. 使用缓存避免重复计算

#!/bin/bash
# 使用缓存优化ESLint检查
changed_files=$(git diff --cached --name-only --diff-filter=ACM "*.js" | tr '\n' ' ')
if [ -z "$changed_files" ]; then
  exit 0
fi

cache_file="/tmp/eslint-cache-$(git rev-parse HEAD)"
if [ -f "$cache_file" ]; then
  exit 0
fi

./node_modules/.bin/eslint $changed_files
touch "$cache_file"

安全注意事项

Git钩子脚本具有与执行用户相同的权限，需要特别注意：

1. 不要从不受信任的来源复制钩子脚本
2. 定期审查钩子脚本内容
3. 考虑在敏感操作前要求确认
4. 限制服务端钩子的执行权限

#!/bin/bash
# 危险操作前确认
read -p "即将执行数据库迁移，确认继续？[y/N] " confirm
if [[ $confirm != [yY] ]]; then
  echo "操作已取消"
  exit 1
fi