Slide 1

Slide 1 text

Decoupling from the framework Jakub Zalas 7th of April 2014

Slide 2

Slide 2 text

@jakzal @jakub_zalas @SensioLabsUK £  

Slide 3

Slide 3 text

COUPLING

Slide 4

Slide 4 text

"MODULES ARE COUPLED IF CHANGING ONE OF THEM REQUIRES CHANGING ANOTHER ONE." http://martinfowler.com/ieeeSoftware/coupling.pdf Martin Fowler

Slide 5

Slide 5 text

tight coupling loose coupling

Slide 6

Slide 6 text

COUPLING AND COHESION

Slide 7

Slide 7 text

tight coupling low cohesion

Slide 8

Slide 8 text

loose coupling high cohesion

Slide 9

Slide 9 text

WHY IS TIGHT COUPLING BAD?

Slide 10

Slide 10 text

WHY IS LOOSE COUPLING GOOD?

Slide 11

Slide 11 text

REUSABILITY

Slide 12

Slide 12 text

READABILITY

Slide 13

Slide 13 text

MAINTENANCE

Slide 14

Slide 14 text

CHANGE

Slide 15

Slide 15 text

LOOSEN UP? How to

Slide 16

Slide 16 text

MAKE DEPENDENCIES EXPLICIT

Slide 17

Slide 17 text

