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里,项目权限这件事最容易被理解错的地方,不是按钮在哪里,而是“继承”到底指什么。按官方口径,项目创建时会先套用一套Permission Template,也就是模板默认权限;但模板套上去以后,项目和模板之间并不存在持续联动关系,后面你手工改项目权限、或者再去改模板,本来就不会自动互相跟着变。再加上SonarQube的项目权限本身又不是累加关系,所以很多人看到“模板明明给了权限,项目里却不对”,本质上往往是把“初始化套用”误当成了“持续继承”。
2026-04-29
SonarQube怎么做分支分析 SonarQube分支分析结果怎么和主干对比
很多团队把SonarQube接进流水线以后,主干分析通常很快就能跑起来,但一到分支分析,问题就会集中在两处。一处是不确定分支到底怎么建出来,另一处是不知道分支结果和主干该按什么口径去比。按SonarSource当前官方文档,分支分析从Developer Edition起才提供,分支是在分析时传入sonar.branch.name后创建出来的;而分支和主干的对比,本质上又不是靠手工看两份报告,而是靠Reference branch也就是参考分支,配合New Code口径去做差异判断。把这两层先分清,后面配置和看结果都会顺很多。
2026-04-29
SonarQube怎么查看安全热点 SonarQube安全热点状态怎么批量处理
很多人第一次用SonarQube看安全问题时,容易把普通Issues和Security Hotspots混在一起,结果一边找不到入口,一边又误以为安全热点也能像普通问题那样直接批量改状态。官方文档把这两类对象分得很清楚,Security Hotspots有独立页面和独立生命周期,查看和处理逻辑都不完全等同于普通Issues。
2026-04-29
SonarQube怎么定义新代码 SonarQube新代码周期怎么切换
很多团队在用SonarQube时,真正容易混淆的不是有没有New Code,而是“新代码到底从哪一天开始算”和“项目、分支、全局到底谁说了算”。SonarQube官方把这套逻辑定义得很清楚,New Code可以按Previous version、Number of days、Specific analysis、Reference branch四种方式来定义,而且配置有全局、项目、分支三层覆盖关系,分支级优先于项目级,项目级优先于全局级。
2026-04-29
SonarQube规则集怎么调整 SonarQube规则禁用后为何仍触发
在SonarQube里,所谓“规则集”对应的其实是Quality Profile,也就是按语言生效的一组启用规则。真正容易出问题的地方,通常不是不会点启用和禁用,而是项目绑错了Profile、子Profile继承了父Profile、改完以后没有重新分析,结果看起来像是“规则明明关了却还在触发”。官方文档也明确说明,问题是在分析时根据项目关联的Quality Profile被产生出来的。
2026-03-25
SonarQube覆盖率为0怎么排查 SonarQube覆盖率报告路径怎么填
SonarQube里覆盖率显示为0,很多时候不是测试根本没跑,而是覆盖率报告没有在扫描前生成、扫描器没找到文件、报告格式和参数名不匹配,或者报告里的路径和当前项目根目录对不上。官方文档写得很明确,SonarQube本身不会生成覆盖率报告,它只负责导入外部工具生成的报告,所以排查顺序一定要先看报告有没有生成,再看扫描器有没有正确读到。
2026-03-25

读者也喜欢这些内容:

咨询热线 18015636924