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

品牌型号：联想 E550C ThinkPad

系统：Windows 11

软件版本：SonarQube Server 25

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

一、SonarQube代码扫描如何配置

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

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

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

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

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

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

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

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

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

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，实现方式参考示例代码，如下图所示。

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

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

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