编写 composer Installer 插件需实现 InstallerInterface 并注册为 composer-plugin 类型,在 extra.installer-types 中声明支持的自定义 type,通过 supports()、isInstalled()、install()、update() 四方法控制安装逻辑,并在 PluginInterface::activate() 中绑定安装器。

编写 Composer Installer 插件需要实现 ComposerInstallerInstallerInterface,并注册为 Composer 的自定义安装器类型。核心在于告诉 Composer:当遇到特定 type 的包时,用你的逻辑来决定安装路径、是否启用脚本、如何处理源码等。
理解安装器类型与触发时机
Composer 通过 type 字段识别包类型(如 library、wordpress-plugin)。你写的插件需声明支持某个自定义 type(例如 my-framework-bundle),并在该类型包被安装/更新时介入。
- 插件本身是一个普通 Composer 包,
type必须是composer-plugin - 必须在
extra.installer-types中显式声明你支持的自定义类型(否则 Composer 会忽略) - Composer 在 install/update 阶段自动调用你的安装器,不依赖用户手动执行命令
实现 InstallerInterface 的关键方法
你的安装器类必须实现四个核心方法:
-
supports():返回true当且仅当传入的PackageInterface的getType()匹配你支持的类型(如my-app-extension) -
isInstalled():检查目标路径是否存在有效安装(通常判断vendor/{vendor}/{name}下是否有预期文件或标志) -
install():执行实际复制/软链/生成动作。使用$io输出提示,用$Filesystem安全操作路径(推荐copy()或relativeCopy()) -
update():先调用uninstall()再调用install(),或按需做增量更新(如只覆盖 changed 文件)
注意:install() 和 update() 中不要硬编码 vendor/ 路径,应通过 $package->getInstallationSource() 和 $composer->getConfig()->get('vendor-dir') 动态获取。
注册插件并绑定安装器
在插件主类中,通过 PluginInterface::activate() 获取 InstallerEvents 并注册你的安装器实例:
- 调用
$composer->getInstallationManager()->addInstaller($yourInstaller) - 确保你的安装器类已正确 autoload(在
composer.json的autoload中配置) - 在插件包的
composer.json中设置:"extra": {"class": "YourPluginMyInstallerPlugin"} - 若支持多类型,可在
supports()中用in_array($package->getType(), $this->supportedTypes)判断
调试与验证技巧
开发阶段避免反复 install/uninstall:
- 用
composer install --no-scripts --no-plugins跳过插件,快速验证基础依赖 - 在安装器方法中用
$io->writeError('[DEBUG] ...')输出调试信息(writeError确保可见) - 创建最小测试包:设
"type": "my-custom-type",require 你的插件,运行composer update观察行为 - 检查
vendor/composer/installed.json是否记录了你的包类型和安装路径
不复杂但容易忽略:Composer 缓存可能使修改后的插件不生效,可临时加 --no-cache 或删 vendor/composer/installed.json 后重试。