在我的项目中,我有一个BaseController类,它实现了我所有控制器使用的几种方法。
现在我想为该基类添加@QueryParam。我的班级看起来像这样:
class DoctrineRESTQueryController extends FOSRestController
{
/**
* @QueryParam(name="start",default=0)
* @QueryParam(name="limit",default=null)
*/
public function getQueryResponseAction (ParamFetcher $paramFetcher) {
}
}
现在我的实际控制器从我的基本控制器扩展:
class DefaultController extends DoctrineRESTQueryController {
/**
* Retrieves all SI Prefixes in the database
*
* @Routing\Route("/siprefix", defaults={"method" = "get","_format" = "json"})
* @Routing\Method({"GET"})
* @ApiDoc(output="array<PartKeepr\SiPrefixBundle\Entity\SiPrefix>")
*
* @View()
*
* {@inheritdoc}
*/
public function getQueryResponseAction(ParamFetcher $paramFetcher) {
$paramFetcher->get("start");
}
}
不幸的是,Symfony2似乎没有继承超类中的@QueryParam注释,因为调用$ paramFetcher-&gt; get(&#34; start&#34;)会导致异常&#34;没有@ QueryParam / @ RequestParam配置参数&#39; start&#39;&#34;。
有没有办法让注释继承工作,或任何其他解决方案,所以我不必将@QueryParam添加到我的每个控制器?
答案 0 :(得分:5)
此FosRestBundle
中没有任何功能,因此您必须覆盖部分内容以满足您的需求,更具体地说,可以覆盖课程getParamsFromMethod
中的方法FOSRestBundle/Request/ParamReader
(请参阅source code here })。
这可以通过bundle继承来完成。
首先,在您的某个捆绑包中创建子类FOSRestBundle\Request\ParamReader
,例如YourSite\RestBundle\Request\MyParamReader
并通过加载父方法的注释并将它们与当前方法的注释合并来覆盖getParamsFromMethod
:
namespace YourSite\RestBundle\Request\MyParamReader;
use FOSRestBundle\Request\ParamReader;
class MyParamReader extends ParamReader
{
public function getParamsFromMethod(\ReflectionMethod $method)
{
$parentParams = array();
$params = parent::getParamsFromMethod($method);
// This loads the annotations of the parent method
$declaringClass = $method->getDeclaringClass();
$parentClass = $declaringClass->getParentClass();
if ($parentClass && $parentClass->hasMethod($method->getShortName())) {
$parentMethod = $parentClass->getMethod($method->getShortName());
$parentParams = parent::getParamsFromMethod($parentMethod);
}
return array_merge($params, $parentParams);
}
}
如有必要,您可以修改代码以处理深层继承层次结构。
现在,您应该告诉FOSRestBundle
使用YourSite\RestBundle\Request\MyParamReader
课程代替FOSRestBundle\Request\ParamReader
。您需要覆盖服务定义,其中参数阅读器被列为依赖项。这是捆绑覆盖/继承发挥作用的地方,请参阅this Symfony2 article。
服务定义位于Resources/config/request.xml
文件中(请参阅source code here),FOSRestBundle\Request\ParamReader
是FOS\RestBundle\Request\ParamFetcher
的依赖关系。
因此,您必须覆盖Resources/config/request.xml
文件。为此,请按照上述文章注册您的包并声明FOSRestBundle
为其父级:
namespace YourSite\RestBundle;
use Symfony\Component\HttpKernel\Bundle\Bundle;
class YourSiteRestBundle extends Bundle
{
public function getParent()
{
return 'FOSRestBundle';
}
}
创建文件YourSite\RestBundle\Resources\config\request.xml
以添加YourSite\RestBundle\Request\MyParamReader
作为依赖项:
<?xml version="1.0" ?>
<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
<parameters>
<parameter key="fos_rest.request.param_fetcher.class">FOS\RestBundle\Request\ParamFetcher</parameter>
<parameter key="your_site_rest.request.param_fetcher.reader.class">YourSite\RestBundle\Request\MyParamReader</parameter>
</parameters>
<services>
<service id="fos_rest.request.param_fetcher" class="%fos_rest.request.param_fetcher.class%" scope="request">
<argument type="service" id="your_site.request.param_fetcher.reader"/>
<argument type="service" id="request"/>
<argument type="service" id="fos_rest.violation_formatter"/>
<argument type="service" id="validator" on-invalid="null"/>
</service>
<service id="your_site.request.param_fetcher.reader" class="%your_site_rest.request.param_fetcher.reader.class%">
<argument type="service" id="annotation_reader"/>
</service>
</services>
</container>
这是未经测试的,但应该有效。
答案 1 :(得分:0)
很好的解决方案,谢谢!也许有人在symfony3中寻找相同的.yml配置,以下应该可行:
parameters:
fos_rest.request.param_fetcher.class: FOS\RestBundle\Request\ParamFetcher
your_site_rest.request.param_fetcher.reader.class: YourSiteBundle\Request\MyParamReader
services:
fos_rest.request.param_fetcher:
class: %fos_rest.request.param_fetcher.class%
arguments: ['@service_container', '@your_site.request.param_fetcher.reader', '@request_stack', '@?validator']
scope: request
your_site.request.param_fetcher.reader:
class: %your_site.request.param_fetcher.reader.class%
arguments: ['@annotation_reader']