Symfony 2:解析循环引用

时间:2016-05-02 07:22:14

标签: symfony circular-dependency circular-reference

我正在开发一个Symfony 2 WebApp项目。集成商店的逻辑在MyShopBundle中实现。

在捆绑包中添加Twig Extension后,我得到一个例外:

我完全理解这条消息的含义但到目前为止我找不到解决问题的方法:

PaymentServices中的MyShopBundle提供与付款流程相关的各种不同服务。除此之外,它还会观察付款状态并自动向用户发送电子邮件通知。另外它提供isPaymentComplete(int userId)

要从Twig模板呈现电子邮件的内容,PaymentServices需要引用Twig_Environment。服务从其构造函数中获取此引用:

class MyPaymentService {
    protected $twig;

    public function __construct(\Twig_Environment $twig, ...) {
        $this->twig = $twig;
        ...
    }

    public function updatePaymentStatus(int userId) {
        // Update Payment
        ...

        // Send notification to user
        $mailBody = $this->twig->render('MyShopBundle:Emails:statusUpdate.html.twig', array('user_name' => $username));
        ...
    }

    public function isPaymentComplete(int userId) {
        ...
        return true;   
    }
}

另一方面, Twig Extension 需要引用PaymentService来创建isPaymentComplete(int userId)的树枝版本:

class ShopExtension extends \Twig_Extension {
    private $paymentService;

    public function __construct(PaymentService $service, ...) {
        $this->paymentService = $service;
        ...
    }

    public function getName() {
        return 'my_shop_bundle_extension';
    }

    public function getFunctions() {
        $functions = array();

        $functions[] = new \Twig_SimpleFunction('msb_IsPaymentComplete', array(
            $this,
            'msb_IsPaymentComplete'
        ));

        return $functions;
    }

    public function msb_IsPaymentComplete($user) {
        if ($this->paymentService)
            return $this->paymentService->isPaymentComplete($user);
        else 
            return false;
    }
} 

这是service.yml

中的服务定义
services:
    shop.payment.service:
        class: MyShopBundle\Service\PaymentService
        arguments: 
          - "@twig"
          - ...

    app_subscription.twig_extension:
        class: MyShopBundle\Twig\ShopExtension
        arguments: 
            - "@shop.payment.service"
        tags:
          - { name: twig.extension }

异常的来源很明确:

PaymentService - >树枝 - > ShopExtension - > PaymentService

问题是:如何解决这个问题?

我发现了其他问题,处理Symfony中的循环引用。但是它们都与使用一些常见的捆绑/服务(如DoctrineFOSUserBundle等)的特殊情况有关。这些线程中讨论的解决方案在这里不起作用。

显而易见的解决方案是将PaymentService分为两部分:一部分包含isPaymentComplete(int userId),另一部分提供updatePaymentStatus。但这不像声音那么容易,因为这两种方法使用其他常见的PaymentService方法。为了避免仅将杠杆上的圆形参考移动得更深,我需要将PaymentService分成三部分:

  • Service1包括isPaymentComplete
  • Service2包括updatePaymentStatus
  • Service3,包括Service1和2
  • 使用的所有常用方法

那会起作用(最有可能),但会非常非常难看。这三种服务中的所有方法都具有相同的用途(处理付款),因此应包含在同一服务中。将服务分解为不同的部分与代码结构无关,但只能通过破解来打破循环引用。

我已经尝试将引用从构造函数移动到setter:

services:
    shop.payment.service:
        class: MyShopBundle\Service\PaymentService
        calls:
          - [ setTwig, [ "@twig" ] ]

    app_subscription.twig_extension:
        class: MyShopBundle\Twig\ShopExtension
        calls:
          - [ setService, [ "@shop.payment.service" ] ]
        tags:
          - { name: twig.extension }

结果仍然相同。

那么:是否有任何 clean 解决方案来解决此引用问题?

1 个答案:

答案 0 :(得分:1)

这个问题意味着您需要拥有更少的依赖项服务。例如,您可以使用像clientMailProvider这样的服务来获取twig html电子邮件并使用您的数据进行保存。例如,商店支付服务或其他服务将调用此服务。

现在针对您的问题,我认为您可以注入twig的模板部分而不是整个服务:

services:
    shop.payment.service:
        class: MyShopBundle\Service\PaymentService
        arguments: 
          - "@templating"

服务

use Symfony\Component\Templating\EngineInterface;

class MyPaymentService {
    protected $templating;

    public function __construct(EngineInterface $templating, ...) {
        $this->templating= $templating;
        ...
    }

    public function updatePaymentStatus(int userId) {
        // Update Payment
        ...

        // Send notification to user
        $mailBody = $this->templating->render('MyShopBundle:Emails:statusUpdate.html.twig', array('user_name' => $username));
        ...
    }