自定义安装器生效需目标包声明"type"且插件正确注册;create-project不触发因仅处理源项目自身type;须分设插件包(type:composer-plugin)和目标包(type:your-custom-type),通过supports()匹配并install()执行逻辑。

Composer 自定义安装器不是靠“创建一个新包”就能生效的,而是必须让目标包在 composer.json 中声明 "type": "xxx",再通过插件注册对应安装逻辑——否则 Composer 根本不会调用你的安装器。
为什么 composer create-project 不触发自定义安装器?
因为 create-project 是克隆并安装源项目本身,它只运行该项目的 composer.json 中定义的 type 对应的安装器(如果有的话),而不是你本地开发的插件。真正触发自定义安装器的场景是:其他项目在 require 了你发布的、"type": "my-plugin-type" 的包之后执行 composer install 或 composer update。
- 自定义安装器本质是
Composer\Plugin\InstallerPluginInterface实现,必须打包为独立插件包(type: composer-plugin)并发布到 Packagist - 被安装的目标包(即你要特殊处理的那个包)必须设置
"type": "your-custom-type" - 插件包和目标包是两个分离的包,不能写在同一个
composer.json里
如何编写最小可用的自定义安装器类?
核心是继承 Composer\Installer\LibraryInstaller 并重写 supports() 和 install()(或 update())。不要直接实现 InstallerInterface——它太底层,容易漏掉依赖解析、事件通知等关键流程。
-
supports()必须返回true仅当$package->getType() === 'your-custom-type',否则会被跳过 -
install()中可通过$package->getExtra()读取包作者定义的配置项(如部署路径、模板变量) - 文件操作请始终使用
$this->vendorDir和$this->binDir等 Composer 提供的路径,而非硬编码vendor/ - 若需复制非源码文件(如配置模板、前端构建产物),建议在
post-install-cmd中处理,避免干扰标准安装流程
插件包的 composer.json 关键字段怎么写?
插件包自身必须声明为 composer-plugin 类型,并通过 extra.composer-plugin 指明主类路径。Composer 会自动加载该类并调用其 activate() 方法。
{
"name": "acme/my-custom-installer",
"type": "composer-plugin",
"autoload": {
"psr-4": {
"Acme\\Installer\\": "src/"
}
},
"require": {
"composer-plugin-api": "^2.0",
"composer/composer": "^2.0"
},
"extra": {
"class": "Acme\\Installer\\MyCustomInstallerPlugin"
}
}
-
composer-plugin-api版本必须与目标用户使用的 Composer 主版本对齐(v1 对应 Composer 1.x,v2 对应 2.x) -
require中引入composer/composer是为了静态分析和 IDE 支持,实际运行时不加载它的全部代码 - 插件类必须实现
Composer\Plugin\PluginInterface,并在activate()中调用$installer = new MyCustomInstaller(...)并注册进$composer->getInstallationManager()->addInstaller($installer)
目标包如何声明自己需要被你的安装器处理?
只需在它的 composer.json 里写死 "type": "my-custom-type"。Composer 安装时会遍历所有已激活插件的 supports() 方法,匹配成功后才调用对应安装逻辑。
{
"name": "acme/my-special-package",
"type": "my-custom-type",
"extra": {
"deploy-to": "public/modules"
}
}
- 这个
type值必须和插件中supports()判断的字符串完全一致(区分大小写) -
extra字段是唯一推荐的跨包传参方式;不要试图用scripts或环境变量传递路径等敏感信息 - 一旦
type匹配失败,Composer 会回退到默认的LibraryInstaller,把包放进vendor/acme/my-special-package/,但不会报错——这是最常被忽略的调试盲点
最容易卡住的地方是插件未被正确激活,或 supports() 返回了错误的布尔值。建议在插件类的 activate() 和安装器的 supports() 中加 error_log() 输出调试信息,并用 composer show --plugins 确认插件已加载。










