Composer 的结构详解

Posted 2023-03-17

参考技术A

根目录包就是在你的项目的根目录由 composer.json 定义的包。主要就是由 composer.json 来定义你的项目的依赖。
某些字段只能在根目录包的中使用，比如 config 字段，只有根目录包能定义自己的配置。依赖包中的 config 字段是被忽略的。所以 config 字段是 root-only 的。
如果你克隆了其中一个依赖包并在上面工作，那么这个包就是根目录包。composer.json 还是一样的，但上下文不同。
（注：一个包是不是根目录包，取决于上下文。）

依赖包的映射表，由包名映射版本约束。如：

除非这些依赖已经存在，否则这个包不会被安装。

在使用 install 命令时，只有带上 “–dev” 参数才能安装 dev 包。在使用 update 命令时，带上 “–no-dev” 则不更新。

它们将不被允许和你的包一起安装。如果约束了版本，则只会针对特定的版本。

这个对公共接口最有用，一个包可以依赖一个虚拟的 logger 包，而实现 logger 接口的库可以放到 provide 字段中。

这些信息只在包安装完成时给出，暗示用户可以添加更多包，虽然不是必须要安装的。
格式是，包名映射文字说明，如：

提供给 php autoloader 的自动加载映射。
目前支持的有：PSR-0 自动加载规范，classmap 生成器，还有 files。
PSR-0 是比较推荐的，因为它的优秀的扩展性（在添加新的类的适合，不需要重新生成自动加载器）。
PSR-0
在 psr-0 键名下，定义一个命名空间到路径的映射表，相对于包的根目录。注意，这也同样支持 PEAR-style 的没有命名空间的风格。
请注意命名空间的声明得以 \\ 结尾，确保自动加载器正确响应。
PSR-0 的引用可以在安装或更新时生成的文件中查看：
vendor/composer/autoload_namespaces.php
例子：

如果你需要在多个目录里查找同一个前缀的命名空间，你可以用数组，如：

PSR-0 风格并不局限于加载命名空间的声明的东西，也可以用于类这个层级。当库中只有一个在全局命名空间中的类时，这种方式就能用上。比如你有个 PHP 源文件放在项目的根目录，你可以这样声明：

如果你有个目录下全是用命名空间组织的，你可以用空前缀：

（2）Classmap

classmap 的引用可以在安装或更新时生成的文件中查看：
vendor/composer/autoload_classmap.php
类映射表是通过扫描指定的目录或文件下的所有的 .php 和 .inc 文件生成的。
你可以给任何不支持 PSR-0 的库用 classmap 生成器实现自动加载。配置上只要指定类所在的目录或文件即可：

（3）files

如果你确定需要在任何请求中都加载某些文件，你可以使用 files 自动加载机制。对于那些包中有些 PHP 函数但不能自动加载时特别有用。例如：

（将被弃用，它的功能由 autoload 代替。其实就是设置 include_path，可选）

指定安装目标路径。

如果包的根目录是在命名空间下，自动加载就不正确了，所以才有 target-dir 来解决这个问题。

Symfony 就是个例子。它由很多组件包组成。Yaml 组件是在

Symfony\\Component\\Yaml
命名空间下的，它的根目录是 Yaml 目录。要让自动加载正常工作，我们要确保它不是安装在
vendor/symfony/yaml
，而是在
vendor/symfony/yaml/Symfony/Component/Yaml
，这样自动加载器才能从 vendor/symfony/yaml 加载它。
所以要定义 target-dir 如下：

定义根据稳定性如何过滤包。默认是 stable，如果你信赖一个 dev 包，你需要指明。

如果开启，Composer 会在稳定包和不稳定包中选择前者。

定制包的仓库地址。

默认的，Composer 只使用 Packagist 仓库。通过指定仓库地址，你可以从任何地方获取包。

仓库不能递归。你只能将它们添加到主的 composer.json 中。所依赖包中 composer.json 文件中的仓库定义是被忽略的。

支持的仓库的类型有：

完整的例子：

这篇看下来，再看 Symfony 的标准版中的 composer.json，应该了然了吧。