ChatGPT与Git无缝集成：自动化代码审查与提交消息生成实战

1次阅读

没有评论

共计 2867 个字符，预计需要花费 8 分钟才能阅读完成。

在传统的开发流程中，代码审查和提交消息撰写往往是耗时又容易出错的环节。手动审查代码不仅效率低下，而且容易遗漏潜在问题；提交消息则常常被草率处理，导致后期维护困难。这些问题在小团队或个人项目中尤为明显。

市场上已有多种 AI 代码助手，但 ChatGPT API 因其强大的自然语言处理能力和灵活的接口设计脱颖而出：

ChatGPT 优势：
支持自然语言交互，能理解代码上下文
可生成人类可读的审查建议和提交消息
API 调用简单，响应速度快
其他 AI 助手的局限性：
多数专注于代码补全而非审查
缺乏对 Git 工作流的原生支持
输出格式固定，不够灵活

Git hooks 是 Git 在特定事件发生时自动运行的脚本。我们可以利用pre-commithook 在提交前触发代码审查：

在项目根目录创建 .git/hooks/pre-commit 文件
添加可执行权限：chmod +x .git/hooks/pre-commit
编写 hook 脚本调用我们的 Python 程序

获取 Git 暂存区的变更：

import subprocess
diff = subprocess.check_output(['git', 'diff', '--cached']).decode('utf-8')

将 diff 发送给 ChatGPT API 请求审查建议：

response = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[{"role": "system", "content": "你是一个专业的代码审查助手"},
        {"role": "user", "content": f"请审查以下代码变更：\n{diff}"}
    ]
)

基于变更内容生成提交消息：

commit_msg_prompt = f"根据以下代码变更，生成一个简洁专业的提交消息：\n{diff}"
commit_response = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[{"role": "system", "content": "你是一个 Git 提交消息生成器"},
        {"role": "user", "content": commit_msg_prompt}
    ]
)

以下是完整的 pre-commit hook 实现：

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

# 配置 OpenAI API 密钥
openai.api_key = os.getenv("OPENAI_API_KEY")

# 获取暂存区变更
def get_staged_diff():
    try:
        return subprocess.check_output(['git', 'diff', '--cached']).decode('utf-8')
    except subprocess.CalledProcessError:
        return ""

# 生成代码审查建议
def generate_review(diff):
    if not diff:
        return "没有检测到代码变更"

    response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo",
        messages=[{"role": "system", "content": "你是一个专业的代码审查助手"},
            {"role": "user", "content": f"请审查以下代码变更：\n{diff}"}
        ],
        max_tokens=500
    )
    return response.choices[0].message.content

# 主函数
if __name__ == "__main__":
    diff = get_staged_diff()
    review = generate_review(diff)
    print("\n 代码审查建议：")
    print(review)

    # 可以选择将审查建议写入文件或直接显示
    with open(".git/REVIEW_SUGGESTIONS", "w") as f:
        f.write(review)

对小的代码变更使用 gpt-3.5-turbo 模型，响应更快
设置合理的超时时间（建议 3 - 5 秒）
对于大型变更，可以先本地进行静态分析，只将关键部分发送给 API

对 diff 内容计算哈希值作为缓存键
将 API 响应存储在本地文件中
下次遇到相同变更时直接使用缓存结果

import hashlib

def get_cache_key(diff):
    return hashlib.md5(diff.encode()).hexdigest()

def get_cached_review(cache_key):
    cache_file = f".git/chatgpt_cache/{cache_key}"
    if os.path.exists(cache_file):
        with open(cache_file, 'r') as f:
            return f.read()
    return None

def save_to_cache(cache_key, content):
    os.makedirs(".git/chatgpt_cache", exist_ok=True)
    with open(f".git/chatgpt_cache/{cache_key}", 'w') as f:
        f.write(content)

不要将包含 API 密钥、密码等敏感信息的代码发送给外部 API
可以设置关键词过滤，自动跳过敏感文件

SENSITIVE_KEYWORDS = ['password', 'secret', 'api_key']

def contains_sensitive_content(diff):
    return any(keyword in diff.lower() for keyword in SENSITIVE_KEYWORDS)