Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Components
  4. Dependency Injection
  5. Lazy Services
WARNING: You are browsing the documentation for Symfony 2.3 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

Lazy Services

2.3 version
Unmaintained
2.3 2.4 2.5 2.6

Lazy Services

New in version 2.3: Lazy services were introduced in Symfony 2.3.

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 ProxyManager bridge:

1
$ composer require symfony/proxy-manager-bridge:~2.3

Note

If you’re using the full-stack framework, the proxy manager bridge is already included but the actual proxy manager needs to be included. So, run:

1
$ composer require ocramius/proxy-manager:~1.0

Afterwards compile your container and check to make sure that you get a proxy for your lazy services.

Configuration

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

  • YAML
    1
2
3
4
    services:
   foo:
     class: Acme\Foo
     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="foo" class="Acme\Foo" lazy="true" />
    </services>
</container>
  • PHP
    1
2
3
4
5
    use Symfony\Component\DependencyInjection\Definition;

$definition = new Definition('Acme\Foo');
$definition->setLazy(true);
$container->setDefinition('foo', $definition);

You can then require the service from the container:

$service = $container->get('foo');

At this point the retrieved $service should be a virtual proxy with the same signature of the class representing the service. You can also inject the service just like normal into other services. The object that’s actually injected will be the proxy.

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

1
var_dump(class_implements($service));

If the class implements the ProxyManager\Proxy\LazyLoadingInterface your lazy loaded services are working.

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.

The proxy gets initialized and the actual service is instantiated as soon as you interact in any way with this object.

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.