为什么介绍这个工具
- 你是否发起代码评审/代码走查、如何进行代码评审/代码走查、代码评审/代码走查覆盖率
- 一劳永逸解决问题、流程化/规范化规避问题、想办法提高工作效率
- 利用代码检查工具,提升代码质量
下面的图就就是学习这个工具的最形象的目的
代码质量下降有哪些影响
- 书写风格不统一, 阅读体验差
- 维护性差, 复用性差
- 容易出现低质量代码, 代码返工率高
如图所示,业务压力导致增加人力,参与人数变多,烂代码就会变多,致使整体开发效率下降,可以通过代码质量管控和技术升级去提高我们的效率。
Sonarqube它是什么
SonarQube 是一种 自动代码审查工具,用于检测代码中的错误、漏洞和代码异味。它可以与您现有的工作流程集成,以实现跨项目分支和拉取请求的持续代码检查。
文档链接 docs.sonarqube.org/latest/
下载地址:www.sonarqube.org/downloads/
SonarQube 可以测量的关键指标,包括代码错误、 代码异味(code smells)、安全漏洞和重复的代码。
-
代码错误 是代码中的一部分不正确或无法正常运行、可能会导致错误的结果,是指那些在代码发布到生产环境之前应该被修复的明显的错误。
-
代码异味 不同于代码错误,被检测到的代码是可能能正确执行并符合预期。然而,它不容易被修复,也不能被单元测试覆盖,却可能会导致一些未知的错误,或是一些其它的问题。从长期的可维护性来讲,立即修复代码异味是明智之举。通常在编写代码的时候,代码异味并不容易被发现,而 SonarQube 的静态分析是一种发现它们的很好的方式。
-
安全漏洞 正如听起来的一样:指的是现在的代码中可能存在的安全问题的缺陷。这些缺陷应该立即修复来防止黑客利用它们。
-
重复的代码 也和听起来的一样:指的是源代码中重复的部分。代码重复在软件设计中是一种很不好的做法。总的来说,如果对一部分代码进行更改而另一部分没有,则会导致一些维护性的问题。例如,识别重复的代码可以很容易的将重复的代码打包成一个库来重复的使用。
如何使用
安装和使用可以参照下面的链接来试试
参考文章:
JDK11: www.oracle.com/java/techno…
SonarQube7.8 : www.sonarqube.org/downloads/