如何设置过滤器前后
编辑该页面警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 3.0,不再维护。
读这个页面的更新版本Symfob娱乐下载ony 6.2(当前的稳定版本)。
如何设置过滤器前后
是很常见的在web应用程序开发需要一些逻辑执行前或后控制器动作作为过滤器或钩子。
一些web框架定义方法preExecute ()和postExecute ()Symfony中,但没有这样的事。ob娱乐下载好消息是,有一个更欧宝平台是合法的吗好的方式干扰使用请求- >响应过程EventDispatcher组件。
令牌验证示例
想象你需要开发一个API,一些控制器是公开的但有些人局限于一个或一些客户。对于这些私有特性,您可以提供一个令牌你的客户确定自己。
在执行控制器的行动之前,你需要检查是否行动是受限制的。如果是受限制的,您需要验证所提供的令牌。
请注意
请注意,在这个食谱中,为简单起见,令牌将定义在配置和数据库设置和验证将使用通过安全组件。
在过滤器的kernel.controller事件
首先,存储配置使用一些基本的令牌config.yml和关键的参数:
- YAML
- XML
- PHP
1 2 3 4 5
# app / config / config.yml参数:令牌:client1:pass1作为client2:pass2控制器检查标签
一个kernel.controller侦听器被通知每一个请求,控制器执行之前。所以,首先,你需要一些方法来确定如果匹配请求的控制器需要令牌验证。
一个干净和简单的方法是创建一个空的接口,使控制器实现它:
1 2 3 4 5 6
名称空间AppBundle\控制器;接口TokenAuthenticatedController{/ /……}一个控制器实现这个接口只是看起来像这样:
1 2 3 4 5 6 7 8 9 10 11 12 13
名称空间AppBundle\控制器;使用AppBundle\控制器\TokenAuthenticatedController;使用ob娱乐下载\包\FrameworkBundle\控制器\控制器;类FooController扩展控制器实现了TokenAuthenticatedController{/ /一个动作需要身份验证公共函数barAction(){/ /……}}创建一个事件监听器
接下来,您需要创建一个事件侦听器,它将之前你想要执行的逻辑控制器。如果你不熟悉事件侦听器,您可以了解更多关于他们事件和事件监听器:
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
/ / src / AppBundle / EventListener / TokenListener.php名称空间AppBundle\EventListener;使用AppBundle\控制器\TokenAuthenticatedController;使用ob娱乐下载\组件\HttpKernel\异常\AccessDeniedHttpException;使用ob娱乐下载\组件\HttpKernel\事件\FilterControllerEvent;类TokenListener{私人美元令牌;公共函数__construct(美元令牌){美元这- >令牌=美元令牌;}公共函数onKernelController(FilterControllerEvent美元事件){美元控制器=美元事件- >getController ();/ * * $控制器可以是一个类或一个闭包传递。*这不是通常在Symfony但它可能发生。ob娱乐下载*如果它是一个类,它有数组格式* /如果(! is_array (美元控制器)){返回;}如果(美元控制器(0]运算符TokenAuthenticatedController) {美元令牌=美元事件- >getRequest ()- >查询- >get (“令牌”);如果(! in_array (美元令牌,美元这- >令牌)){扔新AccessDeniedHttpException (“这个行动需要一个有效的令牌!”);}}}}注册监听器
最后,作为服务注册侦听器和标签是一个事件侦听器。通过监听kernel.controller,你告诉Symfony,你希望你的ob娱乐下载侦听器被称为之前执行任何控制器。
- YAML
- XML
- PHP
1 2 3 4 5 6 7
# app / config / services.yml服务:app.tokens.action_listener:类:AppBundle \ EventListener \ TokenListener参数:[' %符号% ')标签:- - - - - -{名称:kernel.event_listener,事件:kernel.controller,方法:onKernelController}在这个配置中,你的TokenListeneronKernelController方法将针对每个请求执行。如果控制器是实现执行TokenAuthenticatedController,令牌验证。这让你有一个“前”过滤任何你想要的控制器。
过滤后的kernel.response事件
除了有“钩”的执行之前控制器,您还可以添加一个钩的执行后你的控制器。对于这个示例,假设您想要添加一个sha1哈希(盐使用该令牌)的所有反应已经通过了这个令牌认证。
另一个核心Symfony事ob娱乐下载件——调用kernel.response——对每个请求进行通知,但控制器后返回一个响应对象。创建一个“后”侦听器一样容易创建侦听器类和注册服务在这个事件。
例如,把TokenListener前面的示例和第一张唱片在请求的身份验证标记属性。这将作为一个基本的国旗,这请求接受了令牌的身份验证:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
公共函数onKernelController(FilterControllerEvent美元事件){/ /……如果(美元控制器(0]运算符TokenAuthenticatedController) {美元令牌=美元事件- >getRequest ()- >查询- >get (“令牌”);如果(! in_array (美元令牌,美元这- >令牌)){扔新AccessDeniedHttpException (“这个行动需要一个有效的令牌!”);}/ /标记请求令牌传递身份验证美元事件- >getRequest ()- >属性- >集(“auth_token”,美元令牌);}}现在,添加另一个方法——这个类onKernelResponse——看起来这个标志的请求对象和设置一个自定义标题反应如果发现:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/ /添加新的使用声明文件的顶部使用ob娱乐下载\组件\HttpKernel\事件\FilterResponseEvent;公共函数onKernelResponse(FilterResponseEvent美元事件){/ /检查onKernelController标志着这是一个令牌”“身份验证”的要求如果(!美元令牌=美元事件- >getRequest ()- >属性- >get (“auth_token”)){返回;}美元响应=美元事件- >getResponse ();/ /创建一个散列并设置响应头美元哈希= sha1 (美元响应- >getContent ()。美元令牌);美元响应- >头- >集(“X-CONTENT-HASH”,美元哈希);}最后,需要第二个“标签”的服务定义通知Symfonyob娱乐下载onKernelResponse事件应该通知kernel.response事件:
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8
# app / config / services.yml服务:app.tokens.action_listener:类:AppBundle \ EventListener \ TokenListener参数:[' %符号% ')标签:- - - - - -{名称:kernel.event_listener,事件:kernel.controller,方法:onKernelController}- - - - - -{名称:kernel.event_listener,事件:kernel.response,方法:onKernelResponse}就是这样!的TokenListener现在每个控制器执行(前通知onKernelController每个控制器返回响应(后),onKernelResponse)。通过特定的控制器实现TokenAuthenticatedController接口,你的听众知道这控制器应该采取行动。通过将值存储在请求的“属性”包,onKernelResponse法知道添加额外的头。玩得开心!
