Composer怎么导出依赖树结构 Composer架构文档自动生成

大丽姑娘_5262

大丽姑娘_5262

2026-05-15

272人浏览

原创

composer show --tree 输出缩进式文本树结构,顶层包顶格、子依赖逐级缩进两格,仅适合人工查看依赖路径,不包含版本约束、dev 包及来源类型,无法用于自动化处理。

composer怎么导出依赖树结构 composer架构文档自动生成

composer show --tree 输出的是什么结构

它输出的是缩进式文本树,层级靠空格缩进体现,不是 JSON 或 XML 这类可解析格式。顶层包顶格,被依赖的包缩进两格,再下一层缩进四格,以此类推。这种结构适合人眼快速判断「谁依赖了谁」,但无法直接用于自动化处理或生成架构文档。

常见错误是把 composer show --tree 的输出当完整依赖图——它默认跳过 require-dev 中的包(比如 phpunit/phpunit),也不会显示版本约束(如 ^2.0)或来源类型(dist 还是 source)。如果你在写 CI 脚本或生成文档,仅靠这个命令会漏掉关键信息。

使用场景很明确:临时查某包是否被引入、快速定位循环依赖、给同事发个截图说明依赖路径。不适合存档、审计或集成到文档生成流水线。

如何导出带版本号的扁平依赖列表(用于 Markdown 文档)

用 composer show --format=json + jq 提取最稳。它读的是 vendor/ 实际安装状态,字段固定、无 ANSI 控制符、不随终端宽度截断。

  • composer show --format=json | jq -r '.packages[] | "\(.name) \(.version)"' | sort > deps.md —— 生成带版本的有序列表,适合粘贴进 README
  • 要排除开发依赖,加 --no-dev 参数:composer show --no-dev --format=json | jq -r ...
  • 如果没装 jq,macOS 可用 brew install jq,Linux 用 apt install jq,Windows 建议用 WSL;别用 cut -d' ' -f1,2 硬切,包名含空格时会崩
  • 注意 .version 字段可能是 dev-main 或 2.10.0,都保留,这是真实安装状态

为什么不能直接用 composer.lock 生成架构图

composer.lock 是权威快照,但它本身不描述依赖关系拓扑。它的 packages 数组是扁平的,没有父子指向;依赖链藏在每个包的 require 字段里,但那是声明式约束,不是运行时实际加载路径。

Workflow Decomposer
Workflow Decomposer

工作流任务拆解与模型编排技能。使用场景:(1) 收到复杂工作任务需要拆解为可执行步骤,(2) 需要为不同步骤选择最合适的模型,(3) 需要跟踪工作流进度和模型使用情况,(4) 长时间任务卡住需要问题诊断和解决方案。

下载

想自动生成架构图(比如 Mermaid 或 PlantUML),必须做两件事:

  • 先用 composer show --tree 或 composer show --format=json --all 获取实际安装的包及其层级
  • 再用脚本递归解析每个包的 require 列表,补全缺失的间接依赖(比如 A → B → C,但 C 没出现在 packages 里,说明被跳过了)
  • 旧版 Composer(--locked 参数,直接读 composer.lock 可能和 vendor/ 状态不一致;务必先确认 vendor/ 存在且完整

导出生产环境专用 BOM(安全审计用)

安全团队要的不是「哪些包装了」,而是「哪些包在运行时被加载、来自哪里、有无已知漏洞」。这时候 composer show --no-dev --format=json 是起点,但不够。

真正合规的 BOM 必须包含许可证、源类型、安装路径、哈希值——这些 composer show 不提供,得从 composer.lock 提取:

  • 用 jq 提取生产包:jq -r '.packages[] | select(.type != "project") | "\(.name) \(.version) \(.source.type // .dist.type) \(.license // "unknown")"' composer.lock
  • 必须同时记录 content-hash 和 hash 字段,它们是 lock 文件完整性校验依据
  • 别用 composer install --no-dev --dry-run 模拟,那只是预估行为,不反映真实 vendor/ 状态
  • 如果项目用了私有 repo 或 platform config,export --without-dev(Composer 2.4+)比手动过滤更可靠,它会重建依赖图并剔除所有 dev-only 子树

最容易被忽略的是:composer show 显示的是「已安装」,composer.lock 记录的是「应安装」,两者在 CI 环境中可能不一致——导出前务必确认 composer install 已成功执行且 vendor/ 完整。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

344

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

563

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

327

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

369

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

320

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

483

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

271

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

350

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

380

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习