Identiconphp技巧_AIGC基于大年夜模型常识库的Code Review实践

文章目录 [+]

一、背景描述

二、技能事理

Identiconphp技巧_AIGC基于大年夜模型常识库的Code Review实践

三、基于大模型与知识库的Code Review实践

（图片来自网络侵删）

1、选择得当的大模型与知识库

2、集成大模型与知识库到Code Review流程

3、结合人工审查

4、持续优化与改进

四、技能细节

1、gitlab配置mr的webhook

得到差异代码

2、要求通义千问得到review结果

条件条件

3、Gitlab调用代码review评论API

1. 获取私有令牌（Private Token）

2. 调用 API

3. 创建评论

4. 把稳事变

参考资料

一、背景描述

一句话先容便是：基于开源大模型 + 知识库的 Code Review 实践，类似一个代码评审助手（CR Copilot）。
信息安全合规问题：公司内代码直接调 ChatGPT / Claude 会有安全/合规问题，为了利用 ChatGPT / Claude 须要对代码脱敏，只供应抽象逻辑，这每每更花韶光。
低质量代码耗费韶光：业务每天至少 10~20 个 MR 须要 CR，虽然提交时 MR 经由单测 + Lint 过滤了一些低级缺点，但还有些问题（代码合理性、履历、MR 干系业务逻辑等）须要花费大量韶光，末了可以先经由自动化 CR，再进行人工 CR，可大大提升 CR 效率！
符合公司安全规范，所有代码数据不出内网，所有推理过程均在内网完成团队 Code Review 规范短缺实行：大部分团队的 Code Review 勾留在文档纸面上，成员之间口口相传，并没有一个工具根据规范来严格实行。
开箱即用：基于 Gitlab CI，仅 10 几行配置完成接入，即可对 MR 进行 CR。
数据安全：基于开源大模型做私有化支配，隔离外网访问，确保代码 CR 过程仅在内网环境下完成。
♾ 无调用次数限定：支配在内部平台，只有 GPU 租用本钱。
自定义知识库：CR 助手基于供应的飞书文档进行学习，将匹配部分作为高下文，结合代码变更进行 CR，这将大大提升 CR 的准确度，也更符合团队自身的 CR 规范。
评论到变更行：CR 助手将结果评论到变更代码行上，通过 Gitlab CI 关照，更及时获取 CR 助手给出的评论。

编辑

二、技能事理

编辑

三、基于大模型与知识库的Code Review实践

基于大模型与知识库的Code Review实践，详细履行细节可以归纳如下：

1、选择得当的大模型与知识库

大模型选择：优先选择具有广泛演习数据和强大措辞理解能力的模型，如GPT系列（如GPT-3.5或更高版本）。
考虑模型的领域适应性，选择对编程措辞和代码构造有深入理解的模型。
评估模型的性能，包括处理速率、准确性和可扩展性。
知识库构建：网络行业标准和最佳实践，确保知识库内容的威信性和准确性。
整合常见的代码问题和解决方案，构建易于查询和检索的知识库。
不断更新和掩护知识库，确保其内容的时效性和完全性。

2、集成大模型与知识库到Code Review流程

自动化工具开拓：利用大模型开拓自动化代码剖析工具，如静态代码剖析器、代码风格检讨器等。
这些工具可以自动检测代码中的潜在问题，如语法缺点、逻辑缺点、性能问题等。
工具的输出结果可以作为Code Review的参考依据。
代码注释和文档天生：利用大模型的文本天生能力，为代码片段自动天生注释和文档。
这可以提高代码的可读性和可掩护性，便于其他团队成员理解和利用代码。
集成知识库：在Code Review过程中，集成知识库作为参考资源。
审查者可以通过查询知识库来快速获取干系的行业标准和最佳实践等信息。
审查者可以利用这些信息来更准确地评估代码的质量和可靠性。

3、结合人工审查

