SonarQube中文网站 > 使用技巧 > SonarQube代码扫描如何配置 SonarQube代码扫描规则自定义步骤

SonarQube代码扫描如何配置 SonarQube代码扫描规则自定义步骤

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

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

SonarQube以其丰富的内置规则库和强大的代码分析功能广受开发测试人员青睐,然而很多时候已有的规则并不能满足当前项目的检测要求,因此掌握SonarQube代码扫描如何配置,SonarQube代码扫描规则自定义步骤等相关技巧就显得尤为重要,这些操作能帮助我们处理扫描项目中的普通代码和独特代码,让SonarQube功能获得更大程度的发挥空间。

一、SonarQube代码扫描如何配置

在开始自定义扫描规则之前,我们需要先完成SonarQube代码扫描的基本配置,确保扫描可以顺利进行。以下是配置的关键步骤:

1、下载SonarScanner脚本。在SonarQube文档的扫描仪页面中,选择对应操作系统的版本点击下载,下载后在运行前建议关闭当前计算机上的防病毒软件和功能,以确保程序可以正常启动。

下载SonarScanner
图1:下载SonarScanner

2、添加到环境变量中。下载后得到一个压缩包,解压后打开bin目录便可看到扫描启动文件“sonar-scanner”,我们需要将bin路径添加到系统的PATH环境变量中,以便随时在项目根目录下执行该程序。

添加PATH变量
图2:添加PATH变量

3、添加项目配置文件。打开要扫描的项目文件夹,在其中添加名为“sonar-project.properties”的扫描配置文件,文件内容默认为下图所示。在其中可以配置各种自定义扫描参数,如扫描版本号、扫描分支名称、扫描文件夹等,具体可用参数可以在“https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/analysis-parameters/”网站上查询到。

完成以上配置后,在项目根目录下打开PowerShell界面,输入在SonarQube网页上获取到的扫描命令,执行即可开始扫描。

配置文件
图3:配置文件

二、SonarQube代码扫描规则自定义步骤

项目扫描时,尽管SonarQube提供的默认规则已经十分全面,但也无法确保能完全适合我们的项目,毕竟项目中可能会根据需求构造各种函数写法。为此可按照以下步骤自定义扫描规则,来适配我们的特殊需求。

1、获取模板。在Github上克隆或下载SonarSource提供的sonar-java项目,并将其中的java-custom-rules-examples子模块导入到IDE进行编辑,这是官方提供的规则自定义插件模板。

下载插件模板
图4:下载插件模板

2、构建项目。自定义插件是一个maven项目,在根目录中有一个“pom_SQ_10_6_LATEST.xml”文件,该文件会面向新版SonarQube构建项目,我们打开编辑该文件,在文件中自定义插件名称、描述、依赖等内容,再使用“mvn clean install -f pom_SQ_9_9_LTS.xml”命令来进行构建项目。

pom文件
图5:pom文件

3、规则实现。在“/src/test/files/”下创建Java代码文件,如MyFirstCustomCheck.java,包含正确和错误代码示例;在“/src/test/java/org/sonar/samples/java/checks/”下创建JUnit测试类;在“/src/main/java/org/sonar/samples/java/checks/”下创建规则实现类,该类继承IssuableSubionVisitor,实现方式参考示例代码,如下图所示。

实现规则
图6:实现规则

4、注册规则。在“src/main/resources/org/sonar/l10n/java/rules/java/”下创建规则描述文档HTML和规则元数据JSON,前者是规则的网页视图,后者包含规则的各种信息,如规则类型、严重性等。

最后在“org.sonar.samples.java.RulesList.java”中添加规则类到getJavaChecks()列表中注册规则。

注册规则
图7:注册规则

SonarQube的强大之处正是在于它的灵活性,无论是开箱即用的默认规则,还是通过插件自定义的定制规则,都能为我们的代码质量保驾护航。通过本文对SonarQube代码扫描如何配置,SonarQube代码扫描规则自定义步骤的操作指南,相信我们都可以快速上手进行SonarQube扫描,将代码质量管理化被动为主动。

展开阅读全文

︾

标签:

读者也访问过这里:
SonarQube
从一开始就生成高质量的代码
立即购买
最新文章
SonarQube怎么配置代码扫描 SonarQube扫描任务执行失败怎么解决
在本机能扫,放进CI就失败,先查两边运行环境;日志已经上传报告,项目页面却没更新,就去看后台处理。SonarQube扫描涉及几个连续环节,不能只凭流水线变红判断故障。配置时把项目标识、扫描目录和凭据对应好,出错后再沿日志找到中断位置,通常比反复修改整份配置更有效。
2026-10-30
SonarQube怎么进行代码质量分析 SonarQube代码分析结果异常怎么办
代码提交后,SonarQube里的问题数量突然增加,或者测试已经通过,覆盖率却仍然是零,这些情况未必都由代码修改引起。扫描目录、测试报告和规则配置都会影响结果,扫描成功与质量门禁通过也有区别。使用时应让分析任务对应到明确的代码版本,再查看具体问题。下面以已部署SonarQube、使用SonarScanner CLI分析Python项目为例,界面名称按英文版说明。
2026-10-30
SonarQube怎么导入测试执行报告 SonarQube测试执行数据导入后没有显示如何检查
测试已经运行,报告也保存了,SonarQube页面却没有显示用例数量,问题可能出在报告路径、格式或分析状态上。“SonarQube怎么导入测试执行报告SonarQube测试执行数据导入后没有显示如何检查”需要结合测试工具和扫描方式处理。下面以Python项目、pytest和SonarScanner CLI为例,说明配置与排查步骤。测试执行报告记录用例结果和耗时,与覆盖率报告需要分别导入。
2026-09-30
SonarQube怎么查看认知复杂度 SonarQube认知复杂度过高如何定位具体代码
SonarQube中的Cognitive Complexity用于衡量代码控制流程的理解难度,与Cyclomatic Complexity侧重统计执行路径不同。项目中的认知复杂度可以在Measures中查看,并逐步下钻到目录和文件;如果要继续定位具体函数,则需要结合认知复杂度规则产生的Issue进行检查。项目指标很高却找不到对应Issue时,还要区分“累计指标”和“单个函数规则阈值”这两种计算结果。
2026-08-31
SonarQube怎么导入外部Issue报告 SonarQube外部Issue导入后不显示如何排查
SonarQube可以把第三方静态分析工具产生的问题导入项目,与自身检测出的Issue一起查看。对于已经适配SonarQube的工具,可以使用对应的报告参数;其他分析器可以转换成Generic Issue格式或SARIF格式再导入。报告文件已经生成但SonarQube页面没有显示问题时,要先确认Scanner实际读取到了报告,再检查报告格式、源码路径、分析范围和当前查看的分支,不能只看报告文件是否存在。
2026-08-31
SonarQube后台任务怎么查看 SonarQube后台任务执行失败怎么排查
SonarScanner显示EXECUTION SUCCESS,项目页面却迟迟没有新结果,这种情况并不少见。扫描器只是把分析报告上传到服务器,后续还要交给Compute Engine处理。后台任务没跑完,结果就不会正式进入项目。
2026-07-30

读者也喜欢这些内容:

咨询热线 18015636924