Slides from my talk presented during SymfonyLive London - 18 September 2015. More Domain-Driven Design related content at: https://domaincentric.net/

1. The IoC Hydra

2. Kacper Gunia @cakper
Technical Team Leader @SensioLabsUK
Symfony Certified Developer
PHPers Silesia @PHPersPL

3. CHAPTER 1: THE THEORY

4. THIS IS NOT YET ANOTHER
DEPENDENCY INJECTION TALK ;)

5. SO WE NEED SOME CLARIFICATION

6. IOC !== DI

7. –Pico Container
“Inversion of Control (IoC) is a design pattern
that addresses a component’s dependency
resolution, configuration and lifecycle. ”

8. –Pico Container
“It suggests that the control of those three
should not be the concern of the component
itself. Thus it is inverted back.”

9. –Pico Container
“Dependency Injection is where components
are given their dependencies through their
constructors, methods, or directly into fields.”

10. Inversion of Control
Dependency
Injection
Events
AOP

11. WHY DO WE IOC?

12. PROS
• Separation of concerns:
• dependency resolution, configuration and lifecycle
• Enforcing Single Responsibility Principle
• Easier testing
• Modular architecture, loose coupling

13. CONS
• Learning curve
• Code is harder do analyse/debug
• Moves complexity somewhere else (doesn’t remove)
• Need for extra tools like Containers / Dispatchers

14. HOW DO WE WRITE SOFTWARE
WITHOUT IOC?

15. EXAMPLE
interface FileEraser
{
public function erase($filename);
}

16. EXAMPLE
interface Logger
{
public function log($log);
}
class PrintingLogger implements Logger
{
public function log($log)
{
echo $log;
}
}