审查者角色：审查者须要具备一定的编程能力、自然措辞处理能力和领域知识。
审查者须要关注模型的输出结果，判断其是否准确可靠，并根据实际情形做出调度。
审查者还须要关注代码的逻辑、业务逻辑等方面的问题，确保代码的精确性和可靠性。
审查流程：审查者首先利用自动化工具对代码进行初步剖析。
然后，审查者可以结合知识库中的信息对代码进行深入审查。
审查者须要记录审查过程中的问题和建议，并与开拓职员进行沟通和谈论。

4、持续优化与改进

数据网络与反馈：网络Code Review过程中的数据和反馈，包括审查结果、审查者建议等。
剖析这些数据，理解Code Review的效果和存在的问题。
模型优化：根据网络的数据和反馈，对大模型进行优化和改进。
例如，可以更新模型的演习数据、调度模型的参数设置等，以提高模型的性能和准确性。
知识库更新：定期更新和掩护知识库，确保其内容的时效性和完全性。
整合新的行业标准和最佳实践到知识库中，为审查者供应更全面的参考资源。

通过以上详细履行细节，可以确保基于大模型与知识库的Code Review实践能够高效、准确地评估代码的质量和可靠性，提高开拓效率。

四、技能细节

1、gitlab配置mr的webhook

在 GitLab 中，当你想要配置 Merge Request (MR) 的 webhook（也称为“Web 钩子”或“HTTP 钩子”）时，你实际上是在设置当某个事宜（如新的 MR 被创建、MR 被更新、MR 被合并等）发生时，GitLab 会向指定的 URL 发送 HTTP 要求。

以下是如何在 GitLab 中配置 Merge Request 干系的 webhook 的步骤：

登录 GitLab 并导航到你想要配置 webhook 的项目。
在项目的侧边栏中，选择 Settings（设置）。
在左侧菜单中，选择 Integrations（集成）或 Webhooks（详细取决于 GitLab 的版本和配置）。
在 Webhooks 页面上，你会看到一个用于添加新 webhook 的表单。
URL：输入你想要吸收 webhook 要求的 URL。
这常日是一个 API 端点或 webhook 处理器的地址。
Secret Token（可选）：这是一个可选的令牌，用于在发送 webhook 要求时验证要求的源。
如果你在此处设置了令牌，则你的 webhook 处理器也必须包含该令牌以验证要求。
Trigger（触发器）：不才拉列表中选择你想要触发 webhook 的事宜。
对付 Merge Request，你可能会选择 Merge Request events 或其他干系选项。
确保选中了与 Merge Request 干系的事宜，如 Opened（打开）、Updated（更新）、Merged（合并）等。
Add Webhook（添加 webhook）：完成上述设置后，点击此按钮以保存 webhook 配置。

编辑

默认本地访问会报错，须要按照如下办法开启本地访问权限

编辑

现在，当指定的 Merge Request 事宜发生时，GitLab 会向你的 webhook URL 发送一个 HTTP 要求。
这个要求将包含与事宜干系的数据，你可以在你的 webhook 处理器中解析这些数据并实行相应的操作。

gitlab的webhook事理

编辑

项目代码变动往gitlab上推送相应的事宜，例如代码push，新建tag，创建merge request等等；gitlab收到相应事宜，触发对应的webhook，设置HTTP要求的header以及request body，然后发送HTTP要求到配置的webhook的URL；HTTP要求到达对应的处理做事器往后，对request body和header进行解析，包装关照内容；

把稳：确保你的 webhook 处理器能够处理来自 GitLab 的要求，并且你的 GitLab 实例和 webhook 处理器之间的网络连接是安全的。
如果你在生产环境中利用 webhook，请考虑利用 HTTPS 和身份验证来确保要求的安全性。

创建MR要求

得到回调结果

编辑

