zzdats/dotnet-sonarscanner

.NET SDK with SonarScanner 镜像文档

概述

本镜像基于官方.NET SDK镜像构建，集成了SonarScanner工具插件，提供一站式的.NET开发与代码质量检测环境。通过将.NET开发工具链与SonarScanner静态代码分析工具结合，实现开发过程中代码质量的自动化检测，帮助团队尽早发现代码缺陷、规范代码风格并提升整体代码质量。

核心功能

1. 完整的.NET开发环境

• 基于官方.NET SDK镜像，支持.NET 5+、.NET Core 3.1等主流版本开发
• 包含dotnet命令行工具，支持项目构建、测试、发布等全流程开发操作

2. 集成SonarScanner工具

• 内置SonarScanner for .NET插件，支持通过dotnet sonarscanner命令启动代码分析
• 支持静态代码分析，覆盖代码复杂度、潜在缺陷、安全漏洞、代码规范等多维度检测
• 兼容SonarQube服务器，可将分析结果上传至SonarQube平台生成可视化质量报告

3. 灵活的配置支持

• 支持通过命令行参数或配置文件自定义分析规则
• 提供环境变量配置接口，便于集成到CI/CD流水线

使用场景

1. CI/CD流水线代码质量门禁

在Jenkins、GitLab CI、GitHub Actions等CI/CD流程中集成，作为代码合并前的质量检查环节，自动拦截不符合质量标准的代码提交。

2. 本地开发环境代码质量预检查

开发者在本地开发完成后，通过容器化环境快速执行代码质量分析，提前修复潜在问题，减少代码评审成本。

3. 团队代码质量标准化

统一团队代码质量检测工具版本和规则配置，避免因本地环境差异导致的分析结果不一致问题。

使用方法

基本使用

前提条件

• 已安装Docker环境
• （可选）已部署SonarQube服务器（用于结果上传和报告查看）

基础命令格式

bash
docker run -v [本地项目目录]:/app -w /app [镜像名称] \
  dotnet sonarscanner begin /k:"[项目唯一标识]" [其他参数] && \
  dotnet build && \
  dotnet sonarscanner end

参数说明

• /k:"[项目唯一标识]"：SonarQube中注册的项目Key（必填）
• /d:sonar.host.url="[SonarQube地址]"：SonarQube服务器地址（默认：http://localhost:9000）
• /d:sonar.login="[令牌]"：SonarQube访问令牌（私有服务器需配置）
• /d:sonar.projectName="[项目名称]"：项目显示名称
• /d:sonar.sources="[源代码目录]"：指定待分析的源代码路径（默认：当前工作目录）

环境变量配置

示例：本地项目代码分析

1. 无SonarQube服务器（生成本地报告）

bash
docker run -v $(pwd):/app -w /app [镜像名称] \
  dotnet sonarscanner begin /k:"my-dotnet-project" /d:sonar.analysis.mode="preview" && \
  dotnet build && \
  dotnet sonarscanner end

注：sonar.analysis.mode="preview"模式仅输出分析结果，不上传至服务器

2. 集成SonarQube服务器

bash
docker run -v $(pwd):/app -w /app \
  -e SONAR_HOST_URL="http://sonarqube:9000" \
  -e SONAR_PROJECT_KEY="my-dotnet-project" \
  -e SONAR_LOGIN="sqa_xxxxxx" \
  [镜像名称] \
  dotnet sonarscanner begin && \
  dotnet build && \
  dotnet sonarscanner end

Docker Compose示例

yaml
version: '3.8'

services:
  sonarqube:
    image: docker.xuanyuan.run/sonarqube:latest
    ports:
      - "9000:9000"
    environment:
      - SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true
    volumes:
      - sonarqube_data:/opt/sonarqube/data

  dotnet-sonar:
    image: docker.xuanyuan.run/[镜像名称]
    volumes:
      - ./my-dotnet-project:/app
    working_dir: /app
    environment:
      - SONAR_HOST_URL=http://sonarqube:9000
      - SONAR_PROJECT_KEY=my-project
      - SONAR_LOGIN=admin-token  # 替换为SonarQube管理员令牌
    command: >
      sh -c "dotnet sonarscanner begin && \
             dotnet build && \
             dotnet sonarscanner end"

volumes:
  sonarqube_data:

使用说明：启动后访问http://localhost:9000查看分析报告，首次登录账号密码为admin/admin。

注意事项

• 确保本地项目目录挂载权限正确，避免因权限问题导致代码文件无法读取
• SonarScanner分析结果依赖项目构建输出，需确保dotnet build命令执行成功
• 大型项目建议增加-d:sonar.verbose=true参数开启详细日志，便于排查分析失败问题
• 定期更新镜像以获取最新的.NET SDK和SonarScanner版本，确保规则库和安全补丁同步