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 Webhook怎么配置 SonarQube Webhook推送失败怎么排查
SonarQube Webhook的配置,和推送失败时的排查,重点并不只是填进去一个回调地址就完成了,而是要去确认这个地址,能够被SonarQube的服务器正常访问到,并且接收的那一端,也能够正确地识别出推送过来的内容。Webhook这个东西,通常是用来把扫描完成、质量门禁的状态这一类结果,推送给Jenkins、GitLab、企业微信、钉钉,或者是公司内部的平台。SonarQube它支持项目这一级,和全局这一级的Webhook配置,项目级的,是可以在项目的设置里面去配,全局级的,则是可以在系统的管理里面去配。
2026-06-30
SonarQube新代码周期怎么设置 SonarQube新代码周期影响门禁结果怎么看
SonarQube新代码周期的设置,以及新代码周期对门禁结果的影响,是很多团队在配置质量门禁时容易忽略的问题。新代码周期并不是一个单纯的日期设置,它决定了哪些代码会被SonarQube当作“新增或修改的代码”来评估。如果质量门禁主要看的是新代码指标,那么新代码周期的设置一旦不同,同一份代码的门禁结果,也就可能会跟着不同。在SonarQube里面,新代码的定义可以按照全局、项目,或者是分支的层级来进行配置,而且它会影响到新代码问题,以及相关质量指标的计算。
2026-06-30
SonarQube安全热点怎么审查 SonarQube安全热点状态怎么同步
SonarQube安全热点的审查,以及安全热点状态的同步,是安全扫描被接入研发流程以后,经常会碰到的问题。安全热点并不是已经被确认的漏洞,它是在提示这一段代码涉及到了安全方面比较敏感的逻辑,需要由开发人员,或者是安全人员,去进一步做出判断。在SonarQube的文档里面,也明确地把安全热点和漏洞区分了开来:安全热点需要经过人工的审查以后,再去判断是不是要进行修复;而漏洞通常代表的是已经影响到应用安全,应当被优先去修复的问题。所以,在处理安全热点的时候,不能只是看它的数量有多少,也不能简单地就把它一键关掉。
2026-06-30
SonarQube项目权限怎么设置 SonarQube项目权限导致成员看不到代码怎么办
SonarQube项目权限的设置,和因为权限问题导致成员看不到代码的处理,需要先分清楚项目到底是Public还是Private。公开的项目,一般来说更容易被访问到,私有的项目,则需要明确地去给用户,或者用户组进行授权。在SonarQube的官方说明里面,私有项目是需要去配置Browse Project和See Source Code这些权限的;如果要查看项目的结构和代码,私有项目的用户,就需要同时具备Browse和See Source Code这两项权限。
2026-06-30
SonarQube怎么管理项目权限 SonarQube项目权限继承关系怎么检查
在SonarQube里,项目权限这件事最容易被理解错的地方,不是按钮在哪里,而是“继承”到底指什么。按官方口径,项目创建时会先套用一套Permission Template,也就是模板默认权限;但模板套上去以后,项目和模板之间并不存在持续联动关系,后面你手工改项目权限、或者再去改模板,本来就不会自动互相跟着变。再加上SonarQube的项目权限本身又不是累加关系,所以很多人看到“模板明明给了权限,项目里却不对”,本质上往往是把“初始化套用”误当成了“持续继承”。
2026-04-29
SonarQube怎么做分支分析 SonarQube分支分析结果怎么和主干对比
很多团队把SonarQube接进流水线以后,主干分析通常很快就能跑起来,但一到分支分析,问题就会集中在两处。一处是不确定分支到底怎么建出来,另一处是不知道分支结果和主干该按什么口径去比。按SonarSource当前官方文档,分支分析从Developer Edition起才提供,分支是在分析时传入sonar.branch.name后创建出来的;而分支和主干的对比,本质上又不是靠手工看两份报告,而是靠Reference branch也就是参考分支,配合New Code口径去做差异判断。把这两层先分清,后面配置和看结果都会顺很多。
2026-04-29

读者也喜欢这些内容:

咨询热线 18015636924