juntossomosmais/dotnet-sonar

.NET SonarScanner 分析镜像

镜像概述

本镜像基于dotnet SDK构建，集成了dotnet sonarscanner工具和Java运行环境，专门用于在.NET项目中执行Sonar代码质量分析。通过整合必要的依赖组件，可简化.NET项目与SonarQube的集成流程，快速实现代码缺陷、安全漏洞及规范问题的自动化检测。

核心功能

• 基础环境：包含完整的dotnet SDK，支持.NET Framework/.NET Core/.NET 5+项目的构建与运行
• 分析工具：内置dotnet sonarscanner，可直接执行SonarQube分析命令
• 依赖集成：预装Java运行时，满足SonarQube分析对Java环境的依赖要求
• 无缝对接：支持与SonarQube服务器通信，自动上传分析结果至平台

适用场景

• CI/CD流水线：集成到Jenkins、GitLab CI等持续集成流程，实现代码提交后的自动质量检测
• 开发环境：本地开发阶段执行预分析，提前发现代码问题
• 发布验证：在版本发布前执行强制质量检查，确保符合团队质量标准
• 批量分析：对历史项目或多模块.NET解决方案进行集中式代码质量审计

使用方法

前置条件

• 已部署SonarQube服务器并获取访问令牌（Token）
• 待分析的.NET项目源代码（本地目录或版本库）

基本命令格式

bash
docker run -it --rm \
  -v [本地项目路径]:/app \
  -e SONAR_HOST_URL=[SonarQube服务器URL] \
  -e SONAR_TOKEN=[SonarQube访问令牌] \
  -e SONAR_PROJECT_KEY=[项目标识] \
  [镜像名称] \
  bash -c "cd /app && dotnet sonarscanner begin /k:\"$SONAR_PROJECT_KEY\" /d:sonar.host.url=\"$SONAR_HOST_URL\" /d:sonar.login=\"$SONAR_TOKEN\" && dotnet build && dotnet sonarscanner end /d:sonar.login=\"$SONAR_TOKEN\""

参数说明

高级配置

可通过添加额外参数自定义分析行为：

bash
# 指定项目名称和版本
docker run ... \
  -e SONAR_PROJECT_NAME="MyApp" \
  -e SONAR_PROJECT_VERSION="1.0.0" \
  ... \
  bash -c "cd /app && dotnet sonarscanner begin /k:\"$SONAR_PROJECT_KEY\" /n:\"$SONAR_PROJECT_NAME\" /v:\"$SONAR_PROJECT_VERSION\" ..."

# 排除特定目录分析
docker run ... \
  bash -c "cd /app && dotnet sonarscanner begin ... /d:sonar.exclusions=\"**/obj/**,**/bin/**\" ..."

docker-compose 示例

yaml
version: '3'
services:
  sonar_analysis:
    image: [镜像名称]
    volumes:
      - ./src:/app
    environment:
      - SONAR_HOST_URL=http://sonarqube:9000
      - SONAR_TOKEN=sqa_1234567890abcdef
      - SONAR_PROJECT_KEY=my-dotnet-project
    command: >
      bash -c "cd /app && 
               dotnet sonarscanner begin /k:\"$SONAR_PROJECT_KEY\" /d:sonar.host.url=\"$SONAR_HOST_URL\" /d:sonar.login=\"$SONAR_TOKEN\" && 
               dotnet build && 
               dotnet sonarscanner end /d:sonar.login=\"$SONAR_TOKEN\""

注意事项

• 确保本地项目路径权限允许容器读取（建议使用chmod 755设置目录权限）
• 大型项目分析可能需要调整容器内存限制（通过--memory参数）
• 分析结果可在SonarQube服务器的项目面板中查看详细报告