Composer怎么做包的目录结构_Composer包标准目录规范【进阶】

酷萱姑娘_2771

酷萱姑娘_2771

2026-05-23

725人浏览

原创

要让别人能 composer require 你的包,必须遵循 psr-4 规范并正确配置 autoload:src/ 必须存在且与命名空间严格匹配;tests/ 仅用于测试、不参与 autoload;bin/ 需在 composer.json 中显式声明;vendor/ 和 composer.lock 绝对不可提交。

composer怎么做包的目录结构_composer包标准目录规范【进阶】

想让别人能 composer require 你的包,目录结构本身没强制要求,但 Packagist 和主流项目只认 PSR-4 + 明确的 autoload 配置 —— 其他结构再漂亮,require 不进去就是废包。

src/ 必须存在,且必须和 autoload 的路径对得上

Composer 不扫描目录,它只按 composer.json 里写的 autoload 路径去加载类。如果你写 "MyVendor\Package\": "src/",那 src/ 就是硬性起点,里面必须有对应命名空间的子目录或文件。

  • 错误示例:src/Calculator.php 里声明 namespace MyVendorPackage;,但 autoload 写的是 "MyVendor\Package\": "src/" → 自动加载器会去找 src/Package/Calculator.php,找不到就报 Class not found
  • 正确做法:要么改命名空间为 MyVendor\Package,要么把 autoload 改成 "MyVendorPackage\": "src/"(注意结尾没反斜杠)
  • 别在 src/ 下混放配置、迁移、视图等非类文件 —— PSR-4 加载器会递归扫描整个目录,拖慢 autoload 性能

tests/ 是事实标准,但不参与 autoload

tests/ 目录本身不会被 Composer 加载,它的存在只是为了表明你写了测试,且方便 CI 工具(如 PHPUnit)自动发现用例。关键点在于:它不能出现在 autoload 或 autoload-dev 的路径里,除非你真想把测试类暴露给生产代码。

Discussion Composer
Discussion Composer

围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论(Discussion)”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性,以及撰写结论。当用户输入以下任一指令时也会自动触发该功能: - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par

下载
  • 如果你用了 autoload-dev,比如 "MyVendor\Package\Test\": "tests/",那 composer install --no-dev 时这些路径仍会被写入 autoloader,只是不装 dev 包 —— 这属于设计失误
  • 推荐写法:只在 autoload-dev 里加测试用的辅助类(如 tests/Support/TestCase.php),核心测试用例文件(tests/Unit/CalculatorTest.php)不进 autoload
  • CI 中跑测试前,确保 composer install(不带 --no-dev),否则 autoload-dev 规则不生效

bin/ 目录要显式声明,否则命令不可用

Composer 不会自动识别 bin/ 下的脚本。想让用户执行 mytool 命令,必须在 composer.json 里用 bin 字段明说:

"bin": ["bin/mytool"]
  • bin/mytool 文件必须有可执行权限(chmod +x bin/mytool),且首行是 #!/usr/bin/env php
  • 如果脚本依赖当前包的类,它得自己 require __DIR__.'/../vendor/autoload.php' —— Composer 不会自动注入
  • 别把 bin/ 放进 autoload,它不是 PHP 类,加载了也没用

vendor/ 和 composer.lock 绝对不能提交到你的包仓库

你的包是给别人 require 的,不是拿来直接运行的。提交 vendor/ 或 composer.lock 会导致两个问题:

  • 别人 composer require your/package 时,Composer 会忽略你锁文件里的版本,但会继承你 vendor/ 里已有的、可能冲突的依赖副本,引发难以复现的加载错误
  • Packagist 在抓取你的包时,会跳过 vendor/ 和 composer.lock,但若它们存在于 Git 仓库,CI 构建或本地开发时容易误用
  • 正确做法:在包的 .gitignore 里明确写上 /vendor 和 /composer.lock,CI 流水线也禁止上传这两个东西

最容易被忽略的一点:命名空间末尾的反斜杠要不要写,直接影响 PSR-4 解析逻辑。写 "MyVendor\Package\": "src/" 表示找 src/Package/ 下的类;写 "MyVendor\Package": "src/"(没反斜杠)表示找 src/ 下以 MyVendor\Package 开头的类 —— 这种写法极少用,且极易出错,别碰。

相关文章

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

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

下载

相关标签:

composer

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

相关专题

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

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

2023.12.25

324

5

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

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

2026.04.10

503

36

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

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

2026.04.10

287

29

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

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

2026.04.10

309

15

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

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

2026.04.13

260

21

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

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

2026.04.13

343

14

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

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

2026.04.14

191

24

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

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

2026.04.14

250

18

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

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

2026.04.14

300

26

热门下载

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

精品课程

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

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习