如何在Jenkins脚本化流水线中为.NET代码库集成企业级Sonar？

前置校验 #

• Jenkins已安装SonarQube Scanner for Jenkins插件，且全局配置中已完成企业SonarQube服务端的地址绑定
• SonarQube访问令牌已存储到Jenkins凭证管理器，类型为Secret text，提前记录该凭证的ID值
• 构建节点已安装对应版本的.NET SDK，建议预装dotnet-sonarscanner全局工具

核心流程说明 #

.NET项目的Sonar扫描需要和构建流程绑定，执行顺序为：
代码检出 → Sonar扫描初始化 → 执行.NET项目构建 → Sonar扫描结束并上报结果 → 质量门禁校验（可选） → 原有推送制品到Artifactory阶段

注意：原有的独立PowerShell构建步骤需要嵌入到Sonar扫描的初始化和结束步骤之间，不可单独拆分执行

脚本化流水线Sonar阶段代码示例 #

node('你的构建节点标签') {
    stage('代码检出') {
        // 你原有代码检出的逻辑保持不变
        git url: '你的代码仓库地址', credentialsId: '你的git凭证ID'
    }

    stage('Sonar代码扫描') {
        // 从Jenkins凭证管理器取出Sonar令牌
        withCredentials([string(credentialsId: '你的Sonar凭证ID', variable: 'SONAR_TOKEN')]) {
            powershell """
                # 1. （可选）如果构建节点未预装sonar scanner，执行安装
                dotnet tool install --global dotnet-sonarscanner
                
                # 2. Sonar扫描初始化，替换为你的项目实际参数
                dotnet sonarscanner begin /k:"你的Sonar项目唯一Key" /n:"你的Sonar项目显示名称" /v:"当前构建版本号" `
                    /d:sonar.host.url="你的企业SonarQube服务端地址" `
                    /d:sonar.login="${SONAR_TOKEN}" `
                    /d:sonar.exclusions="**/bin/**,**/obj/**,**/*.Tests/**" # 按需配置不需要扫描的路径
                
                # 3. 执行你原有的.NET构建逻辑，和之前的PowerShell构建命令完全一致即可
                dotnet build 你的解决方案名.sln -c Release
                
                # 4. 结束扫描并上报结果到Sonar服务端
                dotnet sonarscanner end /d:sonar.login="${SONAR_TOKEN}"
            """
        }
        
        // 可选：开启Sonar质量门禁校验，不通过则直接中断流水线，不进入后续制品推送阶段
        def qualityGate = waitForQualityGate()
        if (qualityGate.status != 'OK') {
            error "Sonar质量门禁未通过：${qualityGate.status}"
        }
    }

    stage('推送制品到Artifactory') {
        // 你原有制品推送的逻辑保持不变
    }
}

注意事项 #

• 若你使用的是.NET Framework项目，将dotnet-sonarscanner替换为SonarScanner for MSBuild，对应执行命令调整为MSBuild.SonarQube.Runner.exe的相关参数即可
• 如果项目包含单元测试，可在dotnet build之后、dotnet sonarscanner end之前补充单元测试执行、覆盖率报告生成命令，Sonar会自动识别适配opencover、cobertura等主流格式的覆盖率文件
• 所有路径、参数如果包含空格，需要用引号包裹避免解析错误

内容的提问来源于stack exchange，提问作者knowledge20