class PackageCrawler { public function crawl($resource) { $browser = Browser::getInstance(); $response = $browser->get($resource); // @todo parse } }

Slide 18

Slide 18 text

use Buzz\Browser; class PackageCrawler { public function crawl($resource) { $browser = new Browser(); $response = $browser->get($resource); // @todo parse } }

Slide 19

Slide 19 text

DEPENDENCY INJECTION !

Slide 20

Slide 20 text

use Buzz\Browser; class PackageCrawler { private $browser; public function __construct(Browser $browser) { $this->browser = $browser; } public function crawl($resource) { $response = $this->browser->get($resource); // @todo parse } }

Slide 21

Slide 21 text

INJECT EXACTLY WHAT YOU NEED

Slide 22

Slide 22 text

use Buzz\Browser; class PackageCrawler { private $browser; public function __construct(Browser $browser) { $this->browser = $browser; } public function crawl($resource, Container $container) { $user = $container->get('security.context') ->getToken()->getUser(); $response = $this->browser->get( $resource, array('X-User' => $user->getId()) ); // @todo parse } }

Slide 23

Slide 23 text

https://twitter.com/iamtankist/status/359382451816112129

Slide 24

Slide 24 text

use Buzz\Browser; class PackageCrawler { private $browser; public function __construct(Browser $browser) { $this->browser = $browser; } public function crawl($resource, $userId) { $response = $this->browser->get( $resource, array('X-User' => $userId) ); // @todo parse } }

Slide 25

Slide 25 text

DON'T MIX LAYERS

Slide 26

Slide 26 text

use Buzz\Browser; use Symfony\Component\Console\Input\InputInterface; class PackageCrawler { private $browser; public function __construct(Browser $browser) { $this->browser = $browser; } public function crawl(InputInterface $input) { $response = $this->browser->get( $input->getOption('resource') ); // @todo parse } }

Slide 27

Slide 27 text

use Buzz\Browser; class PackageCrawler { private $browser; public function __construct(Browser $browser) { $this->browser = $browser; } public function crawl($resource) { $response = $this->browser->get( $resource ); // @todo parse } }

Slide 28

Slide 28 text

BI-DIRECTIONAL DEPENDENCIES ARE A SMELL

Slide 29

Slide 29 text

BREAK DEPENDENCIES

Slide 30

Slide 30 text

use Buzz\Browser; class PackageCrawler { private $browser; public function __construct(Browser $browser) { $this->browser = $browser; } public function crawl($resource) { $response = $this->browser->get($resource); // @todo parse } }

Slide 31

Slide 31 text

No content

Slide 32

Slide 32 text

No content

Slide 33

Slide 33 text

interface HttpClient { public function get($resource, array $headers = []); }

Slide 34

Slide 34 text

class PackageCrawler { private $httpClient; public function __construct(HttpClient $httpClient) { $this->httpClient = $httpClient; } public function crawl($resource) { $response = $this->httpClient->get($resource); // @todo parse } }

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

use Buzz\Browser; class BuzzClient implements HttpClient { private $browser; public function __construct(Browser $browser) { $this->browser = $browser; } public function get($resource, array $headers) { return (string) $this->browser->get( $resource, $headers ); } }

Slide 38

Slide 38 text

use Guzzle\Client; class GuzzleClient implements HttpClient { private $guzzle; public function __construct(Client $guzzle) { $this->guzzle = $guzzle; } public function get($resource, array $headers) { $request = $this->guzzle->createRequest( 'GET', $resource ); $response = $request->send(); return $response->getBody(); } }

Slide 39

Slide 39 text

DEFER DECISIONS

Slide 40

Slide 40 text

DEFER COMMITMENT

Slide 41

Slide 41 text

FRAMEWORK?

Slide 42

Slide 42 text

use Symfony\Bundle\FrameworkBundle\Controller\Controller; class SearchController extends Controller { public function searchAction(Request $request) { $keywords = $request->query->get('keywords'); $products = $this->getDoctrine() ->getRepository('Acme:Product') ->search($keywords); return $this->render( 'template.html.twig', array('products' => $products) ); } }

Slide 43

Slide 43 text

LAYERED ARCHITECTURE

Slide 44

Slide 44 text

https://www.goodreads.com/book/show/179133.Domain_driven_Design

Slide 45

Slide 45 text

CLEAN ARCHITECTURE

Slide 46

Slide 46 text

http://blog.8thlight.com/uncle-bob/2012/08/13/the-clean-architecture.html

Slide 47

Slide 47 text

SOURCE CODE DEPENDENCIES CAN ONLY POINT INWARDS

Slide 48

Slide 48 text

HEXAGONAL ARCHITECTURE a.k.a. PORTS AND ADAPTERS

Slide 49

Slide 49 text

Application Doctrine In memory UI Tests CLI

Slide 50

Slide 50 text

"Create your application to work without either a UI or a database […]" http://alistair.cockburn.us/Hexagonal+architecture

Slide 51

Slide 51 text

UI IS AN IMPLEMENTATION DETAIL

Slide 52

Slide 52 text

DATABASE IS AN IMPLEMENTATION DETAIL

Slide 53

Slide 53 text

FRAMEWORK IS AN IMPLEMENTATION DETAIL

Slide 54

Slide 54 text

No content

Slide 55

Slide 55 text

STEP 0 MAKE DEPENDENCIES EXPLICIT

Slide 56

Slide 56 text

use Doctrine\Common\Persistence\ManagerRegistry; use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface; class SearchController { private $templating; private $doctrine; public function __construct( EngineInterface $templating, ManagerRegistry $doctrine ) { $this->templating = $templating; $this->doctrine = $doctrine; } }

Slide 57

Slide 57 text

// .. class SearchController { // ... public function searchAction(Request $request) { $keywords = $request->query->get('keywords'); $repository = $this->doctrine ->getRepository('Acme:Product') ->search($keywords); return $this->templating->renderResponse( 'template.html.twig', array('products' => $products) ); } }

Slide 58

Slide 58 text

STEP 1 ONLY INJECT WHAT YOU ACTUALLY NEED

Slide 59

Slide 59 text

use Doctrine\Common\Persistence\ManagerRegistry; use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface; class SearchController { private $templating; private $doctrine; public function __construct( EngineInterface $templating, ManagerRegistry $doctrine ) { $this->templating = $templating; $this->doctrine = $doctrine; } }

Slide 60

Slide 60 text

use Acme\ProductBundle\Entity\ProductRepository; use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface; class SearchController { private $templating; private $repository; public function __construct( EngineInterface $templating, ProductRepository $repository ) { $this->templating = $templating; $this->repository = $repository; } }

Slide 61

Slide 61 text

// .. class SearchController { // ... public function searchAction(Request $request) { $keywords = $request->query->get('keywords'); $repository = $this->repository->search($keywords); return $this->templating->renderResponse( 'template.html.twig', array('products' => $products) ); } }

Slide 62

Slide 62 text

STEP 2 DON'T TALK TO THE INFRASTRUCTURE DIRECTLY

Slide 63

Slide 63 text

namespace Acme\ProductCatalog; interface ProductRepository { /** * @param string $keywords * * @return Product[] */ public function search($keywords); }

Slide 64

Slide 64 text

use Acme\ProductCatalog\ProductRepository; use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface; class SearchController { private $templating; private $repository; public function __construct( EngineInterface $templating, ProductRepository $repository ) { $this->templating = $templating; $this->repository = $repository; } }

Slide 65

Slide 65 text

No content

Slide 66

Slide 66 text

DON'T FOLLOW THE FRAMEWORK

Slide 67

Slide 67 text

$this->getDoctrine() ->getRepository('Acme:product') ->find($keywords);

Slide 68

Slide 68 text

MAKE IT OPTIONAL

Slide 69

Slide 69 text

A GOOD FRAMEWORK WILL HELP YOU

Slide 70

Slide 70 text

$this->repository->search($keywords); Acme:Product

Slide 71

Slide 71 text

DON'T START WITH THE FRAMEWORK

Slide 72

Slide 72 text

MAKE YOUR APPLICATION INDEPENDENT

Slide 73

Slide 73 text

AND THEN INTEGRATE IT WITH THE FRAMEWORK

Slide 74

Slide 74 text

REMEMBER!

Slide 75

Slide 75 text

TDD IS YOUR FRIEND

Slide 76

Slide 76 text

THANK YOU!

Slide 77

Slide 77 text

Credits