noenv/sonar-scanner

docker-sonar-scanner 镜像文档

1. 镜像概述和主要用途

docker-sonar-scanner 是 SonarQube Scanner 的 Docker 容器化版本，用于对项目代码进行自动化质量检测和安全漏洞分析。该镜像封装了 SonarQube Scanner 的完整功能，支持在无需本地安装 Scanner 的情况下，通过容器化方式快速集成到开发流程中，实现代码质量的自动化监控与管理。

2. 核心功能和特性

• 轻量级部署：基于 Docker 容器，无需复杂的本地环境依赖配置，一键启动分析任务。
• 完整功能支持：包含 SonarQube Scanner 全部核心能力，支持 20+ 编程语言（如 Java、Python、JavaScript、Go 等）的代码质量与安全分析。
• 灵活配置机制：支持通过配置文件或命令行参数自定义分析规则、排除文件、指定源码目录等。
• 易于集成：可无缝集成到本地开发环境、CI/CD 流水线（如 Jenkins、GitHub Actions 等），实现自动化质量门禁。

3. 使用场景和适用范围

• 开发阶段本地检查：开发人员在提交代码前，通过容器快速运行代码分析，提前发现语法错误、代码异味、安全漏洞。
• CI/CD 流水线集成：在构建流程中自动触发代码扫描，若质量指标不达标（如覆盖率低于阈值、存在高危漏洞），阻断流水线推进。
• 项目质量监控：定期对存量项目执行扫描，生成质量报告，跟踪代码健康度变化趋势。
• 多语言项目分析：适用于包含多种编程语言的复杂项目，统一质量检测标准。

4. 使用方法和配置说明

4.1 基本使用（docker run）

通过挂载项目目录到容器，直接运行扫描命令：

bash
docker run --rm -v /<本地项目目录>:/data noenv/sonar-scanner sonar-scanner

• 参数说明：
  • --rm：扫描完成后自动删除容器，避免残留。
  • -v /<本地项目目录>:/data：将本地项目目录挂载到容器内的 /data 目录（容器工作目录）。
  • sonar-scanner：容器内执行的扫描命令（默认使用内置配置）。

4.2 高级配置（自定义参数与配置文件）

如需自定义扫描规则、指定 SonarQube 服务器地址、排除特定文件等，可通过以下方式配置：

4.2.1 挂载自定义配置文件

将本地 sonar-scanner.properties 挂载到容器内置配置路径，覆盖默认配置：

bash
docker run --rm \
  -v /<本地配置目录>/sonar-scanner.properties:/sonar-scanner/conf/sonar-scanner.properties \  # 自定义配置文件
  -v /<本地项目目录>:/data \  # 项目代码目录
  noenv/sonar-scanner sonar-scanner

4.2.2 命令行参数覆盖

通过 -D 参数在命令行直接指定扫描参数（优先级高于配置文件）：

bash
docker run --rm \
  -v /<本地项目目录>:/data \
  noenv/sonar-scanner sonar-scanner \
    -Dsonar.sources=<项目源码目录> \  # 如 src/main/java（相对于容器内 /data 目录）
    -Dsonar.projectKey=<项目唯一标识> \  # 如 my-project:1.0
    -Dsonar.host.url=<SonarQube 服务器地址> \  # 如 http://sonarqube:9000
    -Dsonar.login=<认证令牌> \  # SonarQube 管理员令牌
    -Dsonar.exclusions=<排除文件模式>  # 如 **/test/**/*.java,**/*.xml

4.3 Docker Compose 示例

若需与 SonarQube 服务器联动（如本地测试环境），可通过 docker-compose.yml 定义服务：

yaml
version: '3'
services:
  sonarqube:  # SonarQube 服务器（可选，用于本地测试）
    image: sonarqube:latest
    ports:
      - "9000:9000"
    environment:
      - SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true
    volumes:
      - sonarqube_data:/opt/sonarqube/data

  sonar-scanner:
    image: noenv/sonar-scanner
    depends_on:
      - sonarqube
    volumes:
      - /<本地项目目录>:/data  # 挂载项目代码
      - /<本地配置目录>/sonar-scanner.properties:/sonar-scanner/conf/sonar-scanner.properties  # 自定义配置
    command: sonar-scanner -Dsonar.host.url=http://sonarqube:9000 -Dsonar.login=admin-token

volumes:
  sonarqube_data:

5. 核心配置参数说明

以下为常用 SonarQube Scanner 配置参数（可通过配置文件或命令行 -D 参数设置）：

6. 镜像来源

• Docker Hub：https://hub.docker.com/r/noenv/sonar-scanner
• 源码仓库：https://github.com/noenv/docker-sonar-scanner