{"object_kind": "merge_request","event_type": "merge_request","user": {"id": 1,"name": "Administrator","username": "root","avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon","email": "[REDACTED]"},"project": {"id": 2,"name": "ruoyi","description": "ruoyi","web_url": "http://localhost:8200/root/ruoyi","avatar_url": null,"git_ssh_url": "ssh://git@localhost:8200/root/ruoyi.git","git_http_url": "http://localhost:8200/root/ruoyi.git","namespace": "Administrator","visibility_level": 20,"path_with_namespace": "root/ruoyi","default_branch": "main","ci_config_path": null,"homepage": "http://localhost:8200/root/ruoyi","url": "ssh://git@localhost:8200/root/ruoyi.git","ssh_url": "ssh://git@localhost:8200/root/ruoyi.git","http_url": "http://localhost:8200/root/ruoyi.git"},"object_attributes": {"assignee_id": 1,"author_id": 1,"created_at": "2024-06-10 01:26:41 UTC","description": "Uat","head_pipeline_id": null,"id": 2,"iid": 2,"last_edited_at": null,"last_edited_by_id": null,"merge_commit_sha": null,"merge_error": null,"merge_params": {"force_remove_source_branch": "1"},"merge_status": "preparing","merge_user_id": null,"merge_when_pipeline_succeeds": false,"milestone_id": null,"source_branch": "uat","source_project_id": 2,"state_id": 1,"target_branch": "main","target_project_id": 2,"time_estimate": 0,"title": "Uat","updated_at": "2024-06-10 01:26:41 UTC","updated_by_id": null,"url": "http://localhost:8200/root/ruoyi/-/merge_requests/2","source": {"id": 2,"name": "ruoyi","description": "ruoyi","web_url": "http://localhost:8200/root/ruoyi","avatar_url": null,"git_ssh_url": "ssh://git@localhost:8200/root/ruoyi.git","git_http_url": "http://localhost:8200/root/ruoyi.git","namespace": "Administrator","visibility_level": 20,"path_with_namespace": "root/ruoyi","default_branch": "main","ci_config_path": null,"homepage": "http://localhost:8200/root/ruoyi","url": "ssh://git@localhost:8200/root/ruoyi.git","ssh_url": "ssh://git@localhost:8200/root/ruoyi.git","http_url": "http://localhost:8200/root/ruoyi.git"},"target": {"id": 2,"name": "ruoyi","description": "ruoyi","web_url": "http://localhost:8200/root/ruoyi","avatar_url": null,"git_ssh_url": "ssh://git@localhost:8200/root/ruoyi.git","git_http_url": "http://localhost:8200/root/ruoyi.git","namespace": "Administrator","visibility_level": 20,"path_with_namespace": "root/ruoyi","default_branch": "main","ci_config_path": null,"homepage": "http://localhost:8200/root/ruoyi","url": "ssh://git@localhost:8200/root/ruoyi.git","ssh_url": "ssh://git@localhost:8200/root/ruoyi.git","http_url": "http://localhost:8200/root/ruoyi.git"},"last_commit": {"id": "a39deeac9763e89f81993bf85cc5f13efb9c3bad","message": "error\n","title": "error","timestamp": "2024-06-10T08:16:19+08:00","url": "http://localhost:8200/root/ruoyi/-/commit/a39deeac9763e89f81993bf85cc5f13efb9c3bad","author": {"name": "luomao1","email": "luomao1@lenovo.com"}},"work_in_progress": false,"total_time_spent": 0,"time_change": 0,"human_total_time_spent": null,"human_time_change": null,"human_time_estimate": null,"assignee_ids": [1],"state": "opened","blocking_discussions_resolved": true,"action": "open"},"labels": [],"changes": {"merge_status": {"previous": "unchecked","current": "preparing"}},"repository": {"name": "ruoyi","url": "ssh://git@localhost:8200/root/ruoyi.git","description": "ruoyi","homepage": "http://localhost:8200/root/ruoyi"},"assignees": [{"id": 1,"name": "Administrator","username": "root","avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon","email": "[REDACTED]"}]}

得到差异代码

合并要求 API |GitLab的

编辑

