SonarQube中文网站 > 使用技巧 > SonarQube怎么扫描java单元测试 SonarQube java规则

SonarQube怎么扫描java单元测试 SonarQube java规则

发布时间:2025-08-31 08: 00: 00

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

保障代码质量是一个系统工程,需要从多个维度构建完善的质量保障体系。在功能验证方面,可以通过编写单元测试用例来确保代码逻辑的正确性,而在代码质量方面,则需要借助SonarQube等代码质量分析工具来识别潜在的代码缺陷。值得注意的是,单元测试同样可以利用SonarQube来扫描获取。那么,SonarQube怎么扫描java单元测试,SonarQube java规则是怎样呢?

一、SonarQube怎么扫描java单元测试

SonarQube对于单元测试的扫描是通过内置的JaCoCo工具或第三方工具来实现,要让SonarQube有效扫描Java单元测试代码,需要进行扫描前的相关配置。

1、在项目中添加JaCoCo插件。以Maven项目为例,需要在“pom.xml”文件中添加下图所示的JaCoCo配置,在项目中安装“jacoco-maven-plugin”插件。

而对于Gradle项目,则无需额外安装JaCoCo插件,因为插件已默认集成到gradle发行版中。

maven加入JaCoCo插件
图1:maven加入JaCoCo插件

2、配置报告路径。登录SonarQube网页端地址“http://localhost:9000”,进入Administration页面,在Configuration项中,点击JaCoCo,在右侧的“sonar.coverage.jacoco.xmlReportPaths”输入框中填写JaCoCo运行后生成的XML报告路径。

设置XML报告路径
图2:设置XML报告路径

3、执行单元测试扫描。在项目根目录下运行终端命令“mvn -Dsonar.coverage.jacoco.xmlReportPaths=步骤2设置的路径 org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Pcoverage”,完成后单元测试的报告结果就会显示在SonarQube项目中。

执行扫描
图3:执行扫描

二、SonarQube java规则

SonarQube为Java提供了丰富的规则,覆盖了从Java 8到最新LTS版本的语法特性,这些规则不仅支持基础的Java SE规范检查,还针对Spring、Hibernate、Android等流行框架提供了专门的检测规则。

1、默认规则。在Rules界面的Language中筛选Java就可以看到Java的全部规则,在下方Tags中还可以筛选规则标签,按照标签对规则分类显示,如下图只显示JUnit的单元测试规则,若要扫描单元测试并确保其代码正确性,需启用这些规则。

内置规则
图4:内置规则

2、自定义规则。Java规则可以通过Java插件来扩充规则数量,对于规则编写的语法,可以在“https://github.com/SonarSource/sonar-java/blob/master/docs/CUSTOM_RULES_101.md”网页上查看,插件依赖于SonarSource Analyzer for Java API,利用API和暴露的接口来编写自定义的Java规则。

自定义Java规则
图5:自定义Java规则

通过本文对SonarQube怎么扫描java单元测试,SonarQube java规则的介绍,我们了解到:要充分发挥SonarQube在Java单元测试扫描方面的价值,首先就要使用Java单元测试规则扫描单元测试代码,其次还需结合SonarQube的JoCoCo功能来获取单元测试覆盖率报告。这种“测试代码质量审查+测试覆盖率监测”的双重机制,既能验证单元测试的有效性,又能评估测试覆盖范围,最终确保核心业务逻辑和关键代码都能得到充分验证,从而全面提升软件质量。

展开阅读全文

标签:

读者也访问过这里:
SonarQube
从一开始就生成高质量的代码
立即购买
最新文章
SonarQube规则集怎么调整 SonarQube规则禁用后为何仍触发
在SonarQube里,所谓“规则集”对应的其实是Quality Profile,也就是按语言生效的一组启用规则。真正容易出问题的地方,通常不是不会点启用和禁用,而是项目绑错了Profile、子Profile继承了父Profile、改完以后没有重新分析,结果看起来像是“规则明明关了却还在触发”。官方文档也明确说明,问题是在分析时根据项目关联的Quality Profile被产生出来的。
2026-03-25
SonarQube覆盖率为0怎么排查 SonarQube覆盖率报告路径怎么填
SonarQube里覆盖率显示为0,很多时候不是测试根本没跑,而是覆盖率报告没有在扫描前生成、扫描器没找到文件、报告格式和参数名不匹配,或者报告里的路径和当前项目根目录对不上。官方文档写得很明确,SonarQube本身不会生成覆盖率报告,它只负责导入外部工具生成的报告,所以排查顺序一定要先看报告有没有生成,再看扫描器有没有正确读到。
2026-03-25
SonarQube扫描结果为空怎么办 SonarQube扫描日志怎么定位原因
SonarQube扫描结果为空,先不要急着重跑。更常见的原因不是平台坏了,而是扫描范围没有真正命中代码文件,或者代码被排除规则、源码管理忽略规则、主代码与测试代码分类错误一起过滤掉了。Sonar官方文档明确说明,扫描器会先根据分析范围决定要分析哪些文件,而调试日志会直接打印哪些源文件和测试文件被索引,所以排查顺序应先看范围,再看日志。
2026-03-25
SonarQube质量门禁怎么设置 SonarQube质量门禁不生效怎么办
在SonarQube里做质量门禁,最容易出问题的不是条件不会填,而是门禁条件、项目绑定和流水线阻断没有放在同一条链路里看。SonarSource官方说明很明确,质量门禁本质上是一组条件,既可以基于新代码,也可以基于整体代码;实例里还有默认质量门禁,未单独绑定的项目会先继承默认门禁。
2026-03-25
SonarQube怎么导入新项目 SonarQube项目Key怎么填写
在SonarQube里,新项目导入本质上有两条路,一条是先在平台里手工创建项目,再接扫描;另一条是第一次分析时直接把项目带上来,服务器会在收到一个不存在的项目Key后自动创建项目。官方文档也明确说明,手工创建时项目名和项目Key是本地项目创建的必要参数,而首次分析同样依赖项目Key完成识别。
2026-03-25
SonarQube质量门禁怎么配置 SonarQube质量门禁不触发怎么排查
质量门禁的价值不在于看板上多一个红绿灯,而在于它能把代码扫描结果变成可执行的准入规则。配置时要先把门禁规则定清楚,再把项目和门禁绑定好,最后在流水线里把门禁结果接回来并决定是否中断构建,否则你会看到门禁已经失败但流水线照样放行的情况。
2026-03-02

读者也喜欢这些内容:

咨询热线 18015636924