AI 助理实战:自动代码评审

更新时间:
复制 MD 格式

DataWorks AI 助理可按照团队内部的代码评审规范,对代码评审单自动执行检查、决策与结果写回。当团队已有明确的编码规范,但人工逐条检查耗时且容易遗漏时,只需提供团队评审规范,AI 助理即可完成规范上传、自动检查与结果写回,替代重复性的人工审查。

两种使用模式

AI 自动代码评审支持两种使用模式,请根据场景选择:

对比项

主动发起评审

定时自动评审

触发方式

用户主动发起

定时自动触发

执行模式

人机协作

全自动执行

Critical 违规处理

暂停执行,等待人工确认

AI 自动驳回(默认,可配置为人工确认或仅展示)

适用场景

首次使用、调试规范、少量评审

日常运营、大量评审单

是否需要先沉淀 SKILL

否(可直接上传规范)

是(需要先创建 SKILL)

首次使用时,建议先通过“主动发起评审”验证规范效果,满意后再沉淀为 SKILL 并配置定时评审。推荐路径如下:

准备评审规范 → 主动发起评审(验证效果)
                    ↓
              效果满意?→ 沉淀为 SKILL → 配置定时自动评审

前提条件

使用 AI 自动代码评审前,需满足以下条件:

  • 已创建 DataWorks AI 助理实例。如未创建,请参见使用AI助理服务。

  • 已在 AI 助理实例详情页的Skill管理页签中,筛选系统类型的 SKILL,找到 DataWorks 场景化治理巡检 并启用。

  • 确保当前地域的DataWorks版本为专业版或企业版。

  • 如需对不合规的代码进行发布阻塞,推荐在目标工作空间的开发配置中,开启强制评审开关。

准备代码评审规范

根据团队的规则和业务规范,编写一份结构化的代码评审规范文档(Markdown 格式),作为 AI 助理的审查依据。AI 助理的审查能力取决于规范质量,建议规范包含以下要素:

  • 明确严重等级:将规则划分为 Critical(严重违规,建议驳回)和 Suggestion(建议优化,可通过但需关注)两个等级。

  • 提供检查方法与示例:每条规则说明 AI 应该怎么查以及什么是错的,让 AI 有明确的判断依据。

    以下为规范示例(3 条分层依赖规则):

    #

    规则

    严重等级

    检查方法

    R1

    ADS 不能直接依赖 ODS

    Critical

    SQL 中 FROM/JOIN 引用 ods_ 开头的表

    R2

    ADS 之间禁止相互依赖

    Critical

    SQL 中 FROM/JOIN 引用其他 ads_ 开头的表

    R3

    ADS 避免直接引用 DWD

    Suggestion

    应优先使用 DWS/DIM 层数据

评审规范示例,可参考附录:审查规范示例。

主动发起评审(人机协作模式)

此模式下,通过 AI 助理 WEB 端对话上传团队规范并下发评审指令,AI 助理自动完成检查;对于 Critical 违规会暂停执行并等待人工确认。

步骤一:拉取代码评审单

  1. 登录DataWorks 控制台,在左侧导航栏单击AI 助理服务。

  2. 单击目标 AI 助理实例名称,在AI助理详情页右上角,单击打开对话,进入WEB端对话页面。。

  3. 在左侧边栏选择对话页签,单击顶部 + 新任务 按钮创建新对话。

  4. 在对话框中输入指令,例如:

    查看 959211 空间下有哪些待我评审的代码评审单
  5. AI 助理返回当前待评审的评审单列表,表示已成功获取评审对象。

步骤二:下发代码评审指令

向 AI 助理下发评审指令,需包含以下三个要素:

要素

说明

示例值

评审依据

告诉 AI 按照哪份规范进行检查

上传的团队代码评审规范文件名

通过条件

满足什么条件时 AI 可以自动通过

无 Critical 违规 → 写入评审记录,并自动通过评审

驳回条件

满足什么条件时 AI 需要暂停并等待人工确认

有 Critical 违规 → 暂停执行,列出违规详情,等待人工确认

操作步骤:

  1. 在对话框中上传团队代码评审规范文件(Markdown 格式)和结果推送模板,可参考:

    1. 评审规范示例:审查规范示例。

    2. 结果推送模板示例:报告推送模板。

  2. 在对话框中输入评审指令,例如:

    根据代码评审规范,对待我评审的代码执行评审,注意通过/驳回条件:
    • 无 Critical 违规 → 写入评审记录,并自动通过评审
    • 有 Critical 违规 → 写入评审记录后,暂停执行。列出所有 Critical findings(含规则编号、问题描述、修复建议),等待我逐条确认后再按我的指示执行通过或驳回。
  3. AI 助理开始逐条检查代码评审单。

