什么是Composer插件（Plugin）？如何开发一个？（高级教程）-composer-PHP中文网

什么是Composer插件（Plugin）？如何开发一个？（高级教程）

穿越時空

发布： 2025-12-17 15:40:21

原创

785人浏览过

Composer插件是通过实现PluginInterface并在activate()中订阅事件来扩展Composer行为的工具，本质为事件驱动+服务注册，需声明type为composer-plugin并指定入口类。

什么是composer插件（plugin）？如何开发一个？（高级教程）

Composer 插件是运行在 Composer 生命周期中、能修改其行为的 PHP 包，不是用来被项目 require 的功能库，而是用来扩展或干预 Composer 自身逻辑的工具 —— 比如自动加载优化、包下载前校验、安装后执行脚本、甚至重写依赖解析规则。

插件的本质：事件驱动 + 服务注册

Composer 插件不是靠“被调用”工作的，而是通过实现 ComposerPluginPluginInterface，并在 activate() 方法中向 Composer 的事件分发器（EventDispatcher）订阅事件，比如：

pre-autoload-dump：生成自动加载文件前
post-install-cmd 或 post-update-cmd：命令执行完成后
pre-package-install：某个包真正下载前（可取消/替换）
init：Composer 初始化时（适合注册自定义命令）

插件本身必须声明为 "type": "composer-plugin"，并设置 "extra": {"class": "Your\Plugin\Class"} 指明入口类。Composer 会扫描已安装的包，自动激活所有符合规范的插件。

开发一个最小可用插件

假设你想在每次 composer install 后打印一行带时间戳的提示：

新建目录 my-company/composer-timestamp-plugin
写 src/TimestampPlugin.php：

namespace MyCompanyComposer;

use ComposerComposer;
use ComposerIOIOInterface;
use ComposerPluginPluginInterface;
use ComposerEventDispatcherEventSubscriberInterface;
use ComposerScriptScriptEvents;

class TimestampPlugin implements PluginInterface, EventSubscriberInterface
{
    private $io;

    public function activate(Composer $composer, IOInterface $io)
    {
        $this->io = $io;
    }

    public static function getSubscribedEvents()
    {
        return [
            ScriptEvents::POST_INSTALL_CMD => 'onPostInstall',
            ScriptEvents::POST_UPDATE_CMD   => 'onPostUpdate',
        ];
    }

    public function onPostInstall()
    {
        $this->io->write("✅ Install completed at " . date('Y-m-d H:i:s'));
    }

    public function onPostUpdate()
    {
        $this->io->write("? Update completed at " . date('Y-m-d H:i:s'));
    }
}

登录后复制

再写 composer.json：

{
  "name": "my-company/composer-timestamp-plugin",
  "type": "composer-plugin",
  "autoload": {
    "psr-4": { "MyCompany\Composer\": "src/" }
  },
  "require": {
    "composer-plugin-api": "^2.0"
  },
  "extra": {
    "class": "MyCompany\Composer\TimestampPlugin"
  }
}

登录后复制

然后在目标项目中运行：composer require my-company/composer-timestamp-plugin --dev，插件即生效。

php中级教程之ajax技术

AJAX即“Asynchronous Javascript And XML”（异步JavaScript和XML），是指一种创建交互式网页应用的网页开发技术。它不是新的编程语言，而是一种使用现有标准的新方法，最大的优点是在不重新加载整个页面的情况下，可以与服务器交换数据并更新部分网页内容，不需要任何浏览器插件，但需要用户允许JavaScript在浏览器上执行。《php中级教程之ajax技术》带你快速

2114

查看详情

进阶能力：操作包、修改下载行为、注入命令

真正强大的插件往往不止监听事件，还会主动介入核心流程：

通过 $composer->getPackage() 获取当前项目根包，读写 extra 配置
监听 pre-package-install 事件，调用 $event->setOperation(new NullOperation()) 可跳过安装某个包
使用 $composer->getInstallationManager()->addInstaller() 注册自定义安装器（如支持 `.zip` 发布包或私有协议）
在 activate() 中调用 $composer->getCommandLoader()->addCommand(...) 注入新命令（需继承 SymfonyComponentConsoleCommandCommand）