学习如何使用 DeepReview

快速开始

10 分钟内完成 DeepReview 接入。本指南将引导您将 AI 代码审查集成到您的 Git 工作流程中。

前置要求

• 拥有 Git 仓库管理员权限（支持 GitHub、GitLab 或 Gitee）
• DeepReview 企业账户（联系我们开通）
• 用于仓库访问的 SSH 密钥对，或部署令牌（Token 鉴权方式）

第一步：获取企业账户

联系我们的团队创建您的企业账户。创建完成后，您将收到：

• 企业名称：您的唯一登录标识
• 初始密码：临时密码（首次登录后请修改）

第二步：登录企业门户

访问企业门户地址：

https://www.deepcodereviewer.com/portal

输入您的企业名称和密码登录。首次登录后，我们强烈建议您修改密码以确保安全。

第三步：添加代码仓库

登录后，导航至 「仓库」 标签页，点击 「+ 添加仓库」 按钮。

企业门户 - 仓库管理页面

在表单中填写仓库详细信息。DeepReview 支持两种鉴权方式：

方式 A：SSH 密钥鉴权

1. 名称：输入仓库的显示名称（如 "my-project"）
2. 鉴权方式：选择 「SSH Key」
3. 仓库地址：输入 SSH 格式的仓库地址（如 git@github.com:your-org/your-repo.git）
4. SSH 私钥：粘贴 SSH 私钥（该密钥需要有仓库读取权限）
5. 启用代码审查：勾选此框以激活自动审查
6. 点击 「添加仓库」 保存

方式 B：Token 令牌鉴权

1. 名称：输入仓库的显示名称（如 "my-project"）
2. 鉴权方式：选择 「Token」
3. Git Clone 命令：粘贴包含凭据的完整克隆命令，格式要求如下：

   git clone https://<用户名>:<部署令牌>@gitlab.example.com/group/project.git

   注意：输入必须严格遵循上述格式 —— 以 git clone 开头，后接包含凭据的 HTTPS URL（用户名:令牌@主机地址）。令牌凭据将被加密安全存储。系统会自动从克隆命令中提取仓库地址。
4. 启用代码审查：勾选此框以激活自动审查
5. 点击 「添加仓库」 保存

添加仓库表单

ssh-keygen -t ed25519 -C "deepreview@your-company.com" -f deploy_key

第四步：配置 Webhook

在您的 Git 平台设置 Webhook，以便在代码推送时通知 DeepReview：

https://www.deepcodereviewer.com/api/webhook/<您的企业名称>

GitHub 配置

1. 进入仓库 → Settings → Webhooks → Add webhook
2. 将 Payload URL 设置为上述 Webhook 地址
3. 将 Content type 设置为 application/json
4. 选择 "Just the push event"
5. 点击 Add webhook

GitLab 配置

1. 进入项目 → 设置 → Webhooks
2. 输入上述 Webhook 地址
3. 勾选 Push events
4. 点击 Add webhook

Gitee 配置

1. 进入仓库 → 管理 → WebHooks → 添加 WebHook
2. 输入上述 Webhook 地址
3. 选择 Push 事件
4. 点击 添加

第五步：推送代码，获取审查

完成！现在当您向仓库推送代码时，DeepReview 将自动：

1. 接收来自 Git 平台的 Webhook 通知
2. 克隆您的仓库并分析代码变更
3. 使用 ReAct AI 引擎进行深度代码审查
4. 在几分钟内生成详细的审查报告

在企业门户的 「审查任务」 标签页查看所有审查任务：

代码审查任务 - 监控审查状态并访问报告

点击任何已完成任务的 「查看报告」 按钮查看详细的 AI 代码审查：

详细代码审查报告 - 包含变更摘要、文件分析和 AI 建议

安装部署

DeepReview 以云端 SaaS 平台的形式提供服务，可无缝集成到您的开发工作流程中。

云端 SaaS 平台

最快速、最简单的入门方式。无需基础设施管理。

1. 联系我们的销售团队创建企业账户
2. 接收您的企业凭证（企业名称和初始密码）
3. 登录企业门户 www.deepcodereviewer.com/portal
4. 添加您的代码仓库并配置 SSH 密钥或部署令牌
5. 在 Git 平台配置 Webhook
6. 开始自动接收 AI 代码审查

私有化部署（企业版）

对于有特定合规性或数据主权要求的组织，我们提供私有化部署方案。

ReAct 引擎

ReAct（推理与行动）引擎是 DeepReview 智能代码审查能力的核心。与传统的静态分析器不同，ReAct 引擎能够思考、探索和迭代，直到完全理解代码变更。

工作原理

ReAct 引擎以迭代循环的方式运行，类似于人工审查员处理代码的方式：

ReAct 执行示例

# 思考 1
PR 修改了认证函数。我需要了解密码哈希是如何实现的。

# 行动 1
read_file("src/auth/password.ts")

# 观察 1
文件包含使用 salt rounds = 10 的 bcrypt 实现

# 思考 2
我发现了一个潜在的安全问题 - salt rounds 被硬编码了。
让我检查是否有安全设置的配置文件。

# 行动 2
search_code("salt.*rounds", "src/", "*.ts")

# 观察 2
找到：config/security.ts 定义了 SALT_ROUNDS 常量

# 思考 3
PR 应该引用配置常量而不是硬编码。
我有足够的上下文来生成审查报告了。

可用工具

AI 代理在审查过程中可以使用以下工具：

审查工作流

了解从 PR 创建到审查完成的完整流程。

同步模式 vs 异步模式

审查输出结构

每次审查生成多种输出：

• 详细报告：包含所有发现的完整分析
• 摘要：用于快速概览的执行摘要
• 建议列表：带严重级别的可操作项
• 行内评论：直接发布到 PR 代码行上

严重级别

重试与容错

DeepReview 实现了多层容错机制以确保可靠的审查。

重试策略