Lazy Services

Lazy Services

Why Lazy Services?

In some cases, you may want to inject a service that is a bit heavy to instantiate, but is not always used inside your object. For example, imagine you have a NewsletterManager and you inject a mailer service into it. Only a few methods on your NewsletterManager actually use the mailer, but even when you don't need it, a mailer service is always instantiated in order to construct your NewsletterManager.

Configuring lazy services is one answer to this. With a lazy service, a "proxy" of the mailer service is actually injected. It looks and acts just like the mailer, except that the mailer isn't actually instantiated until you interact with the proxy in some way.

Installation

In order to use the lazy service instantiation, you will first need to install the ocramius/proxy-manager package:

1
$ composer require ocramius/proxy-manager

Note

If you're not using the full-stack framework, you also have to install the ProxyManager bridge

1
$ composer require symfony/proxy-manager-bridge

Configuration

You can mark the service as lazy by manipulating its definition:

  • YAML
    1
    2
    3
    4
    services:
       app.twig_extension:
         class: AppBundle\Twig\AppExtension
         lazy:  true
    
  • XML
    1
    2
    3
    4
    5
    6
    7
    8
    9
    <?xml version="1.0" encoding="UTF-8" ?>
    <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">
    
        <services>
            <service id="app.twig_extension" class="AppBundle\Twig\AppExtension" lazy="true" />
        </services>
    </container>
    
  • PHP
    1
    2
    3
    4
    5
    6
    use Symfony\Component\DependencyInjection\Definition;
    
    $definition = new Definition('AppBundle\Twig\AppExtension');
    $definition->setLazy(true);
    
    $container->setDefinition('app.twig_extension', $definition);
    

Once you inject the service into another service, a virtual proxy with the same signature of the class representing the service should be injected. The same happens when calling Container::get() directly.

The actual class will be instantiated as soon as you try to interact with the service (e.g. call one of its methods).

To check if your proxy works you can simply check the interface of the received object:

dump(class_implements($service));
// the output should include "ProxyManager\Proxy\LazyLoadingInterface"

Note

If you don't install the ProxyManager bridge and the ocramius/proxy-manager, the container will just skip over the lazy flag and simply instantiate the service as it would normally do.

Additional Resources

You can read more about how proxies are instantiated, generated and initialized in the documentation of ProxyManager.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.