如何在Symfony中将存储库注入服务？

78

我需要将两个对象注入ImageService。其中一个是的实例Repository/ImageRepository，我得到这样的信息：

$image_repository = $container->get('doctrine.odm.mongodb')
    ->getRepository('MycompanyMainBundle:Image');

那么如何在我的services.yml中声明呢？这是服务：

namespace Mycompany\MainBundle\Service\Image;

use Doctrine\ODM\MongoDB\DocumentRepository;

class ImageManager {
    private $manipulator;
    private $repository;

    public function __construct(ImageManipulatorInterface $manipulator, DocumentRepository $repository) {
        $this->manipulator = $manipulator;
        $this->repository = $repository;
    }

    public function findAll() {
        return $this->repository->findAll();
    }

    public function createThumbnail(ImageInterface $image) {
        return $this->manipulator->resize($image->source(), 300, 200);
    }
}
php  symfony  dependency-injection 
— 巧克力开发者
source
— simshaun
@simshaun谢谢，帮我找到如何做到这一点在阳明：symfony.com/doc/master/components/dependency_injection/...
— ChocoDeveloper

Answers:

105

这是针对像我这样的Google来者的清理解决方案：

更新：这是Symfony 2.6（及更高版本）解决方案：

services:

    myrepository:
        class: Doctrine\ORM\EntityRepository
        factory: ["@doctrine.orm.entity_manager", getRepository]
        arguments:
            - MyBundle\Entity\MyClass

    myservice:
        class: MyBundle\Service\MyService
        arguments:
            - "@myrepository"

不建议使用的解决方案（Symfony 2.5及更低版本）：

services:

    myrepository:
        class: Doctrine\ORM\EntityRepository
        factory_service: doctrine.orm.entity_manager
        factory_method: getRepository
        arguments:
            - MyBundle\Entity\MyClass

    myservice:
        class: MyBundle\Service\MyService
        arguments:
            - "@myrepository"
— 马修·那不勒斯
source
2
使用MongoDB时，请doctrine.odm.mongodb.document_manager用作
— factory_service
这项功能很棒，但是可以使您通过控制器访问以这种方式添加的任何存储库$this->get('myrepository')。有什么方法可以将存储库定义/传递为参数，myservice而不必将其定义为服务本身吗？
— 安迪
1
@Andy您可以将服务定义为private，这意味着可以将它们注入（在YAML配置中），但不能使用->get()
— Matthieu Napoli
2
弃用警告：没有更多的factory_service和factory_method自Symfony的2.6。这就是现在应该做的事情：stackoverflow.com/a/31807608/828366
— Francesco Casula 2015年
1
请注意，从Symfony 3.0开始，您应该对某些YAML配置使用引号。因此，在这里您应该使用factory: ["@doctrine.orm.entity_manager", getRepository]，否则会被漂亮的ParseException所欢迎。
— 捷克学
45

我找到了此链接，这对我有用：

parameters:
    image_repository.class:            Mycompany\MainBundle\Repository\ImageRepository
    image_repository.factory_argument: 'MycompanyMainBundle:Image'
    image_manager.class:               Mycompany\MainBundle\Service\Image\ImageManager
    image_manipulator.class:           Mycompany\MainBundle\Service\Image\ImageManipulator

services:
    image_manager:
        class: %image_manager.class%
        arguments:
          - @image_manipulator
          - @image_repository

    image_repository:
        class:           %image_repository.class%
        factory_service: doctrine.odm.mongodb
        factory_method:  getRepository
        arguments:
            - %image_repository.factory_argument%

    image_manipulator:
        class: %image_manipulator.class%
— 巧克力开发者
source
6
弃用警告：自Symfony 2.6起
— 不再提供factory_service
不会有任何默认工厂，但是Symfony 3.4支持创建自己的工厂的方法。
— Dimitrios Desyllas
40