步骤三:查看评审结果并人工确认

AI 助理完成检查后,根据评审结果执行以下操作:

  • 无 Critical 违规:AI 助理会自动通过评审,并写入评审记录。

  • 有 Critical 违规:AI 助理暂停执行,列出所有违规详情(含规则编号、问题描述、修复建议),等待逐条确认。

    当 AI 助理暂停等待确认时,可根据建议回复“确认通过”或“确认拒绝”,AI 助理随即在 DataWorks 中执行对应操作并写入评审记录。

步骤四:验证评审结果

前往DataStudio,选择目标工作空间,单击左侧导航中的代码评审详情,可以查看AI助理对任务代码执行的评论和评审操作,对比 AI 评审结果与预期结果,确认 AI 助理的评审准确性。以下为验证示例:

评审单

违规等级

预期结果

实际结果

AI评审记录

地区交易排行分析

Critical:ADS 依赖 ODS

拒绝,需人工确认

拒绝,已人工确认

【纯净版 CR(用户自定义规则)】检查规则:零售电商团队内部代码审查规范(11条)。检查结果:发现 1 条 Critical 违规。 R1(Critical):ADS 节点 ads_ec_trd_area_rank 直接引用了 2 张 ODS 表(ods_trade_order、ods_t_area),违反"ADS 不能直接依赖 ODS"规则。修复建议:将 ODS 表替换为 DWS/DWD 层表,确保依赖链路符合 ODS→DWD/DIM→DWS→ADS。决策:驳回。

消费者购物旅程分析日报

Suggestion:ADS 依赖 DWD

通过

通过

【纯净版 CR(用户自定义规则)】检查规则:零售电商团队内部代码审查规范(11条)。检查结果:无 Critical 违规。Suggestion: R3-ADS 直接引用 3 张 DWD 表(dwd_ec_log_search_di, dwd_ec_collect_di, dwd_ec_trd_create_ord_di),建议后续优化为 DWS 层汇总表。决策:通过。

品类交易大盘

Critical:ADS 依赖 ADS

拒绝,需人工确认

拒绝,已人工确认

【纯净版 CR(用户自定义规则)】检查规则:零售电商团队内部代码审查规范(11条)。检查结果:发现 1 条 Critical 违规。R2(Critical):ADS 节点 ads_ec_trd_category_dashboard 引用了 2 张其他 ADS 表(ads_ec_itm_hot_rank、ads_ec_trd_gmv_kpi),违反"ADS 之间禁止相互依赖"规则。此外使用了 CROSS JOIN,可能导致数据膨胀。修复建议:将依赖下沉到 DWS 层,将 CROSS JOIN 改为带关联条件的 JOIN。决策:驳回。

如果结果与预期不符,可调整规范描述或评审指令后重新执行。

将评审流程沉淀为 SKILL

完成一次手动评审并验证效果满意后,可将整个评审流程沉淀为一个可复用的 SKILL,让 AI 助理在后续使用中自动加载团队规范,无需每次重复上传规范和编写指令。

步骤一:创建代码评审 SKILL

在 AI 助理对话框中输入以下指令,AI 助理会自动将评审流程整理为 SKILL。命名前需注意 SKILL 的硬性约束:名称需满足正则 ^[a-zA-Z0-9_-]+$ 且最长 64 字符,描述最长 256 字符,SKILL 文件仅支持 .zip 格式。

将上述过程复盘整理为一个名为 dataworks-ai-code-review 的 AI 自动代码评审 SKILL,后续当指令要求使用自定义的团队代码评审规范进行代码评审时,均使用该 SKILL。 注意:
● 《零售电商团队内部代码审查规范.md》需要单独维护为一个文档,作为 SKILL 的知识库。
● 创建完成后,检查下 SKILL 是否打包并安装成功

可在指令中补充以下要求,提升 SKILL 的执行质量:

  • 禁止跳过团队规范任何章节(必须全部输出)。

  • 禁止跳过任何规则(每条都要判定,不适用的规则标注“-”)。

  • 报告包含基本信息、代码 Diff、规范逐条检查结果和评审建议。

步骤二:确认 SKILL 注册情况

SKILL 创建成功后,可在 AI 助理实例详情页的技能页签中查看。如果页面未显示,通过对话让 AI 助理手动注册:

将 dataworks-ai-code-review SKILL 注册到管控页。

注册成功后,在技能页签中筛选自定义,即可看到 dataworks-ai-code-review。

步骤三:使用 SKILL 进行评审

沉淀 SKILL 后,可通过简单指令触发评审,无需重复上传规范和编写详细指令:

用 dataworks-ai-code-review SKILL 帮我评审 959211 空间的代码评审单。

