详解EventDispatcher事件分发组件

EventDispatcher是一个常用的事件分发组件，可以在多处地方监听和触发自定义事件。在使用过程中，需要先引入该组件，并进行初始化。

引入EventDispatcher

EventDispatcher是Symfony框架中的一个组件，我们可以通过composer进行安装引入：

composer require symfony/event-dispatcher

为便于使用，建议将其封装为一个组件或配置，供其他地方直接调用。

初始化EventDispatcher对象

我们可以使用Symfony\Component\EventDispatcher\EventDispatcher这个类创建一个事件分发器对象，并可以在初始化时添加需要监听的事件及其触发的回调函数。

use Symfony\Component\EventDispatcher\EventDispatcher;

$dispatcher = new EventDispatcher();
$dispatcher->addListener('event1', function (Event $event) {
    // 处理事件1
});

上面的代码中，我们定义了一个叫做event1的事件，并为它注册了一个回调函数。当事件被触发时，该回调函数就会被执行。

触发事件

在需要触发事件的地方，我们可以使用Symfony\Component\EventDispatcher\EventDispatcherInterface::dispatch()方法进行事件的触发。这个方法的第一个参数是事件名，第二个参数为可选的事件对象，可以在回调函数中获取关于事件的信息。该方法会按照事件名，依次执行注册的回调函数，并依次传入事件对象作为回调函数的参数。

use Symfony\Component\EventDispatcher\Event;

class MyEvent extends Event
{
    // 自定义事件需要继承Event类
}

$event = new MyEvent();
$dispatcher->dispatch('event1', $event);

上述代码中，我们创建了一个名为MyEvent的自定义事件，并通过 $dispatcher->dispatch('event1', $event) 触发了名为event1的事件，同时将自定义事件对象传入。此时，注册在该事件上的回调函数被依次执行，传入的事件对象则作为它的参数传入。

示例1：文件上传监听

假设我们在用户上传文件的时候，需要进行一些文件处理（如：文件去重），同时在文件处理完成后，需要触发一个完成事件，以便进行后续的处理。此时，我们可以使用EventDispatcher组件来进行监听和事件触发操作。

use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\Event;

class FileUploader
{
    private $dispatcher;

    public function __construct(EventDispatcher $dispatcher)
    {
        $this->dispatcher = $dispatcher;
    }

    public function upload($file)
    {
        // 文件上传操作
        $targetFile = // $file重命名后的目标文件名

        // 发起"before_upload"事件
        $beforeEvent = new Event();
        $this->dispatcher->dispatch('before_upload', $beforeEvent);

        // 进行文件处理操作
        // ......（省略）......

        // 发起"after_upload"事件
        $afterEvent = new Event(['filename' => $targetFile]);
        $this->dispatcher->dispatch('after_upload', $afterEvent);
    }
}

$dispatcher = new EventDispatcher();

// 添加"before_upload"事件监听器
$dispatcher->addListener('before_upload', function (Event $event) {
    // 文件上传前的业务操作
});

// 添加"after_upload"事件监听器
$dispatcher->addListener('after_upload', function (Event $event) {
    $filename = $event->getData('filename');
    // 文件上传后的业务操作
});

上述代码中，我们通过EventDispatcher来监听了两个事件：before_upload和after_upload。当我们调用FileUploader的upload方法时，它会依次发起这两个事件，并在事件中进行相应的处理。注意，before_upload事件中没有传入任何事件对象，而在after_upload事件中传入了一个包含文件名信息的事件对象。

示例2：MP3转码监听

假设我们在转码MP3时需要进行一些优化处理（如：根据文件格式进行不同的处理），同时在转码完成后，需要触发一个完成事件。我们仍旧可以使用EventDispatcher组件实现该功能。

use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\Event;

class Mp3Transcoder
{
    private $dispatcher;

    public function __construct(EventDispatcher $dispatcher)
    {
        $this->dispatcher = $dispatcher;
    }

    public function transcode($filename)
    {
        // 进行文件格式优化处理
        $optimizedFile = // 优化后的文件

        // 模拟MP3转码操作
        $targetFile = // $filename转码后的文件名

        // 发起"transcode_complete"事件
        $event = new Event(['filename' => $targetFile, 'optimized' => $optimizedFile]);
        $this->dispatcher->dispatch('transcode_complete', $event);
    }
}

$dispatcher = new EventDispatcher();

// 添加"transcode_complete"事件监听器
$dispatcher->addListener('transcode_complete', function (Event $event) {
    $filename = $event->getData('filename');
    $optimized = $event->getData('optimized');

    // 将优化后的文件与转码文件拼接（以省略）......
});

$transcoder = new Mp3Transcoder($dispatcher);
$transcoder->transcode('my_file.mp3');

上述代码中，我们通过EventDispatcher来监听了transcode_complete事件。当我们调用Mp3Transcoder的transcode方法时，它会发起该事件，并在事件处理函数中进行相应的处理。注意，事件中同时传入了转码文件名和优化后的文件名等信息。上述代码是一个简化版的演示，实际情况中，我们还需要根据不同的文件格式进行特定的处理。