发布时间:2025-08-27 08: 00: 00
品牌型号:联想 E550C ThinkPad
系统:Windows 11
软件版本:SonarQube Server 25
现代软件开发往往采用多分支并行开发的模式,团队内部成员各自开发自己的任务功能,再由团队leader审阅合并分支形成项目完整代码,这在一定程度上提升了开发效率。在审阅之前,可使用SonarQube为这些不同的功能分支进行独立分析,以确定分支代码的安全性和正确性,及时发现潜在问题,当然分支分析也可集成到CI/CD流程中实现自动化。在下文中,将深入探讨SonarQube分支分析怎么启用,SonarQube分支分析流水线集成流程,进而为团队提供更科学的质量保障体系。
一、SonarQube分支分析怎么启用
SonarQube的分支分析功能使得团队能够针对不同的代码分支,如长期分支、短期分支、主从分支,进行独立的代码质量检查,生成该分支的专属质量报告,以防止将低质量代码合并,要启用分支分析,需要SonarQube达到开发者版及以上版本,并按照以下步骤进行:
1、在项目根目录下创建“sonar-project.properties”的扫描配置文件,在文件中使用“sonar.branch.name”指定分支名称,未指定则默认为main主分支。如果要设置新代码的定义分支,则还需使用“sonar.newCode.referenceBranch”指定新代码分支,该分支将作为新代码进行扫描分析。
2、由于不同的分支可能会有不同的质量门配置,因此还可以在分支项目中,点击右侧的Project Settings项目设置,点击Quality Gate项,为不同分支配置不同的质量门。
二、SonarQube分支分析流水线集成流程
除了基本的启用分支分析功能外,将分支分析集成到流水线中,在每次提交PR时自动发起该分支的扫描分析,也是一项重要功能。SonarQube可在Jenkins、Azure Pipelines、Bitbucket Pipelines、Codemagic、GitHub Actions、GitLab CI/CD中加入分支分析功能,以常用的GitLab CI/CD为例,配置如下:
1、在Gitlab个人资料的Access Tokens页面中,填写令牌名称、选择权限范围后可获取对应的token数据。在SonarQube的“DevOps Platform Integrations”设置页面,点击“Create configurations”按钮创建一个Gitlab设置,如下图,在输入框中填写Gitlab API地址和刚刚获取到的token。
2、创建一个新项目,项目来源选择Gitlab,此时会显示当前Gitlab仓库下的全部项目,勾选其中要扫描分支的项目,点击Import,并设置new code方式为“Reference branch”。
3、项目创建完成后,在Analysis Method界面中选择Gitlab CI,此时会显示下图页面,点击“Generate a token”生成token值。
打开Gitlab的CI/CD设置页面,在变量值中添加两个变量,一个是“SONAR_TOKEN”变量,值为上述获取的token,另一个是“SONAR_HOST_URL”变量,值为SonarQube的网页URL,如“http://192.168.1.123:9000”。
4、继续在Analysis Method界面中,点击“Other”项,获取到对应“sonar-project.properties”配置文件的“sonar.projectKey”和“sonar.qualitygate.wait”值,将它们添加到项目SonarQube配置文件中。
5、在Analysis Method界面的第三步骤中,点击右侧Copy按钮,复制整段内容将其保存到“.gitlab-ci.yml”文件中,并将该文件上传到项目的Gitlab根目录中,这样就完成了分支分析的流水线配置。
根据以上对SonarQube分支分析怎么启用,SonarQube分支分析流水线集成流程如何操作的讲解,大家能够了解到流水线分支分析的配置相对会较为复杂,但配置成功后,每次分支提交质量分析就无需我们动手操作,后续的开发会更加方便,代码质量管理也会更加精细化。希望本文的指导能为团队提供清晰的集成操作路径,让SonarQube分支分析成为开发流程中不可或缺的一环。
展开阅读全文
︾