Java 代码规约扫描

《阿里巴巴 Java 开发手册》是阿里内部 Java 工程师所遵循的开发规范,涵盖编程规约、单元测试规约、异常日志规约、MySQL 规约、工程规约、安全规约等,这是近万名阿里 Java 技术精英的经验总结,并经历了多次大规模一线实战检验及完善。根据约束力强弱,规约依次分为强制、推荐、参考三大类:

【强制】必须遵守。是不得不遵守的约定,违反本约定或将引起严重的后果。

【推荐】尽量遵守。长期遵守这样的规则,有助于系统稳定性和合作效率的提示。

【参考】充分理解。技术意识的引导,是个人学习、团队沟通、项目合作的方向。

Java 代码规约扫描使用《阿里巴巴 Java 开发规约》插件扫描 Java 规约问题。

开启或关闭扫描

管理员角色有权限开启或关闭扫描。

开启扫描

  1. 在 「设置」- 「集成与服务」中开启

  2. 弹出的 「用户承诺书」窗口中,阅读,并勾选 「我已阅读相关协议并确认开通服务」,然后点击「确认」

  3. 选择触发扫描的时机

  • 代码提交触发扫描:代码提交即 git push 后触发扫描

  • 合并请求触发扫描:合并请求事件触发扫描,即创建合并请求、合并请求更新触发扫描

关闭扫描

在 「设置」- 「集成与服务」中关闭

在 「提交」中查看扫描结果

当开启了代码提交触发扫描,可以在 「提交」中查看扫描结果

  1. 在 「提交」列表查看整体结果

  2. 鼠标点击查看 Java 代码规约扫描结果

  3. 点击 「详情」查看扫描详情

在 「合并请求」中查看扫描结果

当开启了合并请求触发扫描,可以在 「合并请求」中查看扫描结果

在合并请求详情中查看扫描结果

点击 「详情」查看扫描详情,点击具体的扫描问题查看扫描详情

点击 「扫描汇总」查看所有扫描结果