{"assignee": {"avatarUrl": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","external": false,"id": 1,"name": "Administrator","state": "active","username": "root"},"author": {"avatarUrl": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","external": false,"id": 1,"name": "Administrator","state": "active","username": "root"},"baseSha": "cafe2e5ea1d0892b8e770d84862686fb5dd9ad11","changes": [{"aMode": "100644","bMode": "100644","deletedFile": false,"diff": "@@ -33,6 +33,8 @@ public class UserController {\n @GetMapping(\"userinfo\")\n public ModelAndView userinfo() {\n SysUserVo sysUserVo = sysUserService.findByLoginName(SecurityUtil.getLoginUser().getUsername()).getData();\n+ // 密码设置缺点\n+ String password = sysUserVo.getPassword();\n sysUserVo.setPassword(null);\n return new ModelAndView(\"user/userinfo\", \"user\", sysUserVo);\n }\n","newFile": false,"newPath": "src/main/java/cn/huanzi/qch/baseadmin/user/controller/UserController.java","oldPath": "src/main/java/cn/huanzi/qch/baseadmin/user/controller/UserController.java","renamedFile": false}],"changesCount": "1","closed": false,"createdAt": 1717982801579,"description": "Uat","downvotes": 0,"forceRemoveSourceBranch": true,"headSha": "a39deeac9763e89f81993bf85cc5f13efb9c3bad","id": 2,"iid": 2,"labels": [],"latestBuildStartedAt": 1718002898301,"mergeStatus": "can_be_merged","mergeWhenPipelineSucceeds": false,"merged": false,"projectId": 2,"sha": "a39deeac9763e89f81993bf85cc5f13efb9c3bad","sourceBranch": "uat","sourceProjectId": 2,"squash": true,"startSha": "cafe2e5ea1d0892b8e770d84862686fb5dd9ad11","state": "opened","targetBranch": "main","targetProjectId": 2,"title": "Uat","updatedAt": 1718006208667,"upvotes": 0,"userNotesCount": 3,"webUrl": "http://localhost:8200/root/ruoyi/-/merge_requests/2","workInProgress": false}

2、要求通义千问得到review结果

如何快速入门通义千问API_模型做事灵积(DashScope)-阿里云帮助中央

java调用通义千问API的详细完全步骤_java_脚本之家

条件条件

DashScope SDK供应了Python和Java两个版本，请确保您已安装最新版SDK：安装DashScope SDK。
您也可以通过HTTP接口调用，详情请见：HTTP调用接口。

已开通做事并得到API-KEY：开通DashScope并创建API-KEY。
编辑我们推举您将API-KEY配置到环境变量中以降落API-KEY的泄露风险，详情可参考通过环境变量配置API-KEY。
您也可以在代码中配置API-KEY，但是泄露风险会提高。
# 用您的 DashScope API-KEY 代替 YOUR_DASHSCOPE_API_KEY ## 如果您的Shell类型是Zsh，运行以下命令 echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc同时DashScope供应了与OpenAI兼容的接口访问做事，详情参考OpenAI接口兼容。

{"requestId": "468f22eb-673d-91ed-8b2c-51db041ef92d","usage": {"input_tokens": 25,"output_tokens": 68,"total_tokens": 93},"output": {"choices": [{"finish_reason": "stop","message": {"role": "assistant","content": "通义千问是阿里云自主研发的超大规模措辞模型，能够回答问题、创作笔墨，还能表达不雅观点、撰写代码。作为一个大型预演习措辞模型，我能够根据您提出的指令产出干系的回答，并尽可能地供应准确和有用的信息。如果您有任何问题或须要帮助，请随时见告我，我会尽力供应支持。 "}}]}}

3、Gitlab调用代码review评论API

编辑

Commits API | GitLab

编辑

16.commint 提交信息获取库的所有提交信息、创建多个文件的提交、单个文件提交、获取提交被推送到的branch、对给定分支的提交、还原至本次提交、提交与git文件的比拟、查询提交评论信息、揭橥评论并提交、获取揭橥的评论、获取提交状态、查询提交合并信息、获取GPG署名

GitLab 供应了丰富的 API 来与 GitLab 实例进行交互，包括获取和创建 Merge Request（MR）的评论。
以下是如何利用 GitLab API 来调用代码审查（Code Review）评论的干系步骤和示例。

1. 获取私有令牌（Private Token）

