Upgrade to Pro — share decks privately, control downloads, hide ads and more …

IoC container - Dutch PHP Conference 2018

IoC container - Dutch PHP Conference 2018

Did you know your IoC container can do a whole lot more than just constructor injection? Besides that it is actually packed with features. Inflectors, resolving callbacks, aliasing, method invocation to name a few. In this talk you will learn how to leverage the power of a great container and service providers to write better, loosely coupled code. Well designed code put together by your IoC container will make your applications SOLID, modular, lean and decoupled from the framework!

Hannes Van De Vreken

June 09, 2018
Tweet

More Decks by Hannes Van De Vreken

Other Decks in Programming

Transcript

  1. IOC container
    @hannesvdvreken
    #dpc

    View Slide

  2. Hi, my name is Hannes.

    View Slide

  3. !

    View Slide

  4. IoC Container

    View Slide

  5. I
    O
    C

    View Slide

  6. International
    O
    C

    View Slide

  7. International
    Olympic
    C

    View Slide

  8. International
    Olympic
    Committee

    View Slide

  9. International
    Olympic
    Committee

    View Slide

  10. IoC Container

    View Slide

  11. IoC Container

    View Slide

  12. WHAT IS IOC?
    IoC == Inversion of Control

    View Slide

  13. WHAT IS IOC?
    class Service
    {
    public function __construct()
    {
    init();
    }
    public function init()
    {
    $config = config(‘ftpsettings…’);
    $this->ftp = new FTP(…);
    }
    public function calculate();
    }

    View Slide

  14. WHAT IS IOC?
    $service = $container->get(Service::class);
    $service->calculate();

    View Slide

  15. But first:
    Design patterns
    WHAT IS IOC?

    View Slide

  16. class Service
    {
    public function init()
    { // setup FTP
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?

    View Slide

  17. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?

    View Slide

  18. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Add caching to prevent hitting FTP over and over again
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?

    View Slide

  19. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Add caching to prevent hitting FTP over and over again
    // Log that FTP is accessed.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?

    View Slide

  20. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Add caching to prevent hitting FTP over and over again
    // Log that FTP is accessed.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?

    View Slide

  21. class FtpStorage
    {
    public function __construct(Ftp $ftp)
    {
    $this->ftp = $ftp;
    }
    public function get($key)
    {
    // Get it.
    // Cache it.
    // Log it.
    // Return it.
    }
    }
    WHAT IS IOC?

    View Slide

  22. class Service
    {
    public function __construct(FtpStorage $storage)
    {

    $this->storage = $storage;
    }
    public function calculate()
    {
    $value = $this->storage->get($key);
    return $calculate($value);
    }
    }
    WHAT IS IOC?

    View Slide

  23. interface Storage
    {
    public function get($key);
    }
    WHAT IS IOC?

    View Slide

  24. class FtpStorage implements Storage
    {
    public function __construct(Ftp $ftp)
    {
    $this->ftp = $ftp;
    }
    public function get($key)
    {

    }
    }
    WHAT IS IOC?

    View Slide

  25. class Service
    {
    public function __construct(Storage $storage)
    {

    $this->storage = $storage;
    }
    }
    WHAT IS IOC?

    View Slide

  26. class CacheDecorator implements Storage
    {
    public function __construct(Cache $cache, Storage $wrapped)
    {…}
    public function get($key)
    {
    return $this->cache->remember($key, 60, function () {
    return $this->wrapped->get($key);
    });
    }
    }
    WHAT IS IOC?

    View Slide

  27. class LogDecorator implements Storage
    {
    public function __construct(LoggerInterface $log, Storage $wrapped)
    {…}
    public function get($key)
    {
    $this->log->info('Retrieved value for '.$key);
    return $this->wrapped->get($key);
    }
    }
    WHAT IS IOC?

    View Slide

  28. class FtpStorage implements Storage
    {
    public function __construct(Ftp $ftp)
    {
    $this->ftp = $ftp;
    }
    public function get($key)
    {
    // Get it and return it.
    }
    }
    WHAT IS IOC?

    View Slide

  29. FtpStorage
    Service
    depends on
    depends on
    Ftp
    WHAT IS IOC?

    View Slide

  30. FtpStorage
    implements
    Storage
    Service
    depends on
    depends on
    Ftp
    WHAT IS IOC?

    View Slide

  31. FtpStorage
    Storage
    CacheDecorator
    Service
    LogDecorator
    S3Storage
    WHAT IS IOC?
    implements
    depends on

    View Slide

  32. WHAT IS IOC?
    FtpStorage
    Service
    depends on
    depends on
    Ftp
    FtpStorage
    implements
    Storage
    Service
    depends on
    depends on
    Ftp

    View Slide

  33. new Service($ftp);
    WHAT IS IOC?

    View Slide

  34. new Service(
    new CacheDecorator(
    $cache,
    new LogDecorator(
    $logger,
    new FtpStorage(
    new Ftp($settings)
    )
    )
    )
    );
    WHAT IS IOC?

    View Slide

  35. $container->get(Service::class);
    1) Make FtpStorage
    2) Wrap it with LogDecorator
    3) Wrap LogDecorator instance with CacheDecorator
    4) New up Service with CacheDecorator instance.
    WHAT IS IOC?

    View Slide

  36. Dependency inversion:
    Interface + implementation
    Dependency injection:
    Injecting `Storage` into `Service`
    Inversion of Control:
    The container builds your objects and calls them
    WHAT IS IOC?

    View Slide

  37. Inversion of Control
    IoC container to the rescue
    WHAT IS IOC?

    View Slide

  38. Let the IoC container help
    you with Composition
    WHAT IS IOC?

    View Slide

  39. symfony/dependency-injection
    illuminate/container
    aura/di
    zendframework/zend-di
    pimple/pimple
    league/container

    container-interop/container-interop
    psr/container (PSR-11)
    CONSTRUCTOR INJECTION

    View Slide

  40. View Slide

  41. PSR-11
    namespace Interop\Container;
    use Psr\Container\ContainerInterface as PsrContainer;
    interface ContainerInterface extends PsrContainer
    {

    }

    View Slide

  42. PSR-11
    namespace Psr\Container;
    interface ContainerInterface
    {
    public function get($id);
    public function has($id);
    }

    View Slide

  43. Automatic object resolution

    View Slide

  44. // League
    $container = new Container();
    $container->delegate(new ReflectionContainer());
    $listener = $container->get(SendInvoice::class);
    CONSTRUCTOR INJECTION

    View Slide

  45. Reflection
    CONSTRUCTOR INJECTION

    View Slide

  46. class SendInvoice
    {
    public function __construct(Mailer $mailer)
    {
    $this->mailer = $mailer;
    }
    public function listen(InvoiceGeneratedEvent $event)
    {

    }
    }
    CONSTRUCTOR INJECTION

    View Slide

  47. Constructor injection
    CONSTRUCTOR INJECTION

    View Slide

  48. (new \ReflectionClass($classname))
    ->getConstructor()
    ->getParameters();
    CONSTRUCTOR INJECTION

    View Slide

  49. Recursively
    CONSTRUCTOR INJECTION

    View Slide

  50. Auto wiring:
    - Symfony
    - Zend
    - Laravel
    - league/container
    - …
    CONSTRUCTOR INJECTION

    View Slide

  51. But what if our code is SOLID…
    The container can’t construct
    interfaces?
    CONSTRUCTOR INJECTION

    View Slide

  52. Helping the container
    (not standardized)

    View Slide

  53. Situation 1:
    When <> is type hinted,
    resolve <> instead
    REGISTRATION - BINDING

    View Slide

  54. Solution:
    Aliasing.
    REGISTRATION - BINDING

    View Slide

  55. $container->add(MailerInterface::class, function () {
    return $container->get(Mailer::class);
    });
    REGISTRATION - BINDING

    View Slide

  56. // Symfony
    $container->setAlias(MailerInterface::class, Mailer::class);
    // Laravel
    $container->alias(MailerInterface::class, Mailer::class);
    REGISTRATION - BINDING

    View Slide

  57. Situation 2:
    When <> has non-type hinted
    constructor arguments.
    REGISTRATION - BINDING

    View Slide

  58. Solution:
    Define dependencies.
    REGISTRATION - BINDING

    View Slide

  59. // League, et al.
    $container->add(Mailer::class, function () {
    return new Mailer($username, $password);
    });
    REGISTRATION - BINDING

    View Slide

  60. // Symfony
    $container->register(Mailer::class)
    ->addArgument($username)
    ->addArgument($password);
    REGISTRATION - BINDING

    View Slide

  61. Situation 3:
    When <> is type hinted,
    always return the exact same object.
    REGISTRATION - BINDING

    View Slide

  62. Example:
    Global state in a
    - Translator (user’s locale)
    - Entity Manager
    - Event dispatcher
    REGISTRATION - BINDING

    View Slide

  63. Solution:
    Sharing an instance.
    REGISTRATION - BINDING

    View Slide

  64. // League
    $container->share(EntityManagerInterface::class, function () {

    });
    // Laravel
    $container->singleton(EntityManagerInterface::class, function () {

    });
    // Symfony
    $container->register()->setShared(true);
    REGISTRATION - BINDING

    View Slide

  65. Situation 4:
    When different classes need a
    different object of the same
    interface.
    REGISTRATION - BINDING

    View Slide

  66. class PhotosController
    {
    public function __construct(FilesystemInterface $photos)
    {
    }
    }
    class FilesController
    {
    public function __construct(FilesystemInterface $files)
    {
    }
    }
    REGISTRATION - BINDING

    View Slide

  67. Solution:
    Contextual binding.
    REGISTRATION - BINDING

    View Slide

  68. // Laravel
    $container
    ->when(PhotosController::class)
    ->needs(FilesystemInterface::class)
    ->give('fs.photos');
    REGISTRATION - CONTEXTUAL BINDING

    View Slide

  69. // Laravel
    $container->bind('fs.photos', function () {});
    $container->bind('fs.files', function () {});
    REGISTRATION - BINDING

    View Slide

  70. // League
    $container->add('fs.photos', …);
    $container->add(PhotosController::class, function (
    $fs = $container->get('fs.photos');
    return new PhotosController($fs);
    });
    REGISTRATION - BINDING

    View Slide

  71. Situation 5:
    When resolving <>, do
    some setup.
    REGISTRATION - BINDING

    View Slide

  72. Example 1:
    When resolving the EntityManager,
    register some ModelListeners.
    REGISTRATION - BINDING

    View Slide

  73. Example 2:
    interface EnvironmentAware
    {
    public function setEnv($env);
    }
    trait EnvironmentAware
    {
    public function setEnv($env)
    {
    $this->env = $env;
    }
    }
    REGISTRATION - CONTAINER EVENTS

    View Slide

  74. Solution:
    Container events / inflection / hooks / …
    REGISTRATION - BINDING

    View Slide

  75. // League
    $container->inflector(EntityManager::class,
    function (EntityManager $em) {
    $em->getConfiguration()
    ->getEntityListenerResolver()
    ->register(new ModelListener());
    }
    );
    REGISTRATION - BINDING

    View Slide

  76. // Laravel
    $container->resolving(function (EnvironmentAware $object) {
    $object->setEnv(getenv('APP_ENV'));
    });
    REGISTRATION - CONTAINER EVENTS

    View Slide

  77. Also useful for:
    - Quickly injecting stuff
    REGISTRATION - CONTAINER EVENTS

    View Slide

  78. interface CommandBusAware
    trait CommandBusAware
    interface EventDispatcherAware
    trait EventDispatcherAware
    REGISTRATION - CONTAINER EVENTS

    View Slide

  79. Also useful for:
    - Quickly injecting stuff
    REGISTRATION - CONTAINER EVENTS

    View Slide

  80. Also useful for:
    - Quickly injecting stuff
    - Injecting soft dependencies
    REGISTRATION - CONTAINER EVENTS

    View Slide

  81. $container—>resolving(function (Mailer $mailer) {
    $mailer->setQueueResolver(function () {
    return $container->make(Queue::class);
    });
    );
    REGISTRATION - CONTAINER EVENTS

    View Slide

  82. Also useful for:
    - Quickly injecting stuff
    - Injecting soft dependencies
    REGISTRATION - CONTAINER EVENTS

    View Slide

  83. Also useful for:
    - Quickly injecting stuff
    - Injecting soft dependencies
    - Setting configurable values
    REGISTRATION - CONTAINER EVENTS

    View Slide

  84. $container->resolving(function (Validator) {
    $fileTypes = $container->get('config')->get(…)
    $validator->setAllowedFileTypes($fileTypes);
    );
    REGISTRATION - CONTAINER EVENTS

    View Slide

  85. Where to put all this?
    REGISTRATION

    View Slide

  86. Symfony:
    - Configuration files
    - Factories
    REGISTRATION

    View Slide

  87. container-interop/service-provider
    Similar:
    - league/container
    - illuminate/container
    REGISTRATION

    View Slide

  88. Using a container

    View Slide

  89. Retrieving objects
    CALLING THE CONTAINER

    View Slide

  90. // Psr\Container\ContainerInterface
    $container->has('fs');
    $container->get('fs');
    CALLING THE CONTAINER

    View Slide

  91. Retrieving objects, with arguments
    CALLING THE CONTAINER

    View Slide

  92. // League
    $container->add('fs', function ($args) {
    // Use $args[0] to see what folder to use.
    });
    $container->get('fs', ['images']);
    CALLING THE CONTAINER

    View Slide

  93. // League
    $container->add('fs.images', function () {
    return $container->get('fs', ['images']);
    });
    CALLING THE CONTAINER

    View Slide

  94. Calling functions, with resolved params
    CALLING THE CONTAINER

    View Slide

  95. // League & Laravel
    $container->call($closure);
    $container->call(function (Mailer $mailer) {});
    $container->call([$listener, 'handle']);
    $container->call('Listener::handle');
    CALLING THE CONTAINER

    View Slide

  96. (new ReflectionFunction($callback))
    ->getParameters();
    CALLING THE CONTAINER

    View Slide

  97. // Laravel
    $func = $container->wrap('Listener@handle');
    $func();
    CALLING THE CONTAINER

    View Slide

  98. public function wrap($callback) {
    return function () {
    $this->call($callback);
    };
    }
    CALLING THE CONTAINER

    View Slide

  99. Tagging
    CALLING THE CONTAINER

    View Slide

  100. Beware:
    Tagging in Symfony != Tagging in Laravel
    CALLING THE CONTAINER

    View Slide

  101. // Laravel
    $container->tag('fs.images', 'filesystem');
    $container->tag('fs.pdfs', 'filesystem');
    $filesystems = $container->tagged('filesystem');
    foreach ($filesystems as $filesystem) {

    }
    CALLING THE CONTAINER

    View Slide

  102. Preferably only in
    - Factories
    - Event Dispatchers
    - Router
    - Command Bus
    - …
    CALLING THE CONTAINER

    View Slide

  103. Bonus

    View Slide

  104. Solving circular
    dependencies
    BONUS - CIRCULAR DEPENDENCIES

    View Slide

  105. $mailer = new Mailer(QueueInterface $queue);
    $queue = new Queue(MailerInterface $mailer);
    BONUS - CIRCULAR DEPENDENCIES

    View Slide

  106. $mailer = new Mailer();
    $queue = new Queue(MailerInterface $mailer);
    $mailer->setQueueResolver($callable);
    BONUS CIRCULAR DEPENDENCIES

    View Slide

  107. $queue = $container->get(QueueInterface::class);
    // League
    $container->inflector(Mailer::class, function () {
    $mailer->setQueueResolver(function () {
    return $container->get(QueueInterface::class);
    });
    });
    BONUS CIRCULAR DEPENDENCIES

    View Slide

  108. Environment aware injection
    $container->bind(‘fs.photos’::class, function () {
    if (getenv(‘APP_ENV’) === ‘integration’) {
    // Fill in memory adapter
    // with integration testing files

    } else {
    // Normal connection to S3.
    }
    });
    BONUS - CIRCULAR DEPENDENCIES

    View Slide

  109. recap:
    Reflection
    Aliasing
    Soft dependencies
    Using container

    View Slide

  110. Thank you!
    @hannesvdvreken
    #dpc

    View Slide

  111. Time for
    questions.
    @hannesvdvreken
    #dpc

    View Slide