AI 助理会自动加载团队规范、拉取评审单、执行逐条检查并输出评审报告。

定时自动评审(全自动模式)

如果希望 AI 助理自动评审新的评审单(而非每次手动触发),可配置定时评审任务。此模式下,AI 助理全自动执行评审:自动通过合规的评审单,自动驳回违规的评审单,并通过评审报告告知结果。

重要

此模式依赖 SKILL,必须先完成“将评审流程沉淀为 SKILL”章节的操作。

步骤一:创建定时评审任务

  1. 登录DataWorks 控制台,在左侧导航栏单击AI 助理服务。

  2. 单击目标 AI 助理实例名称右侧操作列的对话按钮。

  3. 在左侧边栏切换到 定时 页签(与“主动发起评审”使用的对话历史入口不同),在已有对话中输入创建定时任务的指令,例如:

    创建一个每 5 分钟执行一次的代码评审任务,自动拉取 959211 空间下待我评审的代码评审单并完成评审,评审结果按照推送模板《报告推送模板》推送到当前窗口。
    【注意事项】
    • 使用 dataworks-ai-code-review skill,按照零售电商团队规范自动完成评审,无需人工确认。
    【通过/驳回条件】(重要!)
    • 无 Critical 违规 → 写入评审记录,并自动通过评审。
    • 有 Critical 违规 → 写入评审记录,并自动驳回评审。
  4. 如果您已经配置IM端,可以在IM 端中通过对话方式开启定时任务,由机器人将评审过程或者结果推送至钉钉、飞书或者微信的私聊或者群聊,方便您在移动端查看和处理代码评审任务。

  5. 配置完成后,AI 助理按指定周期自动扫描工作空间中的待评审单,触发 SKILL 完成审查,并评审报告推送到当前对话窗口。

步骤二:确认任务并查看评审结果

创建完成后,在左侧边栏的定时任务页签中确认评审任务已生成,并可查看其执行历史和评审报告。首次评审窗口到达后,AI 助理会将评审报告推送到当前对话窗口,即表示任务已生效。评审报告包含以下信息:

  • 本次评审扫描的评审单数量

  • 各评审单的检查结果(通过/驳回及原因)

  • 已执行的操作(评审记录写入情况)

说明

如果定时任务的评审结果不符合预期,可修改定时任务指令。例如,对于 Critical 违规仅展示问题而不做写回操作,或要求 Critical 违规需人工确认后再决策。

限制与注意事项

  • dataworks-governance-scenario 是官方 SKILL,AI 助理通过该 SKILL 获取代码评审相关能力(如拉取评审单、执行通过/驳回操作)。删除或禁用该 SKILL 将导致代码评审功能不可用。

  • AI 助理的评审质量取决于规范文档的质量。建议规范文档包含明确的规则编号、严重等级、检查方法和示例,避免模糊描述。

  • 定时评审任务通过 AI 助理对话指令创建和管理,并非界面功能。

常见问题

  • Q:AI 助理评审结果与预期不符怎么办?

    A:检查以下方面并逐步排查:

    1. 规范文档中的规则描述是否足够明确,是否提供了检查方法和判定条件。

    2. 评审指令中的通过/驳回条件是否清晰,AI 助理是否能准确理解其中的决策逻辑。

    3. 如果 AI 将 Critical 违规误判为通过,可在规范中补充更具体的示例和反例。

    此外,建议在评审指令中明确强调强制要求和禁止行为,避免 AI 助理自行简化评审过程。可补充的约束如下:

    • 禁止跳过团队规范的任何章节,必须全部输出检查结果。

    • 禁止跳过任何规则,每条规则都需给出判定结论,不适用的规则需明确标注。

    • 禁止在存在 Critical 违规时自行放行,必须按指令中的驳回条件执行。

    • 评审报告需包含基本信息、代码变更内容、规范逐条检查结果和评审建议。

  • Q:如何修改已创建的定时评审任务?

    A:在 AI 助理 WEB 端对话页,进入创建任务时的对话,向 AI 助理下发修改指令即可调整评审频率、评审范围或通过/驳回条件。

  • Q:沉淀的 SKILL 如何更新评审规范?

    A:当团队评审规范更新后,需重新上传规范文件并让 AI 助理更新 SKILL 中的知识库内容。可通过对话指令要求 AI 助理“更新 dataworks-ai-code-review SKILL 的评审规范”来完成。

附录:审查规范示例

# 零售电商团队内部代码审查规范

> 适用于工作空间 959211(零售电商业务域 ec),AI 代码评审时必须检查以下规则。

---

## 一、建表与命名规范
> 表命名模板(强制)

