什么是Composer的 "pre-file-download" 事件_在下载包文件前执行自定义操作的Composer钩子-composer-PHP中文网

什么是Composer的 "pre-file-download" 事件_在下载包文件前执行自定义操作的Composer钩子

裘德小鎮的故事

发布： 2025-12-01 16:15:06

原创

133人浏览过

pre-file-download事件在Composer下载包文件前触发，可用于修改请求头、添加认证、替换镜像源或记录日志；通过composer.json的scripts配置或插件实现监听，典型场景包括为私有仓库添加Token、使用内部代理或监控下载行为；该事件作用于RemoteFilesystem实例，不影响元数据解析，适用于企业级定制需求。

$什么是composer的 \$

Composer 的 "pre-file-download" 事件是一个钩子（Hook），它在 Composer 下载任何包文件（如 ZIP、TAR 等压缩包）之前触发。你可以利用这个事件执行自定义逻辑，比如修改下载地址、设置代理、添加认证头、记录日志，甚至替换源。

作用场景

这个事件的主要用途是让你在实际发起 HTTP 请求下载包前，对请求进行干预或调整。常见使用包括：

为私有仓库添加身份认证信息（如 Bearer Token 或 Basic Auth）
将默认的 GitHub 下载链接替换为内部镜像源
通过企业代理配置自定义 HTTP 头或客户端选项
监控和记录所有包的下载行为

如何使用 pre-file-download

你需要注册一个事件监听器，通常在项目的 composer.json 中通过脚本（scripts）配置，或者在自定义插件中实现。

示例：在 composer.json 中注册一个类来监听该事件：

Word-As-Image for Semantic Typography

文字变形艺术字、文字变形象形字

查看详情

{
    "scripts": {
        "pre-file-download": "MyDownloader::onPreFileDownload"
    }
}

登录后复制

对应的 PHP 类需要实现静态方法：

MyDownloader.php

<?php
class MyDownloader
{
    public static function onPreFileDownload($event)
    {
        $downloadManager = $event->getComposer()->getDownloadManager();
        $httpDownloader = $downloadManager->getDownloader('http');

        // 修改 HTTP 请求选项，例如添加 Header
        $httpDownloader->addOption('headers', ['Authorization: token YOUR_TOKEN']);
    }
}

登录后复制

如果你开发的是 Composer 插件，可以通过订阅 PreFileDownloadEvent 来更精细地控制每个下载请求：

use Composer\Installer\PackageEvent;
use Composer\Plugin\PluginInterface;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\Util\RemoteFilesystem;

class CustomDownloadPlugin implements PluginInterface, EventSubscriberInterface
{
    public function activate(Composer $composer, IO $io)
    {
        // 注册事件监听
    }

    public static function getSubscribedEvents()
    {
        return ['pre-file-download' => 'onPreFileDownload'];
    }

    public function onPreFileDownload(\Composer\Script\Event $event)
    {
        $request = $event->getContext(); // 获取当前 RemoteFilesystem 实例
        if ($request instanceof RemoteFilesystem) {
            $request->addOptions(['headers' => ['User-Agent: MyCompany-Proxy']]);
        }
    }
}

登录后复制