composer如何处理依赖包中的二进制文件

16次阅读

Composer通过读取依赖包composer.json中的bin配置项，在vendor/bin目录下创建符号链接或脚本，使二进制工具可执行；跨平台兼容且集中管理，但需将vendor/bin加入PATH才能全局调用，非PHP二进制文件需确保运行环境支持。

Composer在处理依赖包中的二进制文件时，主要通过在项目的vendor/bin目录下创建符号链接（或Windows上的.bat/.cmd脚本）来解决。这使得开发者能够方便地调用这些工具，而无需关心它们在依赖包内部的实际位置，从而提供了一个统一、便捷的执行入口。

Composer对于依赖包中的二进制文件的处理，其实比我们想象的要精巧，也带有一些约定俗成的智慧。它并非简单地把所有可执行文件一股脑地复制过来，而是采取了一种更优雅、更具管理性的方式。

当你定义了一个依赖，并且这个依赖包（比如phpunit/phpunit或者symfony/console组件）内部包含了一些可执行脚本或程序，Composer会查找这些包的composer.json文件中的bin配置项。这个bin配置项通常是一个字符串或一个字符串数组，指向了包内那些我们希望能够直接运行的脚本路径。

例如，一个包的composer.json可能有这样的配置：

{     "name": "vendor/package",     "bin": ["bin/my-tool", "bin/another-script.php"] }

当Composer安装这个包时，它会读取这个bin配置。然后，它会在你项目根目录下的vendor/bin目录中，为这些指定的二进制文件创建符号链接（在Linux/macOS上是软链接，在Windows上是.bat或.bat1脚本）。这意味着，你不需要去记住.bat2这样冗长的路径，只需要在命令行中直接运行.bat3就可以了。

这种做法的好处显而易见：

集中管理： 所有的项目级二进制工具都集中在vendor/bin下，一目了然。
路径简化： 避免了手动添加各种工具路径到.bat5环境变量的麻烦。
跨平台兼容： Composer会根据操作系统自动生成合适的执行脚本，比如在Windows上生成.bat文件，确保了跨平台的可用性。
版本隔离： 每个项目都可以有自己特定版本的二进制工具，互不干扰。

但这里也有个小“坑”或者说需要注意的地方：如果你想直接在终端里敲.bat7而不是.bat3，你就需要手动把vendor/bin这个路径添加到你的系统.bat5环境变量中。这其实是个很常见的实践，尤其是对于那些经常需要使用项目级工具的开发者来说，比如Laravel的phpunit/phpunit1命令，或者PHPUnit的phpunit/phpunit2命令。

如何让Composer依赖的二进制工具在命令行中全局可用？

让Composer安装的二进制工具在命令行中全局可用，主要是围绕着.bat5环境变量做文章。这其实是操作系统层面的一个约定，当你在命令行输入一个命令时，系统会按照.bat5环境变量里列出的目录顺序去查找这个命令对应的可执行文件。

最直接也是最推荐的做法，就是把你的项目根目录下的vendor/bin路径添加到你的系统.bat5环境变量中。

在类Unix系统（Linux/macOS）上： 你可以编辑你的shell配置文件，比如phpunit/phpunit7, phpunit/phpunit8, 或者phpunit/phpunit9。在文件末尾添加一行：

export PATH="./vendor/bin:$PATH"

这里symfony/console0前面的symfony/console1很重要，它表示当前目录下的vendor/bin。这样，当你symfony/console3到一个项目目录时，symfony/console0就会被解析为当前项目的vendor/bin路径。保存文件后，运行symfony/console6（或你对应的配置文件）来使改动生效。

在Windows系统上： 过程稍微图形化一些，但原理一样。

右键点击“此电脑”或“我的电脑” -youjiankuohaophpcn “属性” -> “高级系统设置” -> “环境变量”。
在“系统变量”或“用户变量”中找到symfony/console7变量，点击“编辑”。
点击“新建”，然后添加你的项目symfony/console8的完整路径。为了方便，通常我们会添加一个通用的路径，比如symfony/console9，但对于项目级别的工具，直接在项目内操作更常见。更实用的做法是，如果你经常在某个特定项目下工作，可以针对那个项目将composer.json0加入.bat5。或者，如果你有多个项目，并且希望这些项目各自的vendor/bin都能被识别，那就需要更复杂的脚本来动态管理.bat5。不过，大多数时候，我们只是在项目目录下运行命令，所以composer.json4这种相对路径的方式更为常用和便捷。当然，你也可以考虑使用Composer的全局安装功能来安装一些常用的工具，例如composer.json5。这样，这些工具会被安装到Composer的全局vendor/bin目录（通常在composer.json7或symfony/console9），只要这个全局路径被添加到了.bat5，这些工具就真的可以在任何地方直接调用了。

这两种方法，都是为了让系统在寻找可执行文件时，能“看”到vendor/bin这个目录。一旦配置好，你就可以直接在项目目录下运行像phpunit/phpunit2、phpunit/phpunit1这样的命令了。