如果不想将每个存储库定义为服务，则从版本开始，2.4您可以执行以下操作（（default是实体管理器的名称）：

@=service('doctrine.orm.default_entity_manager').getRepository('MycompanyMainBundle:Image')
— b.b3rn4rd
source
3
XML服务文件中的外观如何？
— 强尼
1
这是基于表达组件上：symfony.com/doc/current/book/...
— HenningCash
6
使用Symfony 2.7，我能够使用较短的语法获取存储库：@=service('doctrine').getRepository('AppBundle:EntityX')
— mgalic 2015年
完美翻译为* Container.php中的“ $ this-> get（“ doctrine”）-> getRepository（“ AppBundle：EntityX”）“，喜欢这个快捷方式！
— Thomas Decaux
@Jonny，这是xml版本：<service id="image_manager" class="MyCompany\MainBundle\ImageManager"> <argument type="expression">service('doctrine.orm.default_entity_manager').getRepository('MycompanyMainBundle:Image')</argument> </service>
— Emilie
17

Symfony 3.3、4和5使这一过程变得更加简单。

请查看我的文章如何在Symfony中将存储库与Doctrine即服务一起使用以获取更一般的描述。

对于您的代码，所有您需要做的就是使用继承而不是继承-SOLID模式之一。

1.创建自己的存储库，而不直接依赖于Doctrine

<?php

namespace MycompanyMainBundle\Repository;

use Doctrine\ORM\EntityManagerInterface;
use MycompanyMainBundle\Entity\Image;

class ImageRepository
{
    private $repository;

    public function __construct(EntityManagerInterface $entityManager)
    {
        $this->repository = $entityManager->getRepository(Image::class);
    }

    // add desired methods here
    public function findAll()
    {
        return $this->repository->findAll();
    }
}

2.使用基于PSR-4的自动注​​册添加配置注册

# app/config/services.yml
services:
    _defaults:
        autowire: true

    MycompanyMainBundle\:
        resource: ../../src/MycompanyMainBundle

3.现在，您可以通过构造函数注入在任何地方添加任何依赖项

use MycompanyMainBundle\Repository\ImageRepository;

class ImageService
{
    public function __construct(ImageRepository $imageRepository)
    {
        $this->imageRepository = $imageRepository;
    }
}
— 汤玛斯·沃特鲁巴
source
这仍然是Symfony 4.1的最新消息吗？
— Isengo
是的，建筑注塑技术不应更改为Symfony5。您遇到什么麻烦？
— 托马什Votruba
我在服务文件夹中创建了一个名为UserManager的服务，并想在“类UsersRepository扩展ServiceEntityRepository”中使用我的UsersRepository
— Isengo 18-10-22
这是我在帖子中主张的另一种方法。它为几乎所有与Symfony和Doctrine的数据库相关的入门服务创建了巨大的供应商锁。看到帖子更多
— 托马什Votruba
-1

在我的案例中，基于@TomášVotruba的回答和这个问题，我提出以下方法：

适配器方法

没有继承

  1. 创建一个通用适配器类：

    namespace AppBundle\Services;
use Doctrine\ORM\EntityManagerInterface;

class RepositoryServiceAdapter
{
    private $repository=null;

    /**
    * @param EntityManagerInterface the Doctrine entity Manager
    * @param String $entityName The name of the entity that we will retrieve the repository
    */
    public function __construct(EntityManagerInterface $entityManager,$entityName)
    {
        $this->repository=$entityManager->getRepository($entityName)
    }

    public function __call($name,$arguments)
    {
      if(empty($arrguments)){ //No arguments has been passed
        $this->repository->$name();
      } else {
        //@todo: figure out how to pass the parameters
        $this->repository->$name(...$argument);
      }
    }
}

  2. 然后foreach实体定义一个服务，例如在我的情况下定义一个服务（我使用php定义symfony服务）：

     $container->register('ellakcy.db.contact_email',AppBundle\Services\Adapters\RepositoryServiceAdapter::class)
  ->serArguments([new Reference('doctrine'),AppBundle\Entity\ContactEmail::class]);