| 分层 | 命名模板 | 示例 |
|---|---|---|
| ODS | `ods_ec_{业务域}_{源表名}_{刷新周期}` | `ods_ec_trd_trade_order_di` |
| ADS | `ads_ec_{数据域}_{集市}_{主题}_{粒度}_{统计周期}` | `ads_ec_ec360_gmv_kpi_overview` |

**检查要点**:
- 所有表名必须包含 `_ec_`(零售电商业务域标识)
- 禁止双下划线 `__`


## 二、数仓分层依赖规范

### 2.1 合法依赖链路
ODS → DWD → DWS → ADS
ODS → DIM → DWD / DWS / ADS

### 2.2 依赖规则

| # | 规则 | 严重等级 | 检查方法 |
|---|------|---------|---------|
| R1 | **ADS 不能直接依赖 ODS** | Critical | SQL 中 FROM/JOIN 引用 `ods_` 开头的表 |
| R2 | **ADS 之间禁止相互依赖** | Critical | SQL 中 FROM/JOIN 引用其他 `ads_` 开头的表 |
| R3 | **ADS 避免直接引用 DWD** | Suggestion | 应优先使用 DWS/DIM 层数据 |


## 三、变更合理性规范

> 检查本次代码变更本身的合理性和完整性,不依赖规范文件中的其他章节。

| # | 规则 | 严重等级 | 检查方法 |
|---|------|---------|----------|
| C2 | **变更说明充分** | Suggestion | requestDesc 过于简略(如"ceshi"、"测试"、"fix")→ 标注 |
| C3 | **DDL 与 DML 不混合** | Suggestion | 同一节点同时包含 DDL(CREATE/ALTER/DROP)和 DML(INSERT/SELECT),建议拆分为独立节点 | 

附录:报告推送模板

# AI 代码评审报告 · 推送模板

---

## 模板示例

```
⚠️ AI 代码评审 · 工作空间 {workspaceId}

{total} 个待审 CR · {passed} 通过 · {rejected} 驳回 · {ruleSetName}

| 节点 | 版本 | 违规 | 决策 |
|------|------|------|------|
| {nodeName} | {version} |  {ruleId} · {ruleDesc}({detail}) |  驳回 |
| {nodeName} | {version} |  {ruleId} · {ruleDesc}({detail}) |  通过 |

驳回原因:
• {nodeName}:{finding}。{suggestion}

已执行操作:{total} 个 CR 的评审记录已写入 DataStudio,状态均已更新。

以上内容由 AI 生成
```

---

## 完整示例

```
 AI 代码评审 · 工作空间 959211

2 个待审 CR · 0 通过 · 2 驳回 · 零售电商团队规范

| 节点 | 版本 | 违规 | 决策 |
|------|------|------|------|
| 地区交易排行分析 | v29 |  R1 · ADS 直接依赖 ODS(ods_trade_order、ods_t_area) |  驳回 |
| 品类交易大盘 | v19 |  R2 · ADS 之间相互依赖(ads_ec_trd_gmv_kpi、ads_ec_itm_hot_rank) |  驳回 |
| 消费者购物旅程分析日报 | v19 |  R3 · ADS 引用 DWD(Suggestion 级别) |  通过 |

驳回原因:
• 地区交易排行分析:SQL 直接写入 ADS 表但数据源来自 ODS 层的 ods_trade_order 和 ods_t_area,跳过 DWD/DWS 层,违反 R1 命名与分层规范。建议补充中间层逻辑后再提交
• 品类交易大盘:新节点 JOIN 了两张 ADS 表(GMV KPI 表 + 热销商品榜),违反 R2 ADS 禁止相互依赖规则,建议将共用逻辑下沉至 DWS 层后重新提交
• 消费者购物旅程分析日报:引用了 3 张 DWD 明细表,建议后续优化为 DWS 层汇总表

已执行操作:3 个 CR 的评审记录已写入 DataStudio,状态均已更新。

以上内容由 AI 生成
```

附录:指令参考

指令用途

示例指令

拉取评审单

查看 {工作空间ID} 空间下有哪些待我评审的代码评审单

按规范评审(含人工确认)

按照《{规范文件名}》进行代码评审,并输出评审结果。通过/驳回条件:无 Critical 违规自动通过,有 Critical 违规暂停等待确认

创建 SKILL

将上述过程复盘整理为一个名为 {SKILL名称} 的 AI 自动代码评审 SKILL

注册 SKILL 到管控页

将 {SKILL名称} SKILL 注册到管控页

使用 SKILL 评审

用 {SKILL名称} SKILL 帮我评审 {工作空间ID} 空间的代码评审单

创建定时评审任务

创建一个每 {频率} 执行一次的代码评审任务,自动拉取 {工作空间ID} 空间下待我评审的代码评审单并完成评审