SonarQube中文网站 > 售前问题 > SonarQube如何创建项目 SonarQube如何生成报告

SonarQube如何创建项目 SonarQube如何生成报告

发布时间:2025-05-16 14: 39: 13

品牌型号:联想 E550C ThinkPad

系统:Windows 11

软件版本:SonarQube Server 25

SonarQube是一款支持多种编程语言,包括Java、C#、Python等的代码质量检测工具,能帮助我们检测项目代码中的漏洞以及潜在的维护性问题,并生成全面的代码检测报告,同时报告从多个维度给出直观评级,帮助我们快速定位问题根源。在本文中,将系统教大家SonarQube如何创建项目,SonarQube如何生成报告,全面了解SonarQube的使用流程。

一、SonarQube如何创建项目

SonarQube中以项目为基础单元进行检测管理,只有先创建项目,才能进行后续的检测和生成报告操作,以下是在SonarQube中创建项目的具体步骤:

1、首先,打开SonarQube的网页端界面,在默认情况下SonarQube服务绑定9000端口,我们可以在启动SonarQube服务后,通过浏览器访问本地地址“http://localhost:9000”,输入默认用户名admin和默认密码admin后,进入SonarQube的仪表盘。

登录SonarQube
图1:登录SonarQube

2、点击网页顶部的Projects菜单,打开项目界面,再点击“Create Project”展开创建项目下拉框,下拉框中有“Local project”和“Import from DevOps Platforms”两个选项,分别可以创建本地项目和导入远程平台项目。

这里点击Local project进入下图的创建本地项目界面,输入项目名称和唯一标识符key,点击Next进入下一步。

创建本地项目
图2:创建本地项目

3、在此阶段要设置项目对于新旧代码的区分方式,帮助用户聚焦新代码质量,降低对老旧代码的关注度。主要有三种设置方式:

①Previous version:适合按照版本发布的项目,以最近版本为区分标准。

②Number of days:以最近多少天为区分,超过指定天数以上为旧代码。

③Reference branch:以提交分支为基准,指定某个分支为新代码,其余分支为旧代码。

我们根据需要设定好模式后,点击Create projects按钮即可完成项目创建。

选择项目区分方式
图3:选择项目区分方式

二、SonarQube如何生成报告

创建项目后,接下来就要使用SonarQube检测代码质量,生成详细的报告,以帮助项目团队快速定位问题,跟踪项目修改进度。以下是SonarQube生成报告的完整流程:

1、下载SonarScanner。进入SonarQube Server文档中,找到Analyzing source code下的Scanners选项,点击其中的SonarScanner CLI查看相关文档,在如图文档界面中,点击对应的操作系统,下载对应系统的代码扫描脚本。

下载SonarScanner CLI
图4:下载SonarScanner CLI

2、添加环境变量。解压下载压缩包,打开文件夹的bin目录,复制bin目录路径,将该路径添加到系统的PATH环境变量中。

添加系统路径
图5:添加系统路径

3、项目根目录下添加扫描配置文件。在要扫描的本地项目根目录下,添加名为“sonar-project.properties”的配置文件,文件内容按照官方文档建议的默认配置进行配置。

添加项目配置文件
图6:添加项目配置文件

4、启动Sonar Scanner服务生成报告。在项目根目录下打开终端程序,输入命令“sonar-scanner.bat”启动代码扫描检测程序,等待检测完成后打开SonarQube网页端即可查看到本次检测生成的检测报告。

开始扫描生成报告
图7:开始扫描生成报告

现在,我们已经掌握了SonarQube如何创建项目,SonarQube如何生成报告的相关操作方法,相信通过SonarQube的这些强大功能,我们的项目不仅能持续提升代码质量,更能建立起透明可追溯的质量改进机制,让代码质量管理从被动检查转变为主动预防,最终打造出更健壮、更安全的软件产品。

 

 

展开阅读全文

标签:

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