继承

  1. 与上述步骤1相同

  2. 扩展RepositoryServiceAdapter类，例如：

    namespace AppBundle\Service\Adapters;

use Doctrine\ORM\EntityManagerInterface;
use AppBundle\Entity\ContactEmail;

class ContactEmailRepositoryServiceAdapter extends RepositoryServiceAdapter
{
  public function __construct(EntityManagerInterface $entityManager)
  {
    parent::__construct($entityManager,ContactEmail::class);
  }
}

  3. 注册服务：

    $container->register('ellakcy.db.contact_email',AppBundle\Services\Adapters\RepositoryServiceAdapter::class)
  ->serArguments([new Reference('doctrine')]);

不管是哪种情况，都有一种很好的可测试的方法来对数据库性能进行功能测试，它还可以帮助您进行模拟，以防您要对服务进行单元测试而无需过多地担心如何做。例如，让我们假设我们具有以下服务：

//Namespace definitions etc etc

class MyDummyService
{
  public function __construct(RepositoryServiceAdapter $adapter)
  {
    //Do stuff
  }
}

RepositoryServiceAdapter会适应以下存储库：

//Namespace definitions etc etc

class SomeRepository extends \Doctrine\ORM\EntityRepository
{
   public function search($params)
   {
     //Search Logic
   }
}

测验

所以，你可以很容易地模拟/硬编码/模拟方法的行为search中定义SomeRepository的嘲讽aither的RepositoryServiceAdapter非继承方法或ContactEmailRepositoryServiceAdapter在继承之一。

工厂方法

或者，您可以定义以下工厂：

namespace AppBundle\ServiceFactories;

use Doctrine\ORM\EntityManagerInterface;

class RepositoryFactory
{
  /**
  * @param EntityManagerInterface $entityManager The doctrine entity Manager
  * @param String $entityName The name of the entity
  * @return Class
  */
  public static function repositoryAsAService(EntityManagerInterface $entityManager,$entityName)
  {
    return $entityManager->getRepository($entityName);
  }
}

然后通过执行以下操作切换到php服务注释：

将其放入文件中./app/config/services.php（对于symfony v3.4，.假定您是ptoject的根目录）

use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;
$definition = new Definition();

$definition->setAutowired(true)->setAutoconfigured(true)->setPublic(false);

// $this is a reference to the current loader
$this->registerClasses($definition, 'AppBundle\\', '../../src/AppBundle/*', '../../src/AppBundle/{Entity,Repository,Tests,Interfaces,Services/Adapters/RepositoryServiceAdapter.php}');


$definition->addTag('controller.service_arguments');
$this->registerClasses($definition, 'AppBundle\\Controller\\', '../../src/AppBundle/Controller/*');

并./app/config/config.yml（.假设您是ptoject的根）

imports:
    - { resource: parameters.yml }
    - { resource: security.yml }
    #Replace services.yml to services.php
    - { resource: services.php }

#Other Configuration

然后，您可以按照以下方式使用该服务（在我使用的名为Dummy实体的示例中使用Item）：

$container->register(ItemRepository::class,ItemRepository::class)
  ->setFactory([new Reference(RepositoryFactory::class),'repositoryAsAService'])
  ->setArguments(['$entityManager'=>new Reference('doctrine.orm.entity_manager'),'$entityName'=>Item::class]);

另外，作为一般技巧，切换到php服务注释可以使您无故障地进行上面介绍的更高级的服务配置。对于代码片段，请使用我使用方法创建的特殊存储库factory。

— 迪米特里奥斯·德斯拉斯
source
你能解释为什么你提出这个建议吗？与原始解决方案相比，您从IDE中获得了自动完成帮助，您将获得什么呢？
— Nico Haase
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.