事件和事件监听器
编辑该页面事件和事件监听器
Symfony应用程序执行期间,大量的触发事件通知。ob娱乐下载您的应用程序可以听这些通知和应对他们通过执行任何代码。
ob娱乐下载Symfony触发几个事件相关的内核在处理HTTP请求。第三方包也可能分派事件,你甚至可以派遣自定义事件从您自己的代码。
本文中所示的示例使用相同KernelEvents:异常事件的一致性的目的。在您自己的应用程序中,您可以使用任何事件,甚至混合其中几个在同一用户。
创建一个事件监听器
听一个事件最常见的方法是注册一个事件监听器:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36
/ / src / EventListener / ExceptionListener.php名称空间应用程序\EventListener;使用ob娱乐下载\组件\HttpFoundation\响应;使用ob娱乐下载\组件\HttpKernel\事件\ExceptionEvent;使用ob娱乐下载\组件\HttpKernel\异常\HttpExceptionInterface;类ExceptionListener{公共函数__invoke(ExceptionEvent美元事件):无效{/ /得到的异常对象接收到的事件美元异常=美元事件- >getThrowable ();美元消息= sprintf (我的错误说:% s代码:% s的,美元异常- >getMessage (),美元异常- >getCode ());/ /定制响应对象显示异常的细节美元响应=新反应();美元响应- >setContent (美元消息);/ / HttpExceptionInterface是一种特殊类型的异常/ /保存状态代码和头的细节如果(美元异常运算符HttpExceptionInterface) {美元响应- >setStatusCode (美元异常- >getStatusCode ());美元响应- >头- >替换(美元异常- >getHeaders ());}其他的{美元响应- >setStatusCode(响应::HTTP_INTERNAL_SERVER_ERROR);}/ /发送修改后的响应对象的事件美元事件- >setResponse (美元响应);}}现在创建了类,你需要注册一个服务并通知Symfony,它是一个事件监听器通过使用一个特殊的“标签”:ob娱乐下载
- YAML
- XML
- PHP
1 2 3 4
#配置/ services.yaml服务:App \ EventListener \ ExceptionListener:标签:(kernel.event_listener)ob娱乐下载Symfony遵循这种逻辑来确定调用哪个方法内的事件侦听器类:
- 如果
kernel.event_listener标签定义了方法属性,将被调用的方法的名称; - 如果没有
方法定义属性,尝试调用__invoke ()魔术方法(这使得事件监听器调用); - 如果
__invoke ()方法也不是定义,抛出一个异常。
请注意
有一个可选属性kernel.event_listener标签被称为优先级,这是一个积极或消极的整数,默认0和它控制的顺序执行侦听器(数字越高,越早一个侦听器执行)。这是有用的,当你需要保证一个侦听器之前执行另一个。内部的优先级Symfony听众通常范围从ob娱乐下载-256年来256年但自己的听众可以使用任何积极或消极的整数。
请注意
有一个可选属性kernel.event_listener标签被称为事件当侦听器是有用的美元的事件参数是不输入。如果您配置它,它会改变的美元的事件对象。为kernel.exception事件,ExceptionEvent。检查ob娱乐下载Symfony事件参考每个事件提供什么类型的对象。
这个属性,Symfony遵循这种逻辑来确定ob娱乐下载调用哪个方法内的事件侦听器类:
- 如果
kernel.event_listener标签定义了方法属性,将被调用的方法的名称; - 如果没有
方法定义属性,尝试调用的方法的名称在+“PascalCased事件名称”(如。onKernelException ()方法kernel.exception事件); - 如果没有定义方法,试图调用
__invoke ()魔术方法(这使得事件监听器调用); - 如果
__invoke ()方法也不是定义,抛出一个异常。
定义事件侦听器使用PHP属性
另一种方法来定义一个事件侦听器是使用AsEventListenerPHP属性。这使得配置监听器在它的类,而无需添加任何配置在外部文件:
1 2 3 4 5 6 7 8 9 10 11 12
名称空间应用程序\EventListener;使用ob娱乐下载\组件\EventDispatcher\属性\AsEventListener;# (AsEventListener)最后类MyListener{公共函数__invoke(CustomEvent美元事件):无效{/ /……}}您可以添加多个# (AsEventListener ())属性来配置不同的方法:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24
名称空间应用程序\EventListener;使用ob娱乐下载\组件\EventDispatcher\属性\AsEventListener;# (AsEventListener(事件:CustomEvent::类,方法:onCustomEvent))#【AsEventListener(事件:“foo”,优先级:42))#【AsEventListener(事件:“酒吧”,方法:onBarEvent))最后类MyMultiListener{公共函数onCustomEvent(CustomEvent美元事件):无效{/ /……}公共函数onFoo():无效{/ /……}公共函数onBarEvent():无效{/ /……}}创建一个事件订阅者
听事件的另一种方法是通过一个事件订阅者,这是一个类,它定义了一个或多个方法,听一个或各种事件。事件监听器的主要区别是,用户总是知道他们听的事件。
如果不同的事件订阅者的方法听同样的事件,它们被定义的顺序优先级参数。这个值是默认为一个积极的还是消极的整数0。数越高,越早的方法。首要任务是聚合所有听众和订阅者,所以你的方法可以调用之前或之后在其他听众和用户定义的方法。了解更多关于事件订阅者,阅读EventDispatcher组件。
下面的示例显示了一个事件订阅者,定义了一些方法,听一样的kernel.exception事件:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36
/ / src / EventSubscriber / ExceptionSubscriber.php名称空间应用程序\EventSubscriber;使用ob娱乐下载\组件\EventDispatcher\EventSubscriberInterface;使用ob娱乐下载\组件\HttpKernel\事件\ExceptionEvent;使用ob娱乐下载\组件\HttpKernel\KernelEvents;类ExceptionSubscriber实现了EventSubscriberInterface{公共静态函数getSubscribedEvents(){/ /返回订阅事件,他们的方法和重点返回[KernelEvents::异常= > [[“processException”,10]、[“logException”,0]、[“notifyException”,-10年)));}公共函数processException(ExceptionEvent美元事件){/ /……}公共函数logException(ExceptionEvent美元事件){/ /……}公共函数notifyException(ExceptionEvent美元事件){/ /……}}就是这样!你的services.yaml文件应该已经设置加载服务的EventSubscriber目录中。ob娱乐下载Symfony的休息。
提示
如果你的方法不时调用将抛出一个异常,检查你的加载服务从EventSubscriber目录,可以使用autoconfigure启用。你也可以手动添加kernel.event_subscriber标签。
请求事件,检查类型
一个页面可以使多个请求(一个主要的要求,那么多个子请求,通常当在模板中嵌入控制器)。核心Symfony的事件,ob娱乐下载您可能需要检查的事件是“主要”请求或“子请求”:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src / EventListener / RequestListener.php名称空间应用程序\EventListener;使用ob娱乐下载\组件\HttpKernel\事件\RequestEvent;类RequestListener{公共函数onKernelRequestRequestEvent (美元事件){如果(!美元事件- >isMainRequest ()) {/ /不做任何事如果不是主要的请求返回;}/ /……}}某些事情,比如检查信息真正的请求,可能不需要做sub-request听众。
听众或用户
听众和用户可以在同一个应用程序中朦胧地。使用他们的决定通常是个人口味的问题。然而,他们每个人有一些小的优势:
- 用户更容易重用因为事件是在类的知识,而不是在服务定义。这就是为什么Symfony使用内部用户;ob娱乐下载
- 听众更加灵活因为包可以启用或禁用他们每个人有条件地根据一些配置值。
事件的别名
当配置事件监听器和订阅者通过依赖注入,Symfony的核心事件也可以被完全限定类名(FQCN)对应的事件类的:ob娱乐下载
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/ / src / EventSubscriber / RequestSubscriber.php名称空间应用程序\EventSubscriber;使用ob娱乐下载\组件\EventDispatcher\EventSubscriberInterface;使用ob娱乐下载\组件\HttpKernel\事件\RequestEvent;类RequestSubscriber实现了EventSubscriberInterface{公共静态函数getSubscribedEvents():数组{返回RequestEvent [::类= >“onKernelRequest”,);}公共函数onKernelRequestRequestEvent (美元事件){/ /……}}在内部,事件FQCN被当作原始事件名称的别名。因为映射已经发生编译服务容器时,事件监听器和订阅者使用FQCN代替事件名称将出现在最初的事件名称时检查事件调度器。
这个别名映射可以扩展自定义事件通过注册编译器通过AddEventAliasesPass:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src / Kernel.php名称空间应用程序;使用应用程序\事件\MyCustomEvent;使用ob娱乐下载\组件\DependencyInjection\ContainerBuilder;使用ob娱乐下载\组件\EventDispatcher\DependencyInjection\AddEventAliasesPass;使用ob娱乐下载\组件\HttpKernel\内核作为BaseKernel;类内核扩展BaseKernel{受保护的函数构建(ContainerBuilder美元containerBuilder){美元containerBuilder- >addCompilerPass (新AddEventAliasesPass ([MyCustomEvent::类= >“my_custom_event”)));}}编译器通过将永远扩展现有的别名列表。正因为如此,它是安全注册的多个实例通过不同的配置。
调试事件监听器
你可以找出监听器注册事件调度器使用控制台。显示所有事件和他们的听众,运行:
1
美元php bin /控制台调试:事件分配器你可以为一个特定的事件注册监听器通过指定它的名字:
1
美元php bin /控制台调试:事件分配器kernel.exception或者可以把一切部分匹配事件名称:
1 2
美元php bin /控制台调试:事件分配器内核/ /匹配“kernel.exception”,“kernel.response”等。美元php bin /控制台调试:事件分发安全/ /匹配“ob娱乐下载Symfony Http \ \安全\ \组件事件\ CheckPassportEvent”的安全系统使用一个事件分配器/防火墙。使用——调度员选择的特定事件分配器:注册监听器
1
美元php bin /控制台调试:事件分配器,分配器= security.event_dispatcher.main如何设置过滤器前后
是很常见的在web应用程序开发需要一些逻辑执行之前或后直接控制器动作作为过滤器或钩子。
一些web框架定义方法preExecute ()和postExecute ()Symfony中,但没有这样的事。ob娱乐下载好消息是,有一个更欧宝平台是合法的吗好的方式干扰使用请求- >响应过程EventDispatcher组件。
令牌验证示例
想象你需要开发一个API,一些控制器是公开的但有些人局限于一个或一些客户。对于这些私有特性,您可以提供一个令牌你的客户确定自己。
在执行控制器的行动之前,你需要检查是否行动是受限制的。如果是受限制的,您需要验证所提供的令牌。
请注意
请注意,在这个食谱中,为简单起见,令牌将定义在配置和数据库设置和验证将使用通过安全组件。
在过滤器的kernel.controller事件
首先,定义一些象征性的配置参数:
- YAML
- XML
- PHP
1 2 3 4 5
#配置/ services.yaml参数:令牌:client1:pass1作为client2:pass2控制器检查标签
一个kernel.controller(又名KernelEvents:控制器侦听器被通知每一个请求,控制器执行之前。所以,首先,你需要一些方法来确定如果匹配请求的控制器需要令牌验证。
一个干净和简单的方法是创建一个空的接口,使控制器实现它:
1 2 3 4 5 6
名称空间应用程序\控制器;接口TokenAuthenticatedController{/ /……}一个控制器,实现这个接口是这样的:
1 2 3 4 5 6 7 8 9 10 11 12 13
名称空间应用程序\控制器;使用应用程序\控制器\TokenAuthenticatedController;使用ob娱乐下载\包\FrameworkBundle\控制器\AbstractController;类FooController扩展AbstractController实现了TokenAuthenticatedController{/ /一个动作需要身份验证公共函数酒吧(){/ /……}}创建一个事件订阅者
接下来,您需要创建一个事件订阅者,将之前你想要执行的逻辑控制器。如果你不熟悉事件的用户,您可以了解更多关于他们事件和事件监听器:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/ / src / EventSubscriber / TokenSubscriber.php名称空间应用程序\EventSubscriber;使用应用程序\控制器\TokenAuthenticatedController;使用ob娱乐下载\组件\EventDispatcher\EventSubscriberInterface;使用ob娱乐下载\组件\HttpKernel\事件\ControllerEvent;使用ob娱乐下载\组件\HttpKernel\异常\AccessDeniedHttpException;使用ob娱乐下载\组件\HttpKernel\KernelEvents;类TokenSubscriber实现了EventSubscriberInterface{私人美元令牌;公共函数__construct(美元令牌){美元这- >令牌=美元令牌;}公共函数onKernelController(ControllerEvent美元事件){美元控制器=美元事件- >getController ();/ /当一个控制器类定义了多个操作方法,控制器/ /返回(controllerInstance美元,“methodName”)如果(is_array (美元控制器)){美元控制器=美元控制器(0];}如果(美元控制器运算符TokenAuthenticatedController) {美元令牌=美元事件- >getRequest ()- >查询- >get (“令牌”);如果(! in_array (美元令牌,美元这- >令牌)){扔新AccessDeniedHttpException (“这个行动需要一个有效的令牌!”);}}}公共静态函数getSubscribedEvents(){返回[KernelEvents::控制器= >“onKernelController”,);}}就是这样!你的services.yaml文件应该已经设置加载服务的EventSubscriber目录中。ob娱乐下载Symfony的休息。你的TokenSubscriberonKernelController ()方法将针对每个请求执行。如果控制器是实现执行TokenAuthenticatedController,令牌验证。这让你有一个“前”过滤任何你想要的控制器。
提示
如果你的用户不呼吁每个请求,检查你的加载服务从EventSubscriber目录,可以使用autoconfigure启用。你也可以手动添加kernel.event_subscriber标签。
过滤后的kernel.response事件
除了有“钩”的执行之前控制器,您还可以添加一个钩的执行后你的控制器。对于这个示例,假设您想要添加一个sha1散列(盐使用该令牌)的所有反应已经通过了这个令牌验证。
另一个核心Symfony事ob娱乐下载件——调用kernel.response(又名KernelEvents:响应)- - -在每个请求通知,但在控制器返回一个响应对象。创建一个“后”侦听器,创建一个监听器类和注册服务在这个事件。
例如,把TokenSubscriber前面的示例和第一张唱片在请求的身份验证标记属性。这将作为一个基本的国旗,这请求接受了令牌的身份验证:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
公共函数onKernelController(ControllerEvent美元事件){/ /……如果(美元控制器运算符TokenAuthenticatedController) {美元令牌=美元事件- >getRequest ()- >查询- >get (“令牌”);如果(! in_array (美元令牌,美元这- >令牌)){扔新AccessDeniedHttpException (“这个行动需要一个有效的令牌!”);}/ /标记请求令牌传递身份验证美元事件- >getRequest ()- >属性- >集(“auth_token”,美元令牌);}}现在,配置用户听另一个事件和添加onKernelResponse ()。这将会寻找auth_token国旗请求对象和设置一个自定义标题反应如果发现:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24
/ /添加新的使用声明文件的顶部使用ob娱乐下载\组件\HttpKernel\事件\ResponseEvent;公共函数onKernelResponse(ResponseEvent美元事件){/ /检查onKernelController标志着这是一个令牌”“身份验证”的要求如果(!美元令牌=美元事件- >getRequest ()- >属性- >get (“auth_token”)){返回;}美元响应=美元事件- >getResponse ();/ /创建一个散列并设置响应头美元哈希= sha1 (美元响应- >getContent ()。美元令牌);美元响应- >头- >集(“X-CONTENT-HASH”,美元哈希);}公共静态函数getSubscribedEvents(){返回[KernelEvents::控制器= >“onKernelController”,KernelEvents::响应= >“onKernelResponse”,);}就是这样!的TokenSubscriber现在每个控制器执行(前通知onKernelController ()每个控制器返回响应(后),onKernelResponse ())。通过特定的控制器实现TokenAuthenticatedController接口,你的听众知道这控制器应该采取行动。通过将值存储在请求的“属性”包,onKernelResponse ()法知道添加额外的头。玩得开心!
如何定制一个没有使用继承的方法行为吗
如果你想做正确的事情,或者直接调用方法后,你可以派遣一个事件分别在开始或者结束的时候方法:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24
类CustomMailer{/ /……公共函数发送(美元主题,美元消息){/ /调度事件之前的方法美元事件=新BeforeSendMailEvent (美元主题,美元消息);美元这- >调度程序- >调度(美元事件,“mailer.pre_send”);/ /得到主题和消息的事件美元,他们可能会被修改美元主题=美元事件- >getSubject ();美元消息=美元事件- >getMessage ();/ /这里的真正的方法实现美元returnValue=……;/ /后做一些方法美元事件=新AfterSendMailEvent (美元returnValue);美元这- >调度程序- >调度(美元事件,“mailer.post_send”);返回美元事件- >getReturnValue ();}}在这个例子中,派出两个事件:
mailer.pre_send之前,该方法被调用时,- 和
mailer.post_send方法被调用。
每个使用一个定制事件类信息沟通这两个事件的侦听器。例如,BeforeSendMailEvent可能像这样:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36
/ / src /事件/ BeforeSendMailEvent.php名称空间应用程序\事件;使用ob娱乐下载\合同\EventDispatcher\事件;类BeforeSendMailEvent扩展事件{私人美元主题;私人美元消息;公共函数__construct(美元主题,美元消息){美元这- >主题=美元主题;美元这- >消息=美元消息;}公共函数getSubject(){返回美元这- >主题;}公共函数setSubject(美元主题){美元这- >主题=美元主题;}公共函数getMessage(){返回美元这- >消息;}公共函数setMessage(美元消息){美元这- >消息=美元消息;}}和AfterSendMailEvent即使是这样的:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24
/ / src /事件/ AfterSendMailEvent.php名称空间应用程序\事件;使用ob娱乐下载\合同\EventDispatcher\事件;类AfterSendMailEvent扩展事件{私人美元returnValue;公共函数__construct(美元returnValue){美元这- >returnValue =美元returnValue;}公共函数getReturnValue(){返回美元这- >returnValue;}公共函数setReturnValue(美元returnValue){美元这- >returnValue =美元returnValue;}}这两件事让你得到一些信息(如。getMessage ()(如),甚至改变这一信息。setMessage ())。
现在,您可以创建一个事件订阅者钩到这个事件。例如,你可以听mailer.post_send事件和改变方法的返回值:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日
/ / src / EventSubscriber / MailPostSendSubscriber.php名称空间应用程序\EventSubscriber;使用应用程序\事件\AfterSendMailEvent;使用ob娱乐下载\组件\EventDispatcher\EventSubscriberInterface;类MailPostSendSubscriber实现了EventSubscriberInterface{公共函数onMailerPostSend(AfterSendMailEvent美元事件){美元returnValue=美元事件- >getReturnValue ();/ /修改初始的“returnValue“美元价值美元事件- >setReturnValue (美元returnValue);}公共静态函数getSubscribedEvents(){返回(“mailer.post_send”= >“onMailerPostSend”,);}}就是这样!你的用户应该被称为自动(或了解更多事件用户配置)。
