Qodana JVM Community Docker镜像文档

1. 镜像概述和主要用途

Qodana JVM Community Docker镜像是JetBrains***提供的静态代码分析工具，专为JVM项目（如Java、Kotlin、Scala等）设计。基于IntelliJ平台的代码洞察能力，该镜像可帮助开发者自动化检测代码缺陷、改进代码质量、确保代码符合行业标准和团队规范，支持本地开发与CI/CD流程集成。

2. 核心功能和特性

• 多语言支持：深度支持Java、Kotlin、Scala等主流JVM语言，覆盖JVM项目全栈代码分析场景。
• IntelliJ级代码洞察：复用IntelliJ IDEA的代码检查引擎，精准识别语法错误、空指针风险、资源泄漏等问题。
• 可配置检查规则：支持通过XML/JSON配置文件自定义检查规则，适配团队代码规范或行业标准（如SonarQube规则集）。
• 详细报告生成：输出HTML/JSON格式的分析报告，包含问题分类（错误、警告、代码异味）、位置定位及修复建议。
• 轻量级容器化：基于Docker镜像封装，无需本地安装IDE，直接通过命令行或CI工具调用，简化部署流程。

3. 使用场景和适用范围

• 本地开发辅助：开发者在提交代码前本地运行分析，提前发现问题，减少代码评审成本。
• CI/CD流程集成：嵌入Jenkins、GitHub Actions等CI/CD工具，在构建阶段自动执行代码检查，阻止不合格代码合并。
• 项目质量审计：定期对存量项目进行全量分析，评估代码健康度，推动技术债务清理。
• 团队协作规范：统一团队代码检查标准，通过自动化工具确保代码风格、安全性和可维护性一致性。

4. 使用方法和配置说明

4.1 基本使用（Docker命令示例）

本地运行代码分析

通过docker run命令挂载项目目录和报告输出目录，执行基础代码分析：

bash
docker run --rm \
  -v <本地项目路径>:/data/project \  # 挂载本地JVM项目根目录到容器内
  -v <本地报告输出路径>:/data/results \  # 挂载报告输出目录（本地目录需提前创建）
  jetbrains/qodana-jvm-community

生成并查看报告

分析完成后，报告默认输出至/data/results（即本地挂载的<本地报告输出路径>），可通过浏览器打开index.html查看可视化报告。如需运行后自动在浏览器中显示报告，可添加--show-report参数：

bash
docker run --rm \
  -v <本地项目路径>:/data/project \
  -v <本地报告输出路径>:/data/results \
  jetbrains/qodana-jvm-community --show-report

4.2 核心配置参数

4.3 环境变量

5. 许可证信息

使用Qodana Docker镜像即表示您同意JetBrains隐私政策。
镜像包含的JetBrains软件许可证信息详见第三方软件许可证。
镜像构建文件（Dockerfile）开源托管于JetBrains/qodana-docker仓库。

6. 联系方式

• 邮件支持：***
• 问题反馈：通过JetBrains YouTrack提交issue（项目标识：QD）。

欢迎提供功能建议或使用反馈，帮助改进工具能力。

***用户指南：Qodana JVM Community 帮助文档