nemooudeis/spotbugs

SpotBugs Docker镜像文档

镜像概述

本镜像基于azul/zulu-openjdk-alpine构建，用于在CI环境中独立运行SpotBugs静态代码分析工具，无需依赖Gradle构建系统，可与其他CI任务并行执行。SpotBugs通过分析字节码检测代码缺陷，因此使用前需在前置任务中完成代码编译，并通过工作区传递编译后的类文件。

核心功能与特性

• 独立运行：无需集成到Gradle构建流程，可作为独立CI任务执行
• CI友好：支持主流CI平台（如CircleCI），可与其他任务并行处理
• 多格式报告：支持生成HTML和XML格式的分析报告，便于查看和后续处理
• 可配置分析：支持通过参数调整分析级别、排除规则和输出路径
• 轻量级基础：基于Alpine Linux构建，镜像体积小，启动速度快

使用场景

• CI/CD流水线中的代码质量检查环节
• Java或Android项目的静态代码缺陷检测
• 需要与其他构建/测试任务并行执行的场景
• 需独立生成代码质量报告的需求

使用方法

本地运行

通过挂载本地代码目录，直接运行SpotBugs分析编译后的类文件：

shell
docker run --rm --mount type=bind,src=$(pwd),dst=/code nemooudeis/spotbugs spotbugs "/code/build/intermediates/javac/"

CI环境配置（以CircleCI为例）

在CI流水线中配置独立的SpotBugs任务，需先完成代码编译并存储到工作区：

yaml
jobs:
  spotbugs:
    docker:
      - image: nemooudeis/spotbugs:4.4.1
    steps:
      # 挂载前置任务编译后的代码
      - attach_workspace:
          at: .
      - run:
          name: 执行SpotBugs分析
          command: |
            # 创建报告目录
            mkdir spotbugs
            # 生成HTML报告
            spotbugs -html -output spotbugs/spotbugs-report.html \
                -exclude spotbugs-filter.xml \
                -longBugCodes -quiet \
                -effort:max \
                -low \
                build/intermediates/javac/
            # 生成XML报告（用于后续处理）
            spotbugs -xml -output spotbugs/spotbugs-report.xml \
                -exclude spotbugs-filter.xml \
                -longBugCodes -quiet \
                -effort:max \
                -low \
                build/intermediates/javac/
      # 存储HTML报告供查看
      - store_artifacts:
          path: spotbugs
      # 保留XML报告供其他任务处理
      - persist_to_workspace:
          root: .
          paths:
            - coverage

主要配置参数说明

注意事项

• 必须确保前置任务已完成代码编译，提供有效的字节码目录
• 排除规则文件（spotbugs-filter.xml）需提前放置在项目根目录
• 根据项目规模调整-effort参数，大型项目建议使用max以提高检测准确性