使用 GitLab 进行线上代码评审
一、什么是代码评审
代码评审是一种提高代码质量的有效方法，通过团队协作，发现潜在问题、优化代码逻辑、提升代码可维护性。
二、代码评审的基本流程
- 开发者提交代码：通过 Git 提交代码到指定分支，通常是一个 Feature 分支。
- 创建 Merge Request (MR) ：在 GitLab 上创建一个合并请求 (Merge Request)。
- 评审人审核代码：团队成员通过评论功能进行代码评审，提出改进建议。
- 开发者修改代码：根据评审意见更新代码并提交。
- 批准并合并代码：评审通过后，将代码合并到目标分支（如
main或master）。
三、GitLab 代码评审详细操作指南
1. 提交代码
-
在本地开发完成后，使用 Git 提交代码。
git add . git commit -m "feat: 添加用户登录功能" git push origin feature/login -
登录 GitLab，切换到对应的项目仓库，确认代码已成功推送到远程分支。
2. 创建 Merge Request (MR)
- 在 GitLab 项目页面中，点击左侧菜单的 Merge Requests。
- 点击右上角的 New Merge Request 按钮。
- 选择源分支（如
feature/login）和目标分支（如develop）。 - 填写 MR(merge request) 标题和描述，说明变更内容和目的。
- 指定评审人，点击 Create Merge Request。
3. 评审代码
-
查看代码变更：进入 MR 页面，点击 Changes 标签页查看代码差异。
-
添加评论：
- 选择代码行，点击行号左侧的 + 号。
- 在弹出的评论框中输入建议或问题。
- 点击 Start a review 进行批量提交，或直接 Add comment。
-
完成评审：
- 如果发现问题，可以点击 Request Changes。
- 如果没有问题，可以点击 Approve。
4. 开发者修改代码
-
根据评审意见在本地修改代码，并重新提交到远程分支。
git add . git commit -m "fix: 修复登录界面显示问题" git push origin feature/login -
GitLab 中的 MR 页面会自动更新代码变更。
5. 批准并合并代码
- 确认所有评审意见已解决后，点击 Merge 按钮。
- 选择合并策略（如
Squash and merge或Merge commit）。 - 点击 Confirm merge 完成合并。
四、代码评审的注意事项
- 明确评审目标：关注代码的功能实现、逻辑清晰度和潜在问题。
- 提供建设性意见：提出具体建议，避免模棱两可的评论。
- 记录评审过程：确保所有意见和讨论记录在 MR 页面。
- 遵守团队规范：包括代码风格、提交信息规范等。
五、常见问题与解决方法
问题 1：如何处理冲突？
在本地拉取目标分支的最新代码并解决冲突后重新提交。
git pull origin develop
git merge feature/login
# 解决冲突后
git add .
git commit -m "fix: 解决冲突"
git push origin feature/login
问题 2：如何撤销错误的 Merge Request？
- 在 MR 页面，点击右上角的 Close merge request。
- 如果已合并，需通过
git revert恢复代码。
