在分工合作越来越普遍以及细化的现在，写出一手尽可能接近公认的规范的代码尤为重要。笔者在大二的时候接手过一个项目，在之前经手过两个开发人员，两个人的风格和标准都不一样，这就非常麻烦了，给我的工作带来了极大的麻烦。
Alibaba Java开发手册 & 代码规范插件
项目地址：https://github.com/alibaba/p3c
两个途径来提升我们的代码规范性：
- idea阿里巴巴代码规范检查插件
- 阿里巴巴Java开发手册
阿里巴巴代码规范插件：安装与使用
image.png
安装后重启[idea]即生效，生效后在不规范的代码处，会有黄色的警告线提示，并给出修改方案。
也可以全局检查不规范的代码
在项目目录右键，点击“编码规约扫描”，就会显示出不规范的代码。
image.png
可以看到这个class在代码规范中哪里需要修改。
image.png
检测结果分为三个等级：
image.png
扫描结果：
image.png
SonarQube 与 SonarLint插件
项目地址：https://www.sonarqube.org/
SonarQube是一种自动代码审查工具，支持多种语言，可检测代码中的错误，漏洞和代码异味等。并且能够生成代码审查报告，它能够集成单元测试，统计单元测试覆盖率等。它还能很好与现有的DevOps结合，例如，在Java方面支持Maven插件，并且能够与Jenkins集成，实现自动化分析、测试，生成报告等。
三种问题类型
image.png
五个问题等级
image.png
扫描结果：
image.png
image.png
这两个插件的侧重点不同：
- Alibaba代码规范插件比较关心的是代码规范，编码风格上的，例如，命名规范，注释，代码行数等
- SonarLint比较关心代码正确性，存在的问题，风险，漏洞等，例如，重复代码，空指针，安全漏洞等
所以，我建议结合使用，使用前者来规范代码，使用后者来提前发现代码的问题，配合起来提高工程整体的代码质量，并且能够在编码阶段规避风险，提高程序的健壮性。
网友评论