Composer的`bin`配置项有哪些常见问题和最佳实践？

bin配置项看似简单，但在实际使用中也可能遇到一些小麻烦，或者说，有一些值得遵循的最佳实践。

依图语音开放平台

6

查看详情

常见问题：

路径错误： 最常见的错误就是bin配置项中指定的路径不正确，导致Composer找不到对应的可执行文件。这通常是打字错误或者对包内部结构理解有误。检查包的实际文件结构是解决这类问题的关键。
文件权限： 在类Unix系统上，如果二进制文件没有可执行权限（bin6），即使符号链接创建了，也无法直接运行。Composer通常会尝试给这些文件添加执行权限，但如果源文件本身权限有问题，可能仍需手动bin7。
Windows上的.bat或.bat1文件不工作： 有时，Composer生成的Windows批处理文件可能因为路径中的特殊字符或编码问题而无法正常执行。虽然不常见，但如果遇到，可以尝试手动检查生成的.bat文件内容。
vendor/bin冲突： 不同的依赖包可能尝试提供同名的二进制文件。Composer通常会优先处理第一个遇到的，或者在某些情况下会抛出警告。这种情况下，你可能需要重命名其中一个，或者通过别名来区分。

最佳实践：

明确指定相对路径： 在composer.json的bin配置中，始终使用相对于包根目录的路径。例如，bin4而不是bin5。这能确保在任何安装环境下都能正确找到文件。
保持bin目录简洁： 尽量只将真正需要直接执行的脚本放在bin目录下。避免将辅助性脚本或库文件也放进去，这会使vendor/bin目录变得混乱。
提供跨平台支持： 如果你的工具涉及到脚本语言（如PHP、Python），确保脚本本身在不同操作系统上都能运行。对于需要系统特定二进制文件的工具，考虑提供不同平台的版本，并通过Composer的bin9字段或其他机制来处理。例如，一个PHP脚本通常在Windows和Linux上都能运行，但如果是一个编译的二进制文件，就需要提供对应的Windows composer.json0和Linux ELF文件。
文档清晰： 作为包的维护者，在你的包文档中清晰地说明哪些二进制工具可用，以及它们的使用方法，这对用户来说至关重要。
考虑全局安装与项目安装： 对于那些希望在多个项目中使用，或者作为开发环境工具的二进制文件，可以建议用户使用composer.json1进行全局安装。而对于项目特有的工具，则应作为普通依赖安装。

通过遵循这些实践，可以最大程度地减少因二进制文件处理不当而引发的问题，让整个开发流程更加顺畅。

Composer在处理非PHP二进制文件时有哪些特殊考量？

虽然Composer主要是PHP的包管理器，但它处理二进制文件的机制并非只局限于PHP脚本。事实上，只要是可执行文件，无论是编译型程序（如Go、Rust编写的CLI工具）、Python脚本、Bash脚本，甚至是Node.js脚本，Composer都能通过bin配置项进行管理。

这里的“特殊考量”主要体现在几个方面：

执行环境的依赖：
- PHP脚本： Composer生成的符号链接或.bat文件，通常会直接调用composer.json4解释器来执行脚本（例如composer.json5）。这意味着你的系统需要有PHP环境。
- Python/Node.js/Ruby脚本： 如果你依赖包中的二进制文件是这些语言的脚本，那么用户的系统就必须安装对应的解释器。Composer本身不会去安装这些解释器，它只负责创建指向脚本的链接。
- 编译型二进制文件： 对于Go、Rust等编译出的可执行文件，它们通常是自包含的，不依赖外部解释器。但它们可能依赖特定的系统库（如composer.json6在Linux上），或者需要与操作系统的ABI（application Binary Interface）兼容。
跨平台兼容性：
- 脚本语言： 大多数脚本语言（PHP、Python、Node.js）的脚本本身是跨平台的，只要有对应的解释器，就能在不同操作系统上运行。Composer生成的.bat和shell脚本也会尝试兼容。
- 编译型二进制文件： 这是最复杂的情况。一个针对Linux编译的二进制文件不能直接在Windows或macOS上运行。一个健壮的包，如果包含编译型二进制文件，通常需要为不同的操作系统和CPU架构提供不同的版本。
  - 解决方案： 包的作者通常会在其composer.json的bin9字段中定义一些自定义逻辑，或者使用bin0、bin1等钩子，在安装过程中检测操作系统和架构，然后下载或解压对应的二进制文件到正确的位置，并将其添加到bin配置项中。例如，bin3这个包就使用这种方式来处理bin4或bin5。
  - Composer的局限： Composer本身并没有内置的机制来自动选择不同平台下的二进制文件。这需要包的作者自行实现，通常通过PHP脚本在Composer钩子中完成。
文件权限和执行方式：
- 在类Unix系统上，所有可执行文件都需要有执行权限。Composer会尝试设置，但如果包的源文件权限不对，仍可能出问题。
- 在Windows上，composer.json0文件可以直接运行，而脚本文件通常需要通过其解释器来调用（例如bin7）。Composer生成的.bat文件会处理好这一点。