17. EXAMPLE
class LocalFileEraser implements FileEraser
{
public function erase($filename) {
$logger = new PrintingLogger();
$logger->log("Attempt to erase file: " . $filename);
unlink($filename);
$logger->log("File " . $filename . " was erased.”);
}
}

18. EXAMPLE
$eraser = new LocalFileEraser();
$eraser->erase('important-passwords.txt');

19. HOW CAN WE FIX IT WITH DI?

20. EXAMPLE WITH DI
class LocalFileEraser implements FileEraser
{
private $logger;
public function __construct(Logger $logger) {
$this->logger = $logger;
}
public function erase($path) {
$this->logger->log("Attempt to erase file: " . $path);
unlink($path);
$this->logger->log("File " . $path . " was erased.");
}
}

21. EXAMPLE WITH DI
$logger = new PrintingLogger();
$eraser = new LocalFileEraser($logger);
$eraser->erase('important-passwords.txt');

22. What (is being executed)
Known Unknown
KnownUnknown
When(isbeingexecuted)
Dependency
Injection
Stages of loosening control
(from the component point of view)

23. HOW CAN WE FIX IT WITH EVENTS?

24. EXAMPLE WITH EVENTS
interface Listener
{
public function handle(Event $event);
}
interface Event
{
}

25. EXAMPLE WITH EVENTS
class FileEvent implements Event
{
private $path;
public function __construct($path)
{
$this->path = $path;
}
public function getPath()
{
return $this->path;
}
}

26. EXAMPLE WITH EVENTS
class FileEraseWasInitialised extends FileEvent
{
}
class FileWasErased extends FileEvent
{
}

27. EXAMPLE WITH EVENTS
class LoggingFileEventListener implements Listener
{
private $logger;
public function __construct(Logger $logger)
{
$this->logger = $logger;
}
public function handle(Event $event)
{
if ($event instanceof FileEvent) {
$this->logger->log(get_class($event).' '.$event->getPath());
}
}
}

28. EXAMPLE WITH EVENTS
trait Observable
{
private $listeners = [];
public function addListener(Listener $listener)
{
$this->listeners[] = $listener;
}
public function dispatch(Event $event)
{
foreach ($this->listeners as $listener) {
$listener->handle($event);
}
}
}

29. EXAMPLE WITH EVENTS
class LocalFileEraser implements FileEraser
{
use Observable;
public function erase($filename)
{
$this->dispatch(new FileEraseWasInitialised($filename));
unlink($filename);
$this->dispatch(new FileWasErased($filename));
}
}

30. EXAMPLE WITH EVENTS
$eraser = new LocalFileEraser();
$listener = new LoggingFileEventListener(new PrintingLogger());
$eraser->addListener($listener);
$eraser->erase('important-passwords.txt');

31. What (is being executed)
Known Unknown
KnownUnknown
When(isbeingexecuted)
Events
Stages of loosening control
(from the component point of view)

32. HOW CAN WE FIX IT WITH AOP?

33. EXAMPLE WITH AOP USING DECORATOR
class LocalFileEraser implements FileEraser
{
public function erase($filename)
{
unlink($filename);
}
}

34. EXAMPLE WITH AOP USING DECORATOR
class LoggingFileEraser implements FileEraser
{
private $decorated;
private $logger;
public function __construct(FileEraser $decorated, Logger $logger)
{
$this->decorated = $decorated;
$this->logger = $logger;
}
public function erase($filename)
{
$this->logger->log('File erase was initialised' . $filename);
$this->decorated->erase($filename);
$this->logger->log('File was erased' . $filename);
}
}

35. EXAMPLE WITH AOP USING DECORATOR
$localFileEraser = new LocalFileEraser();
$logger = new PrintingLogger();
$eraser = new LoggingFileEraser($localFileEraser, $logger);
$eraser->erase('important-passwords.txt');

36. What (is being executed)
Known Unknown
KnownUnknown
When(isbeingexecuted)
AOP
Stages of loosening control
(from the component point of view)

37. What (is being executed)
Known Unknown
KnownUnknown
When(isbeingexecuted)
Dependency
Injection
Events
AOP
Stages of loosening control
(from the component point of view)

38. FRAMEWORKS & LIBRARIES

39. A libraries provide functionality that
you decide when to call.

40. Frameworks provide an architecture
for the application and
decide when to call your code.

41. “DON’T CALL US, WE’LL CALL YOU”
aka Hollywood Principle

42. Frameworks utilise IoC principles
and can be seen as one of its manifestations.

43. CHAPTER 2: THE PRACTICE

44. DEPENDENCY INJECTION
CONTAINERS

45. WHERE DIC CAN HELP

46. RESOLVING GRAPHS OF OBJECTS
$dsn = 'mysql:host=localhost;dbname=testdb;charset=utf8';
$dbUsername = 'username';
$dbPassword = 'password';
$customerRepository = new CustomerRepository(new PDO($dsn, $dbUsername, $dbPassword));
$smtpHost = 'smtp.example.org';
$smtpPort = 25;
$smtpUsername = 'username';
$smtpPassword = 'password';
$transport = new Swift_SmtpTransport($smtpHost, $smtpPort);
$transport->setUsername($smtpUsername);
$transport->setPassword($smtpPassword);
$mailer = new Swift_Mailer($transport);
$loggerName = "App";
$logger = new MonologLogger($loggerName);
$stream = "app.log";
$logger->pushHandler(new MonologHandlerStreamHandler($stream));
$controller = new RegistrationController($customerRepository, $mailer, $logger);

47. RESOLVING GRAPHS OF OBJECTS
use PimpleContainer;
$container = new Container();
$container['dsn'] = 'mysql:host=localhost;dbname=testdb;charset=utf8';
$container['db_username'] = 'username';
$container['dsn'] = 'password';
$container['pdo'] = function ($c) {
return new PDO($c['dsn'], $c['db_username'], $c['dsn']);
};
$container['customer_repository'] = function ($c) {
return new CustomerRepository($c['pdo']);
};

48. RESOLVING GRAPHS OF OBJECTS
$container['smtp_host'] = 'smtp.example.org';
$container['smtp_port'] = 25;
$container['smtp_username'] = 'username';
$container['smtp_password'] = 'password';
$container['transport'] = function ($c) {
return new Swift_SmtpTransport($c['smtp_host'], $c['smtp_port']);
};
$container->extend('transport', function ($transport, $c) {
$transport->setUsername($c['smtp_username']);
$transport->setPassword($c['smtp_password']);
return $transport;
});
$container['mailer'] = function ($c) {
return new Swift_Mailer($c['transport']);
};

49. RESOLVING GRAPHS OF OBJECTS
$container['logger_name'] = "App";
$container['stream_name'] = "app_" . $container['environment'] . ".log";
$container['logger'] = function ($c) {
return new MonologLogger($c['logger_name']);
};
$container->extend('transport', function ($logger, $c) {
$logger->pushHandler(
new MonologHandlerStreamHandler($c[‘stream_handler'])
);
return $logger;
});
$container['stream_handler'] = function ($c) {
return new MonologHandlerStreamHandler($c['stream_name']);
};

50. RESOLVING GRAPHS OF OBJECTS
$container['registration_controller'] = function ($c) {
return new RegistrationController(
$c['customer_repository'],
$c['mailer'],
$c[‘logger’]
);
};

51. LIFECYCLE MANAGEMENT
$container['session_storage'] = function ($c) {
return new SessionStorage('SESSION_ID');
};

52. LIFECYCLE MANAGEMENT
$container['session_storage'] = $container->factory(function ($c) {
return new SessionStorage('SESSION_ID');
});

53. WHERE DIC CAN HARM

54. SERVICE LOCATOR
class RegistrationController {
function resetPasswordAction() {
$mailer = Container::instance()['mailer'];
//...
}
}

55. SERVICE LOCATOR
• Coupled to container
• Responsible for resolving dependencies
• Dependencies are hidden
• Hard to test
• Might be ok when modernising legacy!

56. SETTER INJECTION

57. SETTER INJECTION
• Forces to be defensive as dependencies are optional
• Dependency is not locked (mutable)
• In some cases can be replaced with events
• We can avoid it by using NullObject pattern

58. SETTER INJECTION
class LocalFileEraser implements FileEraser
{
private $logger;
public function setLogger(Logger $logger)
{
$this->logger = $logger;
}
public function erase($filename)
{
if ($this->logger instanceof Logger) {
$this->logger->log("Attempt to erase file: " . $filename);
}
unlink($filename);
if ($this->logger instanceof Logger) {
$this->logger->log("File " . $filename . " was deleted");
}
}
}

59. SETTER INJECTION
class LocalFileEraser implements FileEraser
{
private $logger;
public function __construct(Logger $logger)
{
$this->logger = $logger;
}
public function erase($path)
{
$this->logger->log("Attempt to erase file: " . $path);
unlink($path);
$this->logger->log("File " . $path . " was erased.”);
}
}

60. SETTER INJECTION
class NullLogger implements Logger {
public function log($log)
{
// whateva...
}
}
$eraser = new LocalFileEraser(new NullLogger());
$eraser->erase('important-passwords.txt');

61. PARTIAL APPLICATION

62. DI WAY OF DOING THINGS
interface Logger
{
public function log($log);
}
class PrintingLogger implements Logger
{
public function log($log)
{
echo $log;
}
}

63. DI WAY OF DOING THINGS
class LocalFileEraser implements FileEraser
{
private $logger;
public function __construct(Logger $logger)
{
$this->logger = $logger;
}
public function erase($path)
{
$this->logger->log("Attempt to erase file: " . $path);
unlink($path);
$this->logger->log("File " . $path . " was deleted");
}
}

64. DI WAY OF DOING THINGS
$logger = new PrintingLogger();
$eraser = new LocalFileEraser($logger);
$eraser->erase('important-passwords.txt');

65. FUNCTIONAL WAY OF DOING THINGS
$erase = function (Logger $logger, $path)
{
$logger->log("Attempt to erase file: " . $path);
unlink($path);
$logger->log("File " . $path . " was deleted");
};

66. FUNCTIONAL WAY OF DOING THINGS
use ReactPartial;
$erase = function (Logger $logger, $path)
{
$logger->log("Attempt to erase file: " . $path);
unlink($path);
$logger->log("File " . $path . " was deleted");
};
$erase = Partialbind($erase, new PrintingLogger());
$erase('important-passwords.txt');

67. CHAPTER 3: THE SYMFONY

68. SYMFONY/DEPENDENCY-INJECTION

69. FEATURES
• Many configurations formats
• Supports Factories/Configurators/Scopes/Decoration
• Extendable with Compiler Passes
• Supports lazy loading of services

70. PERFORMANCE

71. PERFORMANCE OF SYMFONY DIC
• Cached/Dumped to PHP code
• In debug mode it checks whether config is fresh
• During Compilation phase container is being optimised

72. LARGE NUMBER OF
CONFIGURATION FILES
SLOWS CONTAINER BUILDER

74. SLOW COMPILATION
• Minimise number of bundles/config files used
• Try to avoid using extras like JMSDiExtraBundle
• Can be really painful on NFS

75. LARGE CONTAINERS
ARE SLOW TO LOAD
AND USE A LOT OF MEMORY

76. LARGE CONTAINERS
• Review and remove unnecessary services/bundles etc.
• Split application into smaller ones with separate kernels

77. PRIVATE SERVICES

79. PRIVATE SERVICES
• It’s only a hint for compiler
• Minor performance gain (inlines instations)
• Private services can still be fetched (not recommended)

80. LAZY LOADING OF SERVICES

81. LAZY LOADING OF SERVICES
• Used when instantiation is expensive or not needed
• i.e. event listeners
• Solutions:
• Injecting container directly
• Using proxy objects

82. INJECTING CONTAINER DIRECTLY
• As fast as it can be
• Couples service implementation to the container
• Makes testing harder

83. USING PROXY OBJECTS
• Easy to use (just configuration option)
• Code and test are not affected
• Adds a bit of overhead
• especially when services are called many times
• on proxy generation

84. DEFINING CLASS NAMES
AS PARAMETERS

85. DEFINING CLASS NAMES
AS PARAMETERS
• Rare use case (since decoration is supported even less)
• Adds overhead
• Will be removed in Symfony 3.0

86. CIRCULAR REFERENCES

88. Security
Listener
Doctrine
CIRCULAR REFERENCE

89. CIRCULAR REFERENCES
• Injecting Container is just a workaround
• Using setter injection after instantiation as well
• Solving design problem is the real challenge

90. Doctrine
Security
Listener
TokenStorage
BROKEN CIRCULAR REFERENCE

91. SCOPES

92. MEANT TO SOLVE
“THE REQUEST PROBLEM”

93. SCOPE DEFINES
STATE OF THE APPLICATION

94. PROBLEMS WITH INJECTING
REQUEST TO SERVICES

95. PROBLEMS WITH INJECTING
REQUEST TO SERVICES
• Causes ScopeWideningInjectionException
• Anti-pattern - Request is a Value Object
• Which means Container was managing it’s state
• Replaced with RequestStack

96. App
Controller A
Sub Request
Stateful
service
Sub
Request
Master Request
Stateful
service
Master
Request
Controller B
REQUESTS MANAGED WITH SCOPES

97. App
Controller A
Stateless
service
Request Stack
Controller B
Sub
Request
Master
Request
REQUESTS MANAGED WITH STACK

98. STATEFUL SERVICES

100. STATEFUL SERVICES
• Fetch state explicitly on per need basis (RequestStack)
• Use Prototype scope only if you have to…

101. PROTOTYPE SCOPE

103. Prototype scope
Prototype-
scoped
Service Z
Stateless
Service A
Prototype scope
Prototype-
scoped
Service Z
Stateless
Service A
Prototype scope
Prototype-
scoped
Service Z
Stateless
Service A
USING PROTOTYPE SCOPE WITH STRICT = TRUE

104. New Instances
Stateful
Service Z
Stateful
Service Z
Stateful
Service Z
Stateless
Service A
USING PROTOTYPE SCOPE WITH STRICT = FALSE

105. FORGET ABOUT SCOPES ANYWAY
WILL BE REMOVED IN SYMFONY 3.0
USE SHARED=FALSE INSTEAD

106. CONTROLLERS

108. EXTENDING BASE CONTROLLER
• Easy to use by newcomers / low learning curve
• Limits inheritance
• Encourages using DIC as Service Locator
• Hard unit testing

109. CONTAINER AWARE INTERFACE
• Controller is still coupled to framework
• Lack of convenience methods
• Encourages using DIC as Service Locator
• Testing is still hard

110. CONTROLLER AS A SERVICE
• Requires additional configuration
• Lack of convenience methods
• Full possibility to inject only relevant dependencies
• Unit testing is easy
• Enables Framework-agnostic controllers

111. NONE OF THE ABOVE OPTIONS WILL
FORCE YOU TO WRITE GOOD/BAD CODE

112. SYMFONY/EVENT-DISPATCHER

113. FEATURES
• Implementation of Mediator pattern
• Allows for many-to-many relationships between objects
• Makes your projects extensible
• Supports priorities/stopping event flow

114. EVENT DISPATCHER
• Can be (really) hard to debug
• Priorities of events / managing event flow
• Events can be mutable - indirect coupling
• Hard to test

115. INDIRECT COUPLING PROBLEM
• Two services listening on kernel.request event:
• Priority 16 - GeoIP detector - sets country code
• Priority 8 - Locale detector - uses country code and
user agent

116. INDIRECT COUPLING PROBLEM
• Both events indirectly coupled (via Request->attributes)
• Configuration change will change the app logic
• In reality we always want to call one after another

117. Listener A
Listener B
Listener C
DispatcherService
INDIRECT COUPLING PROBLEM

119. WHEN TO USE EVENT DISPATCHER
• Need to extend Framework or other Bundle
• Building reusable Bundle & need to add extension points
• Consider using separate dispatcher for Domain events

120. CHAPTER 4: THE END ;)

121. BE PRAGMATIC

122. BE EXPLICIT &
DON’T RELY ON MAGIC

123. Kacper Gunia @cakper
Technical Team Leader @SensioLabsUK
Symfony Certified Developer
PHPers Silesia @PHPersPL
Thanks!
https://joind.in/14979

124. REFERENCES
• http://martinfowler.com/bliki/InversionOfControl.html
• http://picocontainer.com/introduction.html
• http://www.infoq.com/presentations/8-lines-code-refactoring
• http://richardmiller.co.uk/2014/03/12/avoiding-setter-injection/
• http://art-of-software.blogspot.co.uk/2013/02/cztery-smaki-
odwracania-i-utraty.html