使用 Hooks 实现 SVN 提交前代码规范检查与自动化部署

在团队协作开发中，代码质量和部署效率是两大核心痛点。SVN 作为经典的集中式版本控制工具，虽然不像 Git 那样拥有丰富的本地钩子生态，但通过其服务端 hooks 机制，我们同样可以在代码提交前进行规范检查，并在提交后自动触发部署流程。本文将带你从零开始，搭建一套基于 SVN hooks 的自动化工作流。

为什么选择 SVN Hooks

SVN 的 hooks 是服务端在特定事件发生时自动执行的脚本，位于版本库的 hooks 目录下。常用的钩子包括：

• pre-commit：提交前触发，可用于代码规范检查、日志格式校验，返回非零值则拒绝提交
• post-commit：提交成功后触发，常用于通知、自动化部署
• pre-revprop-change：修改版本属性前触发
• start-commit：提交事务开始前触发

相比在客户端做检查，服务端 hooks 的优势在于强制执行、不可绕过，所有开发者共享同一套规则，非常适合团队规范化管理。

环境准备

假设你的 SVN 版本库路径为 /var/svn/myproject，工作副本部署目录为 /var/www/myproject。确保服务端已安装以下工具：

# 以 Ubuntu/Debian 为例
sudo apt-get install subversion python3 php-cli

所有 hook 脚本必须放在 /var/svn/myproject/hooks/ 目录下，并赋予可执行权限。脚本头部需要声明解释器，例如 #!/usr/bin/env python3。

实现 pre-commit 代码规范检查

pre-commit 钩子接收两个参数：版本库路径和正在提交的事务名。我们可以通过 svnlook 命令获取本次提交的详细信息。

1. 基础框架

创建 /var/svn/myproject/hooks/pre-commit：

#!/usr/bin/env python3
import sys
import subprocess
import os

REPOS = sys.argv[1]
TXN = sys.argv[2]

def get_changed_files():
    """获取本次提交变更的文件列表"""
    cmd = ['svnlook', 'changed', REPOS, '-t', TXN]
    output = subprocess.check_output(cmd).decode('utf-8')
    files = []
    for line in output.splitlines():
        # 每行格式如 "A   path/to/file.php"
        parts = line.strip().split(None, 1)
        if len(parts) == 2:
            files.append(parts[1])
    return files

2. 日志格式校验

强制要求提交日志包含任务编号，例如 [TASK-123] 修复登录问题：

import re

def check_log_message():
    cmd = ['svnlook', 'log', REPOS, '-t', TXN]
    log = subprocess.check_output(cmd).decode('utf-8').strip()
    if not log:
        return False, "提交日志不能为空"
    if not re.match(r'^\[TASK-\d+\]', log):
        return False, "提交日志必须以 [TASK-编号] 开头，例如 [TASK-123] 修复登录问题"
    return True, ""

3. PHP 语法检查

对本次提交的 PHP 文件逐一执行 php -l 语法检测：

def check_php_syntax(files):
    errors = []
    for f in files:
        if not f.endswith('.php'):
            continue
        # 读取事务中该文件的内容
        cmd = ['svnlook', 'cat', REPOS, f, '-t', TXN]
        try:
            content = subprocess.check_output(cmd)
        except subprocess.CalledProcessError:
            continue  # 可能是删除操作
        # 写入临时文件进行语法检查
        tmp = '/tmp/svn_check_%d.php' % os.getpid()
        with open(tmp, 'wb') as fp:
            fp.write(content)
        result = subprocess.run(['php', '-l', tmp],
                                capture_output=True)
        if result.returncode != 0:
            errors.append("%s: %s" % (f, result.stderr.decode()))
        os.remove(tmp)
    return errors

4. 主流程与退出码

def main():
    # 1. 日志检查
    ok, msg = check_log_message()
    if not ok:
        sys.stderr.write("提交被拒绝：" + msg + "\n")
        sys.exit(1)

    # 2. 语法检查
    files = get_changed_files()
    errors = check_php_syntax(files)
    if errors:
        sys.stderr.write("代码语法检查未通过：\n")
        for e in errors:
            sys.stderr.write(e + "\n")
        sys.exit(1)

    sys.exit(0)

if __name__ == '__main__':
    main()

设置可执行权限：

chmod +x /var/svn/myproject/hooks/pre-commit

此后任何不符合规范的提交都会被直接拒绝，并在客户端显示错误信息。

实现 post-commit 自动化部署

pre-commit 保证了质量，post-commit 则负责把通过的代码自动部署到目标环境。

创建 /var/svn/myproject/hooks/post-commit：

#!/bin/bash
REPOS="$1"
REV="$2"

WORKDIR="/var/www/myproject"
LOG="/var/log/svn_deploy.log"

echo "[$(date '+%Y-%m-%d %H:%M:%S')] 开始部署 r${REV}" >> $LOG

# 更新工作副本
svn update "$WORKDIR" --non-interactive --username deploy --password 'xxxxxx' >> $LOG 2>&1

if [ $? -eq 0 ]; then
    echo "[$(date '+%Y-%m-%d %H:%M:%S')] 部署成功 r${REV}" >> $LOG
    # 可选：清理缓存、重启服务
    # systemctl reload php-fpm
else
    echo "[$(date '+%Y-%m-%d %H:%M:%S')] 部署失败 r${REV}" >> $LOG
fi

同样需要赋予执行权限。注意 post-commit 在提交事务完成后才运行，因此不会阻塞用户提交，非常适合做异步部署。

常见问题与优化建议

1. 性能问题：pre-commit 会阻塞提交，检查逻辑不宜过重。对于大型项目，可以只检查变更文件而非全量文件。
2. 权限问题：hook 脚本以运行 SVN 服务的用户身份执行（通常是 www-data 或 apache），确保该用户对部署目录和日志文件有写权限。
3. 编码问题：Python 脚本处理中文日志时注意使用 UTF-8 编码，避免乱码。
4. 回滚机制：自动化部署建议保留最近几个版本，方便快速回滚。
5. 通知集成：可在 post-commit 中调用企业微信、钉钉或邮件接口，把部署结果推送给团队。

总结

通过 SVN 的 pre-commit 和 post-commit 两个钩子，我们构建了一条从代码提交到自动部署的完整流水线：提交前强制校验日志格式与代码语法，从源头拦截低级错误；提交后自动更新部署目录，让上线变得无感。这套方案无需引入复杂的 CI 工具，特别适合中小团队快速落地。当然，随着项目规模增长，也可以平滑迁移到 Jenkins、GitLab CI 等更强大的持续集成平台，而 hooks 阶段积累的规范意识，将成为团队工程化能力的重要基石。

未经允许不得转载：任鹏个人博客 » 使用 Hooks 实现 SVN 提交前代码规范检查与自动化部署