代码总是被嫌弃写的太烂?装上这个插件再试试!
共 2300字,需浏览 5分钟
·
2021-12-25 00:01
点击上方 蓝字 关注我们!
2021 最新 Java 编程资料免费领!Java 视频教程,Java Web 项目教程,互联网Java 面试真题 / 算法题,简历模板,Linux 服务器等等,点击领取!
来源:cnblogs.com/cjsblog/p/10735800.html
新来的同事,经常写一些 “烂代码” 偷袭我,这次给领导建议,搞一个代码检查工具,一键扫描,统一风格化编码,看以后还敢乱写代码。
SonarLint(Sonar) 代码质量管理
Sonar是一个用于代码质量管理的开源平台,用于管理源代码的质量 通过插件形式,可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测
Sonar可以从以下七个维度检测代码质量,而作为开发人员至少需要处理前5种代码质量问题
1、不遵循代码标准 sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写
2、潜在的缺陷 sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检测出潜在的缺陷
3、糟糕的复杂度分布 文件、类、方法等,如果复杂度过高将难以改变,这会使得开发人员难以理解它们 且如果没有自动化的单元测试,对于程序中的任何组件的改变都将可能导致需要全面的回归测试
4、重复 显然程序中包含大量复制粘贴的代码是质量低下的,sonar可以展示源码中重复严重的地方
5、注释不足或者过多 没有注释将使代码可读性变差,特别是当不可避免地出现人员变动时,程序的可读性将大幅下降 而过多的注释又会使得开发人员将精力过多地花费在阅读注释上,亦违背初衷
6、缺乏单元测试 sonar可以很方便地统计并展示单元测试覆盖率
7、糟糕的设计 通过sonar可以找出循环,展示包与包、类与类之间相互依赖关系,可以检测自定义的架构规则 通过sonar可以管理第三方的jar包,可以利用LCOM4检测单个任务规则的应用情况, 检测耦合。
1. SonarLint
SonarLint是一个代码质量检测插件,可以帮助我们检测出代码中的坏味道
![](https://filescdn.proginn.com/35c7a4fd8d243fc82527ff071f3f92ba/a9ec59f24cabf440746e76c3c43888ee.webp)
下载与安装
![](https://filescdn.proginn.com/dbd1a07a174553e9290cebd476ea2e8d/3a40b651bcb431268cf76849405e95a7.webp)
在需要检测的单个文件或者单个项目上右键 --> Analyze --> Analyze with SonarLint
或者选中文件或目录,点击菜单栏 Analyze --> Analyze with SonarLint
![](https://filescdn.proginn.com/e5635da374109afe0c18a699006c36d0/fac1ff2e727849d142e6919885a7ccb4.webp)
我们还可以禁用某些规则
![](https://filescdn.proginn.com/4b8e3a62ec9b1859ed2cba9a19df8bec/3abc4a2f822c2996e3e4baf1576b77f2.webp)
如果需要同步自定义的规则时,可以绑定到SonarQube
![](https://filescdn.proginn.com/afb6a81cbe6de286065a516319a01293/ecf93068a6ef526d16b92caa82a7d330.webp)
![](https://filescdn.proginn.com/c571dfa1f39003117efae2bcb9da11b2/52bf349a0bf3c8c5dc1e8b4452e05bc9.webp)
![](https://filescdn.proginn.com/144dd7985b76adeba587d2b98ac85703/b83a799d3a3f3319f5c9544a1f07fad5.webp)
查看检测的结果
![](https://filescdn.proginn.com/2bbe122ae674ce0b886d157daa4f83a6/f90ea4fa0b8e622b32da285f0146510f.webp)
对于代码中的警告我们不能视而不见
![](https://filescdn.proginn.com/80f3f98b4464f984010b959cbd8e54f1/5f7c44d7e9f783cab7fb6f5f8558408f.webp)
有了代码质量检测工具以后,在一定程度上可以保证代码的质量
对于每一个问题,SonarLint都给出了示例,还有相应的解决方案,教我们怎么修改,极大的方便了我们的开发
比如,对于日期类型尽量用LocalDate、LocalTime、LocalDateTime,还有重复代码、潜在的空指针异常、循环嵌套等等问题
有了代码规范与质量检测工具以后,很多东西就可以量化 了,比如bug率、代码重复率等,还可以自定义各种指标,方便管理人员查看
为此,我们需要一个平台来记录每次检测分析的结果,这样就可以进行分析和统计,并且可以直观的看到这一切
于是,SonarQube 闪亮登场!
2. SonarQube
SonarQube是一个开源的代码质量管理平台
![](https://filescdn.proginn.com/05b7962489b81e0a5c46d5f8413828ea/ed4d2d25bdb94911a3838890624a2bee.webp)
![](https://filescdn.proginn.com/f5155514f8999ff01a16c5904e7e5b30/9b8844131c9d653af080bb5ad0ac9867.webp)
![](https://filescdn.proginn.com/ed34b22eec6acfdf7c2044cccd186437/aab7675ab2ed5df5806e48430c4c30b7.webp)
![](https://filescdn.proginn.com/ca0e323121d94b616fef85958469113b/8870ebbd97eb882a32656535f93d4112.webp)
解压&本地启动
https://docs.sonarqube.org/latest/setup/get-started-2-minutes/
unzip sonarqube-7.7.zip
cd sonarqube-7.7
bin/[OS]/sonar.sh consol
![](https://filescdn.proginn.com/3bbcef8fa5d633bb22158a083fca35a5/854fe2bf5846e877420eb395ab9c6d92.webp)
启动成功后,访问 http://localhost:9000 用管理员账号(admin/admin)登录
![](https://filescdn.proginn.com/e6946f7dc89b0e99a9fe06b5b9f7946b/423eb18b1c340c65a4471dc5c4a2c5d1.webp)
接下来,为了把检测的结果传到服务器,我们需要配置一个Scanner
https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Maven
这里我在项目中添加 sonar-maven-plugin 插件
<build>
<plugins>
<plugin>
<groupId>org.sonarsource.scanner.mavengroupId>
<artifactId>sonar-maven-pluginartifactId>
<version>3.6.0.1398version>
plugin>
plugins>
build>
命令行执行:mvn clean compile sonar:sonar
成功后,可以在控制台中看到这样的输出
![](https://filescdn.proginn.com/072e7c24838bf29aa9c1af5c78aefd95/04930cd7e77c57698c5f11644d4102c5.webp)
再次刷新 http://localhost:9000/ 会看到跟刚才不一样了
![](https://filescdn.proginn.com/9a3a825df06482507b5ddf7f24c1f5d3/1ee2075acb9ed5e213b32371bcef1b2d.webp)
![](https://filescdn.proginn.com/ec3f3ede5889a7287bffddfc4933d8df/f54609046f94bc5cc5aa9af61eb3c832.webp)
![](https://filescdn.proginn.com/4732ea9da26e16e8a21fa0f417bdf651/59a22ae0accc2762d521fab79def2f34.webp)
以上只是本地演示,在正式环境中这些数据当然要保存到数据库中,具体安装就不演示了,下面是文档
https://docs.sonarqube.org/latest/setup/install-server/
3. Alibaba代码规约插件
阿里代码规范,相信大家都不陌生
![](https://filescdn.proginn.com/01190d24d22cfed38011445861469ff8/8ae0d725c12e61669925ae420e4bd367.webp)
![](https://filescdn.proginn.com/7cb1ed48f0c8d091a40145f003358dde/c8de36afdc317e7afc60e7b294816395.webp)
![](https://filescdn.proginn.com/81dc3d159a250cae128c223d0175e6cb/74c1f0687a8d3f9efb931d6ec632d235.webp)
往期推荐