galilee/sonar-scanner

Sonar Scanner Docker镜像文档

镜像概述

Sonar Scanner Docker镜像是Sonar Scanner的容器化版本，将代码质量分析工具Sonar Scanner封装为Docker镜像，提供便捷、一致的代码质量与安全性扫描能力。通过容器化部署，可快速集成到各类环境中，无需在主机系统中单独安装Sonar Scanner及其依赖，降低环境配置复杂度，专注于代码分析本身。

核心功能与特性

• 多语言支持：支持Java、Python、JavaScript、C#、Go等多种编程语言的代码分析，覆盖主流开发场景。
• CI/CD集成：轻量级设计，可无缝集成到Jenkins、GitLab CI、GitHub Actions等主流CI/CD平台，实现代码提交或构建环节的自动化分析。
• 结果上报：扫描完成后自动将代码质量数据（如漏洞、代码异味、重复率、测试覆盖率等）发送至指定的SonarQube服务器，支持集中式结果查看与管理。
• 灵活配置：通过环境变量或命令行参数自定义扫描行为，支持指定项目密钥、分支信息、排除目录、分析规则等。
• 跨平台兼容：基于Docker容器，可在Linux、macOS、Windows等支持Docker的操作系统中运行，环境一致性高。

使用场景

• 开发环境本地分析：开发人员在本地开发完成后，通过Docker快速启动扫描，提前发现代码质量问题，减少提交到版本库的低质量代码。
• CI/CD流程自动化分析：在代码提交、合并请求或构建阶段自动触发扫描，作为质量门禁，阻止不合格代码进入下一环节。
• 多项目批量扫描：针对微服务架构或多模块项目，通过统一的Docker命令批量执行扫描，简化多项目管理流程。
• 临时专项检查：无需修改现有项目配置，通过容器化扫描对指定项目或分支进行临时的深度代码质量检查。

使用方法与配置说明

前置条件

• 已部署SonarQube服务器，并获取访问URL（如http://sonarqube:9000）。
• 已在SonarQube中创建项目，获取项目密钥（SONAR_PROJECT_KEY）和访问令牌（SONAR_TOKEN，具有项目分析权限）。
• 本地安装Docker引擎（20.10+版本推荐）。

基本使用命令（docker run）

通过挂载项目目录至容器，并指定SonarQube连接信息，执行扫描：

bash
docker run --rm \
  -v "$(pwd):/usr/src" \  # 挂载本地项目目录到容器内/usr/src
  -e SONAR_HOST_URL="http://sonarqube:9000" \  # SonarQube服务器URL
  -e SONAR_TOKEN="your-sonar-token" \  # SonarQube访问令牌
  -e SONAR_PROJECT_KEY="my-project-key" \  # 项目唯一标识
  sonarsource/sonar-scanner-cli

说明：

• -v "$(pwd):/usr/src"：将当前目录（项目根目录）挂载到容器内的/usr/src，确保扫描器可访问项目代码。
• 环境变量（-e）用于配置扫描参数，也可通过命令行参数（如-Dsonar.host.url=...）覆盖。

自定义扫描参数

除基础连接信息外，可通过环境变量或命令行参数指定更多扫描配置：

bash
docker run --rm \
  -v "$(pwd):/usr/src" \
  -e SONAR_HOST_URL="http://sonarqube:9000" \
  -e SONAR_TOKEN="your-sonar-token" \
  -e SONAR_PROJECT_KEY="my-project-key" \
  -e SONAR_PROJECT_NAME="My Project" \  # 项目名称（可选，默认与项目密钥一致）
  -e SONAR_PROJECT_VERSION="1.0.0" \  # 项目版本（可选）
  -e SONAR_EXCLUSIONS="**/node_modules/**,**/test/**" \  # 排除扫描的目录（可选）
  sonarsource/sonar-scanner-cli

docker-compose配置示例

创建docker-compose.yml文件，集成到项目部署流程：

yaml
version: '3'
services:
  sonar-scanner:
    image: sonarsource/sonar-scanner-cli
    volumes:
      - ./:/usr/src  # 挂载项目目录
    environment:
      - SONAR_HOST_URL=http://sonarqube:9000  # 假设SonarQube服务名为sonarqube（同一网络内）
      - SONAR_TOKEN=your-sonar-token
      - SONAR_PROJECT_KEY=my-project-key
      - SONAR_PROJECT_NAME=My Project
    networks:
      - sonar-network  # 与SonarQube服务器共享网络（若在同一compose文件中）

networks:
  sonar-network:
    external: true  # 或使用已存在的网络

执行扫描：

bash
docker-compose run sonar-scanner

核心配置参数说明

注意事项

• 确保挂载的项目目录权限正确，容器内用户需有读取项目文件的权限（可通过-u $(id -u):$(id -g)指定用户ID）。
• 扫描大型项目时，可通过-e SONAR_SCANNER_OPTS="-Xmx2G"调整JVM内存限制。
• 若SonarQube服务器启用HTTPS，需确保容器内信任对应SSL证书（可挂载证书文件至/etc/ssl/certs）。
• 命令行参数（如-Dsonar.xxx）优先级高于环境变量，可用于临时覆盖配置。