首先，你须要从 GitLab 用户设置中获取一个私有令牌（Private Token），这将用于 API 认证。

登录到 GitLab。
点击右上角的用户头像，选择“Settings”（设置）。
在左侧菜单中选择“Access Tokens”（访问令牌）。
输入一个名称，选择你须要的权限范围（对付代码审查，常日须要“api”权限），然后点击“Create personal access token”（创建个人访问令牌）。
复制天生的令牌并妥善保存，由于离开页面后你将无法再次查看它。

2. 调用 API

你可以利用任何支持 HTTP 要求的编程措辞或工具来调用 GitLab API。
以下是一个利用 curl 命令的示例，展示如何获取一个 Merge Request 的所有评论：

curl --header "Private-Token: YOUR_PRIVATE_TOKEN" "https://gitlab.example.com/api/v4/projects/PROJECT_ID/merge_requests/MERGE_REQUEST_IID/notes"

YOUR_PRIVATE_TOKEN：更换为你的私有令牌。
gitlab.example.com：更换为你的 GitLab 实例的 URL。
PROJECT_ID：更换为你要获取评论的项目的 ID。
MERGE_REQUEST_IID：更换为你要获取评论的 Merge Request 的内部 ID（不是全局 ID）。

3. 创建评论

Notes API 接口 |GitLab的

编辑

你也可以利用 API 来创建一个新的评论。
以下是一个示例：

curl --request POST --header "Private-Token: YOUR_PRIVATE_TOKEN" --header "Content-Type: application/json" --data '{"body":"这是一个新的评论"}' "https://gitlab.example.com/api/v4/projects/PROJECT_ID/merge_requests/MERGE_REQUEST_IID/notes"

body：是你要创建的评论的内容。

{"id": 2,"type": null,"body": "这是一个新的评论","attachment": null,"author": {"id": 5,"username": "project_2_bot1","name": "","state": "active","avatar_url": "https://www.gravatar.com/avatar/0aaf8dea0d60673d2f8ee409dc2ec2af?s=80\u0026d=identicon","web_url": "http://localhost:8200/project_2_bot1"},"created_at": "2024-06-10T07:15:02.909Z","updated_at": "2024-06-10T07:15:02.909Z","system": false,"noteable_id": 2,"noteable_type": "MergeRequest","resolvable": false,"confidential": false,"noteable_iid": 2,"commands_changes": {}}

编辑

4. 把稳事变

确保你的 GitLab 实例的 URL、项目 ID 和 Merge Request ID 都是精确的。
GitLab API 遵照 RESTful 设计原则，因此你可以利用 GET、POST、PUT、DELETE 等 HTTP 方法来实行不同的操作。
始终在发送要求时包含你的私有令牌进行认证。
GitLab API 文档是一个很好的资源，你可以在个中找到关于所有可用端点和参数的详细信息。
你可以通过访问 https://gitlab.example.com/help/api/README.md（将 gitlab.example.com 更换为你的 GitLab 实例的 URL）来访问它。

参考资料

基于大模型 + 知识库的 Code Review 实践_大模型进行codereview结果比拟-CSDN博客

AIGC 重塑软件工程 Code Review 篇：IDE 插件 + DevOps 平台协同组合-CSDN博客

CI+GPT双引擎驱动，开启AI代码评审新纪元 - 知乎 (zhihu.com)

GitHub - mimo-x/Code-Review-GPT-Gitlab: GPT Code Review for Gitlab （针对付 Gitlab 的 LLM 赞助 Code Review 工具）项目详细文档

CodeReview with LLM in Gitlab

基于大模型的 Code Review 实践 - 掘金 (juejin.cn)

玩转 ChatGPT+极狐GitLab｜自动化的MR 变更评审来了 - 知乎 (zhihu.com)

GitLab的Webhook配置和开拓_gitlab webhook-CSDN博客

GitLab的Webhook功能及自动触发流程-git-PHP中文网

Review Apps · Gitlab 中文文档 · 看云

gitLabApi文档信息总结-CSDN博客