phpmetrics/phpmetrics

PhpMetrics Docker镜像

镜像概述和主要用途

PhpMetrics Docker镜像是PhpMetrics工具的官方容器化版本，用于对PHP项目和类进行全面的代码指标分析。该工具能够生成美观且易读的HTML报告，帮助开发者和项目管理者评估代码质量、维护性和结构合理性。通过Docker镜像，可以快速部署和使用PhpMetrics，无需在本地环境中复杂配置依赖。

核心功能和特性

• 多格式报告生成：支持HTML、JSON、CSV和违规检查（violation）等多种报告格式，满足不同场景的分析需求。
• 自定义配置：通过JSON配置文件灵活设置分析范围（包含/排除文件/目录）、报告输出路径、代码分组等。
• 代码分组分析：支持按正则表达式对类和包进行分组，生成特定分组的HTML报告，便于分层分析代码结构。
• 插件扩展：集成Git和JUnit插件，可分析Git提交记录和JUnit测试报告，丰富指标维度。
• 灵活的文件扩展名支持：默认分析.php和.inc文件，可通过配置扩展支持其他PHP相关文件（如.php8）。

使用场景和适用范围

• PHP项目代码质量评估：定期分析项目代码，监控复杂度、耦合度等关键指标，提升代码可维护性。
• 开发流程集成：嵌入CI/CD管道，在代码提交或构建过程中自动生成指标报告，及时发现潜在问题。
• 团队协作与代码审查：作为代码审查辅助工具，提供客观的代码质量数据，促进团队代码规范。
• 项目重构规划：通过指标分析识别高复杂度、低维护性的代码模块，指导重构优先级。

详细使用方法和配置说明

快速启动

通过Docker命令直接运行PhpMetrics，分析指定目录并生成HTML报告：

docker
docker run -v $(pwd):/app phpmetrics/phpmetrics --report-html=myreport /app/src

• -v $(pwd):/app：将当前目录挂载到容器内的/app目录，使PhpMetrics能够访问项目代码。
• --report-html=myreport：指定生成HTML报告的目录（容器内路径），报告将保存在/app/myreport（对应宿主机当前目录下的myreport文件夹）。
• /app/src：指定要分析的代码目录（容器内路径，对应宿主机当前目录下的src文件夹）。

生成报告后，在宿主机中打开./myreport/index.html即可查看分析结果。

自定义配置

通过JSON配置文件进行高级配置，需将配置文件挂载到容器内并通过--config参数指定：

配置文件示例（phpmetrics.json）

json
{
    "includes": [   // 要分析的目录和文件（相对于配置文件目录）
        "src"
    ],
    "exclude": [    // 要排除的文件/目录（正则表达式）
        "tests"
    ],
    "report": {     // 要生成的报告列表（html、json、csv或violation）
        "html": "/tmp/report/",             // HTML报告的目标目录
        "csv": "/tmp/report.csv",           // CSV报告的目标文件
        "json": "/tmp/report.json",         // JSON报告的目标文件
        "violations": "/tmp/violations.xml" // 违规检查报告的目标文件
    },
    "groups": [     // 代码分组（按正则表达式匹配类名，生成特定分组的HTML报告）
        {
            "name": "组件",      // 分组名称
            "match": "!component!i"   // 匹配分组的正则表达式（不区分大小写）
                                      // 注意JSON中转义：如需匹配"\MyPackage\"，需写成"!\\\\MyPackage\\\\!"
        },
        {
            "name": "示例",
            "match": "!example!"
        }
    ],
    "plugins": {
        "git": {
            "binary": "git"           // 启用Git分析（指定git可执行文件路径）
        },
        "junit": {
            "file": "/tmp/junit.xml"  // 启用JUnit报告分析（指定JUnit报告文件路径）
        }
    },
    "extensions": [ "php", "php8" ]   // 要分析的文件扩展名（默认：["php", "inc"]）
}

使用自定义配置运行

docker
docker run -v $(pwd):/app -v $(pwd)/phpmetrics.json:/config.json phpmetrics/phpmetrics --config=/config.json

• -v $(pwd)/phpmetrics.json:/config.json：将宿主机的配置文件挂载到容器内的/config.json。
• --config=/config.json：指定使用容器内的配置文件进行分析。

其他使用方式

PhpMetrics还支持全局安装（通过APT、Brew等包管理器），更多详细文档可访问官方文档。

指标列表

支持的详细指标可参考https://github.com/phpmetrics/PhpMetrics/blob/master/doc/metrics.md%EF%BC%8C%E5%8C%85%E6%8B%AC%E4%BB%A3%E7%A0%81%E5%A4%8D%E6%9D%82%E5%BA%A6%E3%80%81%E8%80%A6%E5%90%88%E5%BA%A6%E3%80%81%E7%BB%A7%E6%89%BF%E6%B7%B1%E5%BA%A6%E3%80%81%E4%BB%A3%E7%A0%81%E8%A1%8C%E7%BB%9F%E8%AE%A1%E7%AD%89%E3%80%82

许可证

PhpMetrics遵循https://github.com/phpmetrics/PhpMetrics/blob/master/LICENSE%E3%80%82