🚀 CI+GPT 双引擎驱动，🤖 开启 AI 代码评审新纪元

作者：京东科技开发者

2024-06-04
北京
本文字数：2606 字
阅读完需：约 9 分钟

一. 现状问题

代码评审 Code Review 是提高代码质量、促进团队合作、知识间共享的关键环节，对于系统代码质量和稳定性都至关重要。

二. 分析原因

🤔人为代码评审存在的弊端主要源于人力的局限性（如疲劳、无时间、主观偏见、认知局限等）。这些因素共同作用导致审查过程中可能出现的时间效率低、一致性差、错误遗漏和主观性问题。

🗣用五个词语总结： 易疲劳 ****主观偏见 ****规范少 ****沟通难 ****知识缺

三. 采取措施

🤖 利用 AI 大模型进行代码评审，可以显著提高效率、减少人为错误，通过自动化分析和建议，弥补人为评审的局限性。同时还能促进代码一致性和质量，但需要适当的人机协作模式以充分发挥其潜力。

底层依赖： 京东言犀大模型、行云流水线（云原生）、单元测试脚本、coding 代码评审机制（webhook）

【简易版📌】AI 代码评审接入手册 👉 见评论 已成型机制，京东内部一键式接入！

群号见评论区哦！

四. 实践步骤

4.1 接入京东言犀大模型（行业内类 ChatGPT 大模型均可）

言犀大模型文档 （JD 内部免费-代码安全）

申请接入 GPT（ 评论区加群 or 私信我 审批连接）：填写申请原因和基础信息。 🖐（行业内类 ChatGPT 大模型均可~）

审批完成会收到 API key （chatrhino-14B 暂时输入内容的最大长度为 45000 字符，通常代码修改可以满足）

4.2 内置 AI Review 脚本（Git 代码库 API 打通）

1、调用 coding API（获取 MR 的 commit 起止点） 2、调用 coding API（获取本次代码 diff） 3、调用 GPT- API（京东大模型）

脚本链接汇总（评论区加群 or 私信我 获取）：目前支持的模型有 Chatrhino-14B（最新版本-选择此模型） 、Chatrhino、Chatrhino-JingYan 其它模型持续集成中。

AiCodeReview.java 脚本案例（java 语言-junit5 版本）粘贴到自己代码库中即可

📢注意：不必须依赖 junit5，可以自行切换 junit4，demo 只是提供框架思路，落地后可根据代码库场景优化脚本！

替换 2 个变量：

① API Token

•建议申请协同虚拟账号（优势：很稳定，不会随个人账号离职等变化）：部门公共 AI 架构师评审，设置 API Token

【流程中心-协同办公-协同（虚拟）账号管理】👉 别忘了 coding 给他加个权限！

② PROJECT_ID：替换为您的 Git 应用 id（如下查看）

③ 大模型 api-key：替换为您的 key（查看 4.1 部分）

•核心脚本逻辑步骤如下示例：

void aiCodeReviewByChatrhino() {    //1、get mr    String mergeRequest = System.getProperty("mergeRequest");    if (mergeRequest == null) return;        System.out.println("【流水线触发MergeRequest】------------------------------------------------ " + mergeRequest);
    //2、get coding diff    String codeDiff = getCodingDiff(mergeRequest);    System.out.println("【coding的diff内容】------------------------------------------------" + codeDiff);
    //3、gpt code review    String result = gptReview(codeDiff);    System.out.println("【京东言犀大模型评论】------------------------------------------------" + result);
    //4、output review content    note(objectMapper.readTree(result).get("choices").get(0).get("message").get("content").asText(), mergeRequest);    System.out.println("【coding评审note记录】------------------------------------------------" + noteContent + "-----------------------------------------------");}

复制代码

✋脚本内设定 AI 人设（content 字段）：根据自己需求定义 prompt

比如你想用于分析本次改动业务语义、或者专注于找 bug、亦或者代码写法是否规范等

4.3 搭建 CI 流水线（持续集成）

① 新建流水线：导入 AI 流水线脚本模版 yaml 创建 AI Code Review 机制

流水线原子：【下载代码】+【java 编译】+【咚咚通知】

② 原子参数配置修改：【下载代码原子】+【maven 编译原子】改为自己代码库和脚本路径

•【咚咚通知原子】默认配置即可，📢 提交代码研发

✍️ 同部门下建议独立脚本代码库，projectID 动态传入，不同应用可实现《一键式接入》（只需导入流水线即可实现 AI 评审）-DprojectId=${globalParams.user.WEBHOOK_ATTR_PROJECT_ID}

分支：${globalParams.user.BRANCH} 相对目录（脚本放置位置）：${globalParams.system.APP_IDENTIFIER}

mvn test -Dtest=com.jdwl.wms.common.AiCodeReview -DmergeRequest=${globalParams.user.WEBHOOK_ATTR_MERGE_REQUEST_ID} -DfailIfNoTests=false -Dmaven.test.failure.ignore=true

复制代码

③【触发设置】绑定自己代码库，MR Create/Updated 事件（原因：coding 的 push 操作统一触发 mr create/update 操作）