EventDispatcher— простой и эффективный способ сделать ваше приложение по-настоящему расширяемым

Transcript

1. EventDispatcher — простой и эффективный способ сделать ваше приложение по- настоящему расширяемым Semyon Velichko, freelancer, semyon@velichko.net
2. Содержание • Знакомство с теорией «Observer» • Где используется EventDispatcher и как взаимодействовать с ним, на примерах компонентов Symfony • Разница между Subscriber и Listener • Расширяем свой код через Subscriber • Listener в виде tagged service
3. Observer — это идея! Научить систему генерировать события и реагировать на них Расширять функционал без наследования и без непосредственной модификации кода
4. Как это выглядит? Генераторы событий Диспетчер событий Обработчик события Обработчик события Обработчик события
5. Как это можно применить? • Собрать журнал действий • Предоставить интерфейс расширения • Выделить часто используемый код • Остановить дальнейшую обработку события
6. Где уже используется? • ядре — kernel.* • генераторе форм — form.* • компоненте Security — security.* а также в: • knp-components • KnpMenuBundle • ExtDirectBundle
7. Уже хочу попробовать! $dispatcher = $this->container->get('event_dispatcher'); получили диспетчер $event = new GenericEvent($this); $dispatcher->dispatch('foo.action', $event); описали событие свершилось событие!
8. Создаем Listener и подключаем use Symfony\Component\EventDispatcher\Event; class AcmeListener { // ... public function onFooAction(Event $event) { // ... сделаем что-то } } $listener = new AcmeListener(); $this->container->dispatcher ->addListener('foo.action', array($listener, 'onFooAction')); call_user_func
9. А есть реальный пример? class ClientType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $subscriber = new AddLoginFieldSubscriber($builder- >getFormFactory()); $builder->addEventSubscriber($subscriber); $builder->add('email', 'email'); $builder->add('password', 'password'); // ... и другие поля } // ... } Есть! Динамическая форма! добавили немного магии
10. Разоблачение фокуса class AddLoginFieldSubscriber implements EventSubscriberInterface { private $factory; public function __construct(FormFactoryInterface $factory) { $this->factory = $factory; } получаем форму, нам с ней работать
11. Разоблачение фокуса class AddLoginFieldSubscriber implements EventSubscriberInterface { private $factory; public function __construct(FormFactoryInterface $factory) { $this->factory = $factory; } public static function getSubscribedEvents() { return array(FormEvents::PRE_SET_DATA => 'preSetData'); } когда будем запускать и кого
12. Разоблачение фокуса class AddLoginFieldSubscriber implements EventSubscriberInterface { private $factory; public function __construct(FormFactoryInterface $factory) { $this->factory = $factory; } public static function getSubscribedEvents() { return array(FormEvents::PRE_SET_DATA => 'preSetData'); } public function preSetData(FormEvent $event) { if (null === $event->getData()) return; if (!$event->getData()->getId()) $this->getForm() ->add($this->factory->createNamed('login', 'text')); } } У нового объекта нет id
13. Просили о вас заботиться Так как предыдущие слайды были перегружены кодом, этот для отдыха
14. Подключение к событию через tagged service К диспетчеру событий можно подключить свой сервис
15. Менеджер выдумал Записывать User-Agent всех входящих клиентов. На зло ему, для нас это просто и быстро! :)
16. Раз! class LogUserAgentListener { private $logger; public function __construct(Logger $logger) { $this->logger = $logger; } получили Monolog
17. Два! class LogUserAgentListener { private $logger; public function __construct(Logger $logger) { $this->logger = $logger; } public function onKernelRequest(GetResponseEvent $event) { $request = $event->getRequest(); $headers = $request->headers; if($headers->has('user-agent')) $this->logger->info($headers->get('user-agent')); } } Записываем всех входящих
18. Три! acme_demo.log_user_agent: class: Acme\DemoBundle\Event\Listener\LogUserAgentListener arguments: [@logger] tags: - {name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 100} Конфигурируем сервис:
19. Разница между Subscriber и Listener Subscriber: • множество событий • class Listener: • одно событие • is_callable
20. Lazy Load Service • Будет загружен только при необходимости • Поддерживается Listener и Subscriber
21. Listener в виде tagged service Хотим сделать подключение к событиям так как делает это kernel?
22. Нам нужен свой CompilerPass class CustomCompilerPass implements CompilerPassInterface { public function process(ContainerBuilder $container) { $eventDispatcher = $container->getDefinition('event_dispatcher'); взяли диспетчер
23. Нам нужен свой CompilerPass class CustomCompilerPass implements CompilerPassInterface { public function process(ContainerBuilder $container) { $eventDispatcher = $container->getDefinition('event_dispatcher'); foreach ($container->findTaggedServiceIds('acme.product.update') as $id => $attributes) { ищем нужные сервисы
24. Нам нужен свой CompilerPass class CustomCompilerPass implements CompilerPassInterface { public function process(ContainerBuilder $container) { $eventDispatcher = $container->getDefinition('event_dispatcher'); foreach ($container->findTaggedServiceIds('acme.product.update') as $id => $attributes) { // ... $eventDispatcher->addMethodCall('addListenerService', array($attributes['event'], array($id, $attributes['method']), $attributes['priority'])); } } } добавим найденные
25. Осталось только подключить! class AcmeDemoBundle extends Bundle { public function build(ContainerBuilder $container) { parent::build($container); $container->addCompilerPass(new CustomCompilerPass()); } } Больше кода не будет наш герой
26. Можете пользоваться! (с) Теперь ваш код может быть модифицирован так-же легко и быстро как и ядро symfony! P.S. Вспомним слайд №18:
27. Плюсы, минусы, подводные камни Обработка событий это: • быстро • функционально • просто
28. Плюсы, минусы, подводные камни Но при большом количестве обработчиков на одно событие: • усложнение логики • трудности в отладке Менеджер событий Обработчик Обработчик Обработчик
29. Некоторые ответы • http://symfony.com/doc/current/components/event_dispatcher/introduction.html • http://symfony.com/doc/current/cookbook/form/dynamic_form_generation.html • http://symfony.com/doc/current/components/dependency_injection/tags.html • https://github.com/symfony/EventDispatcher Вопросы?