代码质量标准及其相关检测工具

编码规范：是否遵守了团队编码规范，降低维护代码的成本。

可读性：每个方法都必须有注释，改动的时候最好说明因为什么问题改动，改动的关键代码加上注释，加上改动者和相关Jira ID ，避免很多时候时间久了自己都看不懂自己的代码 ; 另外，检测可读性的另一个办法就是让别人review你的代码，如果别人能看明白，那也说明你的代码可读性还可以。

重复度：应该尽可能避免重复代码，重复代码应该尽可能抽取到公共模块

测试覆盖率：尽可能写Junit单元测试或BDD自动化测试，这个可以避免后续改动对已有功能的影响，测试覆盖率最好达到80%以上。

漏洞检测：避免有漏洞，有风险的代码。

 

上面说了一些代码质量评价标准，接下来看看怎么去实施这些标准，或者看看可以借助哪些工具。

SonarLint，是一个IDE插件，点击直接安装

 

可以先查看一下检测规则，右击你的代码目录，便可以检测你的代码了

 

 

 

 SonarQube(https://www.sonarqube.org)，是一个开源的代码质量管理平台。有了代码规范与质量检测工具以后，很多东西就可以量化了，比如bug率、代码重复率等，还可以自定义各种指标，方便管理人员查看。为此，我们需要一个平台来记录每次检测分析的结果，这样就可以进行分析和统计，并且可以直观的看到这一切，于是就有了SonarQube。我下载的版本要求用JDK11. 启动成功后访问http://localhost:9000，默认密码是admin/admin

 

 接下来把SonarLint的分析结果推送到SonarQube平台，需要安装配置Sonar Scanner for Maven

 

 

 

 

 接下来还要配置token，不是谁都可以推送分析数据给SonarQube的

 

 然后在你的项目根目录下执行：mvn sonar:sonar -Dsonar.login=ebdb8c83dd354eab8a5db8853104a1d25d59621c，刷新一下就可以看到分析结果了：

 

 当然，如果不想每次build都带上ebdb8c83dd354eab8a5db8853104a1d25d59621c这个token的话，可以把它配置在maven的setting.xml中：

 

 阿里代码规范插件，安装好了之后在Tools菜单下可以看到阿里的插件，或者右击项目也可以。

 

 

 

 陌陌开源的Momo Code Sec Inspector漏洞检测(类似商业版的checkmarks)，安装完成后右击项目或者某个目录/文件

 

 

 

 

关注公众号“一米源码”并发送消息“QLT”获取相关工具