Git Hooks的作用及创建使用示例详解

Git Hooks是Git中一种有助于Git版本库操作自动化的工具，使用Git Hooks可以在提交、推送、合并等Git操作时执行一些自定义脚本，从而增强Git的功能和灵活性。

Git Hooks提供了多种类型的钩子，常用的有pre-commit、pre-push、pre-rebase、post-merge等，每个钩子都是一个执行脚本文件的入口，当应用到对应Git操作时，就会执行这个脚本。

Git Hooks的用途

Git Hooks的具体用途如下：

• 预防不合法的代码提交：在提交代码前进行单元测试、代码静态检查等，以保持版本库的质量和稳定性。
• 实现团队规范：规范团队成员的代码风格、提交信息格式等，以保证团队合作的顺畅。
• 自动化部署：当项目代码库被更新时，自动触发部署脚本，避免手动部署过程中由人的疏忽或错误带来的影响。

在实际应用Git Hooks之前，我们需要了解如何创建和使用Git Hooks。

创建Git Hooks

Git Hooks的脚本文件存放在.git/hooks目录下，创建Git Hooks的步骤如下：

1. 进入代码库目录，使用命令ls .git/hooks查看Git Hooks目录。

$ cd /path/to/repo
$ ls .git/hooks
applypatch-msg.sample pre-rebase.sample
commit-msg.sample prepare-commit-msg.sample
fsmonitor-watchman.sample update.sample
post-update.sample

1. 创建Git Hooks脚本文件。以pre-commit为例，在.git/hooks目录下，使用命令cp pre-commit.sample pre-commit，将pre-commit.sample复制为pre-commit脚本文件。

$ cd .git/hooks
$ cp pre-commit.sample pre-commit

1. 编辑pre-commit脚本文件，并添加需要执行的脚本内容。

#!/bin/bash
echo "Running pre-commit hook..."

上述脚本中，我们简单地输出了一条信息"Running pre-commit hook..."。一旦提交代码时，pre-commit脚本就会执行。

1. 赋予pre-commit脚本执行权限。因为pre-commit脚本不是可执行程序，需要赋予权限后才能执行。

$ chmod +x pre-commit

如果你使用了其他类型的Git Hooks，例如pre-push，需要与上述步骤类似，将其复制为pre-push文件，并编辑相应内容。

Git Hooks使用示例1：代码检查

假设我们在团队中使用JavaScript语言开发，为保证代码风格的一致性和规范性，引入了ESLint代码检查工具，以检查代码风格是否满足团队规范。使用pre-commit钩子对代码进行检查。

1. 安装ESLint，使用npm进行安装。在代码库根目录下，命令行输入npm install eslint -D，在本地安装ESLint模块。

2. 创建pre-commit脚本并添加代码检查的命令：

```
#!/bin/bash

ESLINT="$(git rev-parse --show-toplevel)/node_modules/.bin/eslint"
FILES=$(git diff --cached --name-only --diff-filter=ACM "*.js" | grep -vE '(.min.js)')

if [ "$FILES" = "" ]; then
exit 0
fi

PASS=true
for FILE in $FILES
do
$ESLINT "$FILE"
if [ $? != 0 ]; then
PASS=false
fi
done

if ! $PASS; then
echo -e "\n\x1B[41m\x1B[30m ESLint Failed: Fix the errors and try again. \x1B[0m\n"
exit 1
else
echo -e "\x1B[42m\x1B[30m Passed the ESLint check. \x1B[0m"
fi
```

上述脚本通过查找.git/hooks目录的上级目录，确定当前代码库所在的顶级目录，并找到其中的ESLint可执行文件。接着使用git diff命令查询修改的JavaScript文件，并且仅对未添加到提交缓存区中的文件进行检查。最后如果ESLint检查未通过，则阻止提交，并退出pre-commit操作。

1. 将pre-commit脚本赋予权限 chmod +x pre-commit，确保pre-commit脚本文件可执行。

2. 使用git add命令添加文件到暂存区，接着使用git commit提交代码。在此期间如果代码风格未通过ESLint检查，则阻止提交。

Git Hooks使用示例2：自动部署

假设我们的GitHub代码库与VPS服务器目录/usr/local/src/some_project/代码仓库关联，为了实现自动部署，我们需要在post-receive钩子中添加自动部署脚本。

1. 编写自动部署脚本deploy.sh，并使用命令将其复制到代码库.git/hooks目录下。

```
#!/bin/bash

GIT_REPO=$HOME/some_project/
TMP_GIT_CLONE=$HOME/tmp/some_project/
PUBLIC_WWW=/var/www/some_project

git clone $GIT_REPO $TMP_GIT_CLONE
cd $TMP_GIT_CLONE
composer install
cp -r $TMP_GIT_CLONE/* $PUBLIC_WWW/
rm -rf $TMP_GIT_CLONE
exit 0
```

上述脚本是一个简单的部署脚本，以将项目代码复制到服务器部署目录为例。以上述目录为例，其中$GIT_REPO为源代码库，$TMP_GIT_CLONE为部署前暂存代码库，$PUBLIC_WWW为部署目录。在脚本中，我们首先将代码仓库clone到本地临时目录进行部署前准备工作，接着使用composer进行依赖安装，最后复制代码到部署目录，完成部署。脚本的最后一行exit 0表示脚本执行状态为成功，退出脚本执行。

1. 编辑.git/hooks/post-receive文件，并添加自动部署脚本的代码，使得post-receive钩子在服务器接收到Git应用程序执行“git push”命令后被执行。

```
#!/bin/bash

set -x

DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
OLDREV=$1
NEWREV=$2
REFNAME=$3

while read oldrev newrev refname; do
branch=$(git rev-parse --symbolic --abbrev-ref $refname)
if [[ "master" == "$branch" ]]; then
. $DIR/deploy.sh
fi
done
```

该脚本首先获取目录信息，然后从输入行中读取oldrev、newrev和refname这三个变量，接着从其中读取分支信息（这里我们默认使用主分支），最后执行deploy.sh脚本。

1. 赋予权限chmod +x post-receive，确保post-receive脚本文件可执行。

2. 在本地执行“git push”命令，会自动触发post-receive钩子，执行自动部署脚本，实现自动化部署。

总结

通过本文我们了解到Git Hooks的作用，并学会了创建Git Hooks的过程和运用经验。实际应用中，有了Git Hooks，我们可以针对具体的项目需求制定不同的钩子脚本，自动化完成代码检查、自动部署等任务，大大提高了开发效率和代码质量。具体使用中，我们需要根据项目实际需要，选择不同的Git Hooks类型，并按照规范编写脚本和执行操作，从而更好地应用Git Hooks。