SonarQube中文网站 > 使用技巧 > SonarQube代码扫描如何配置 SonarQube扫描规则选择与项目绑定步骤

SonarQube代码扫描如何配置 SonarQube扫描规则选择与项目绑定步骤

发布时间:2025-11-01 14: 04: 00

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

随着技术不断革新发展,如今的软件质量监测,早已告别二十年前的人工审查模式,而是采用一系列质量检测插件或工具进行自动化扫描。SonarQube作为代码质量检测方面的佼佼者,内置了数千条检测规则,且整合了一系列检测工具,我们无需再自己繁琐地整合,它还可生成网页检测报告,让质量检测成为一项快速、精准、简单的工作。那么,SonarQube代码扫描如何配置,SonarQube扫描规则选择与项目绑定步骤是什么呢?

一、SonarQube代码扫描如何配置

SonarQube在进行代码扫描之前,需要先进行以下配置:

1、获取Token。打开SonarQube网页端,点击右上方头像中的“My Account”菜单,再点击Security进入下图所示界面。在该界面的Generate Tokens中,输入token Name,选择Type为“Project Analysis Token”,选择Project为要分析的项目,再在Expires in中选择Token的过期时间,最后点击“Generate”生成并获取项目扫描所需token。

获取Token
图1:获取Token

2、新增项目配置。在要扫描项目的根目录下,创建一个“sonar-project.properties”的扫描配置文件,在其中按照下图所示填写好“sonar.host.url”、“sonar.sources”、“sonar.sourceEncoding”的配置并保存。

项目配置
图2:项目配置

3、在项目根目录下,右键点击“在此处打开PowerShell窗口”,并输入命令“sonar-scanner.bat -D"sonar.projectKey=test" -D"sonar.projectVersion=1.0" -D"sonar.token=sqp_d5cca9b27686d37bc233524ea18d0fb8c9651eff"”,回车运行即可自动开始对“sonar.sources”指定的代码目录进行扫描,并最终生成报告显示在网页上。

这里命令的项目Key和项目版本号、项目Token大家需根据自身项目进行编辑。

启动扫描
图3:启动扫描

二、SonarQube扫描规则选择与项目绑定步骤

在进行扫描之前,我们还需要将SonarQube的扫描规则和项目进行绑定,合理的规则配置可以避免误报和漏报,而正确的项目绑定则能确保扫描结果与团队的质量标准保持一致。下面介绍如何将扫描规则与项目进行绑定:

1、在网页端点击Quality Profiles菜单,点击Create按钮创建一条质量配置,创建时可以选择扩展已有的配置,也可以选择复制已有的配置,或选择创建空白的配置。我们选择“Extend an existing quality profile”扩展配置,在Language设置代码语言,在Parent选择被扩展的父级配置,最后点击Create完成创建。

新建Quality Profile
图4:新建Quality Profile

2、继承已有的Quality Profile之后,其中对应的规则也会相应继承过来。接下来点击Change Projects按钮,切换到All选项卡,勾选要绑定的项目,点击Close按钮即可将规则绑定该项目,后续便可在项目根目录下进行扫描。

绑定项目
图5:绑定项目

以上就是关于SonarQube代码扫描如何配置,SonarQube扫描规则选择与项目绑定步骤的教程。完成扫描的各项配置以及规则绑定项目只是代码质量管理的起点,要让SonarQube真正发挥价值,关键在于设置合理的质量门,它定义了项目通过扫描的最低标准,确保扫描报告能准确反映项目质量状态。只有将规则配置、项目绑定和质量门设置三者结合,才能让SonarQube每一次扫描结果都成为改进代码质量的可靠依据。

展开阅读全文

标签:

读者也访问过这里:
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