Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Symfony2 from the Trenches


Published on

Symfony2 from the Trenches presentation at Symfony Live 2011

Published in: Technology
  • Be the first to comment

Symfony2 from the Trenches

  1. 1. Symfony2 - From the Trenches by Lukas Kahwe Smith, Kris Wallsmith, Thibault Duplessis, Jeremy Mikola, Jordi Boggiano, Jonathan H. Wage, Bulat Shakirzyanov
  2. 2. AgendaGetting Setup CachingCode Flow Performance TipsDependency Injection Asset ManagementConfiguration Choices TestingController Choices DeploymentApplication Choices Third Party BundlesDoctrine Resources
  3. 3. Getting the works)PHP 5.3+ with ext/intl (compat lib is in setup Read check.php for details (dev/prod php.inis from Liip) Using OSX? php53-intl from liangzhenjing or build-entropy-php from chregu Blog post on installing PHP 5.3 with intl from Justin HilemanInitial setup symfony-sandbox symfony-bootstrap Symfony2ProjectRead the Coding Style Guide (Code Sniffer Rules)Managing external dependencies Submodule: not everything is in git (svn, mercurial, etc.) Vendor install/update scripts: risk of getting out of sync MR (not cross platform)
  4. 4. Code Flow1. Frontend Controller (web/app[_dev].php) Loads autoloader Creates/boots kernel Creates request (from globals) and passes to kernel2. Kernel Loads app config (app/config/config_[prod|dev|test]) Resolves URL path to a controller (go to 3.) Outputs response returned by the controller3. Controller Loads model and view Potentially creates a sub-request (go to 2.) Creates response and returns it
  5. 5. Execution Flow
  6. 6. Dependency InjectionAll objects are instantiated in one of two ways: Using the "new" operator Using an object factoryAll objects get collaborators in one of two ways Passed to object constructor Set using a setter
  7. 7. Application Using Dependency Injection
  8. 8. <?xml version="1.0" encoding="utf-8" ?><container xmlns="" xmlns:xsi=""> <parameters> <parameter key="sitemap.class">BundleAvalancheSitemapBundleSitemap</parameter> </parameters> <services> <service id="sitemap" class="%sitemap.class%" /> </services></container> Describe Your Services
  9. 9. <?phpclass cachedDevDebugProjectContainer extends Container{ /** * Gets the sitemap service. * * @return BundleAvalancheSitemapBundleSitemap */ protected function getSitemapService() { return $this->services[sitemap] = new BundleAvalancheSitemapBundleSitemap(); } /** * Gets the default parameters. * * @return array An array of the default parameters */ protected function getDefaultParameters() { return array( sitemap.class => BundleAvalancheSitemapBundleSitemap ); }} Service Definitions Are Dumped to Raw PHP
  10. 10. Dependency Injection ContainerBenefits: No performance loss Lazy instantiation Readable service configurationsGotchas: Can become hard to work with if the DI extension tries to do too much Be aware of circular dependencies Might lead to code that cannot be used outside of DIC
  11. 11. Circular Dependency Example
  12. 12. <?phpclass SomeClass{ private $container; public function __construct(ContainerInterface $container) <service id="some_service" class="SomeClass"> { <argument type="service" id="service_container" /> $this->container = $container; </service> } <!-- or --> // or <service id="some_service" class="SomeClass"> public function setContainer(ContainerInterface $container) <call method="setContainer"> { <argument type="service" id="service_container" /> $this->container = $container; </call> } </service> public function getDocumentManager() { return $this->container->get(document_manager); }} Container Injection
  13. 13. <?phpclass SomeClass{ private $documentManager; public function __construct(DocumentManager $documentManager) { $this->documentManager = $documentManager; } public function getDocumentManager() { return $this->documentManager; }}<service id="some_service" class="SomeClass"> <argument type="service" id="document_manager" /></service> Constructor Injection
  14. 14. <?phpclass SomeClass{ private $documentManager; public function setDocumentManager(DocumentManager $documentManager) { $this->documentManager = $documentManager; } public function getDocumentManager() { return $this->documentManager; }}<service id="some_service" class="SomeClass"> <call method="setDocumentManager"> <argument type="service" id="document_manager" /> </call></service> Setter Injection
  15. 15. <?phpinterface SomeInterface{ function setDocumentManager(DocumentManager $documentManager);}class SomeClass implements SomeInterface{ private $documentManager; public function setDocumentManager(DocumentManager $documentManager) { $this->documentManager = $documentManager; } public function getDocumentManager() { return $this->documentManager; }}<interface id="some_service" class="SomeInterface"> <call method="setDocumentManager"> <argument type="service" id="document_manager" /> </call></interface><service id="some_service" class="SomeClass" /> Interface Injection
  16. 16. Configuration ChoicesSymfony supports XML, YAML and PHP for configurationYAML and PHP uses underscore to separate wordsXML uses dashes to separate wordsXML attributes usually map to array values for YAML/PHPYAML merge key syntax to reuse pieces within a fileXSD-aware editors provide auto-completion and validationXML is recommended for Bundle/DI configurationYAML is recommended for application configurationDoctrine does not like it when you mix formats!
  17. 17. Controller ChoicesDefining Controllers as services is optional Non-service controllers must use container injection Create a Bundle Extension to load Bundle servicesIts recommended to not extend from the base Controller The base controller is mainly a tool for beginners It provides convenience methods that invoke services generateUrl(), redirect(), render()
  18. 18. Application ChoicesSecurity system makes it possible to have just oneapplication for both frontend and admin backendLocation of application is totally flexible, just update thefrontend controllers accordinglyLarge projects should use multiple applications Better separation when multiple teams work Facilitate step-by-step updating and refactoring For example: main, mobile, API, admin
  19. 19. Doctrine ExamplesRetrieve references to entity/document without DB queriesUsing raw SQL queries with Doctrine2 ORMSimple search engine with Doctrine MongoDB ODM
  20. 20. Retrieving References w/o DB Queries$tags = array(baseball, basketball);foreach ($tags as $tag) { $product->addTag($em->getReference(Tag, $tag));}
  21. 21. Raw SQL Queries$rsm = new ResultSetMapping;$rsm->addEntityResult(User, u);$rsm->addFieldResult(u, id, id);$rsm->addFieldResult(u, name, name);$query = $this->_em->createNativeQuery(SELECT id, nameFROM users WHERE name = ?, $rsm);$query->setParameter(1, romanb);$users = $query->getResult();
  22. 22. Simple Search Engineinterface HasKeywords{ function setKeywords(); function getKeywords();}
  23. 23. Simple Search Engine/** @mongodb:EmbeddedDocument */class Keyword{ // ... /** @mongodb:String @mongodb:Index */ private $keyword; /** @mongodb:Integer */ private $score; // ...}
  24. 24. Simple Search Engine/** @mongodb:Document */class Product implements HasKeywords{ /** @mongodb:Id */ private $id; /** @mongodb:String */ private $title; /** @mongodb:EmbedMany(targetDocument="Keyword") */ private $keywords = array(); // ...}
  25. 25. Simple Search Engineclass KeywordListener{ public function preUpdate(PreUpdateEventArgs $eventArgs) { $entity = $eventArgs->getEntity(); if ($entity instanceof HasKeywords) { $entity->setKeywords($this->buildKeywords($entity)); } } private function buildKeywords(HasKeywords $entity) { $keywords = array(); // build keywords from title, description, etc. return $keywords; }}
  26. 26. Simple Search Engine// find products by keyword$products = $dm->createQueryBuilder() ->field(keywords.keyword)->all($keywords) ->getQuery() ->execute();
  27. 27. Different Content Areas of a Page
  28. 28. Caching with Edge Side IncludesSymfony2 provides support for Edge Side Includes (ESI) Proxy assembles page from snippets of HTML Snippets can have different cache rules Develop without ESI, test with Symfony2 internal ESI proxy, deploy using ultra fast Varnish ProxyBreak up page into different controller actions based oncache invalidation rules Do not worry about overhead from multiple render calls Never mix content that has different cache timeouts Varnish Reverse Proxy Super fast, PHP cannot touch the performance Cache full pages for anonymous users Not just for HTML, also useful for JSON/XML API
  29. 29. Page Rendered Behind a Reverse Proxy
  30. 30. Performance TipsDump routes to apache rewrite rulesCache warmingDo not add optional services to controllersDo minimal work in the controller, let templates pulladditional data as neededUse a bytecode cache with MapFileClassLoader
  31. 31. Asset ManagementGo see Kriss talk later today!
  32. 32. TestingSymfony2 rocks for unit and functional testing because Dependency Injection No base classes, no static dependencies, no ActiveRecord Client fakes "real" requests for functional testingFunctional Testing Pros: Tests configuration, Tests API not implementationUnit Testing Pros: Pinpoints issues, Very directed TestingRecommendation: Functional testing is recommended for controller actions Symfony2 provides WebTestCase and BrowserKit Unit testing for complex algorithms, third party APIs too hard to mockUse LiipFunctionalTesting to load fixtures, validate HTML5
  33. 33. DeploymentDebian style aka Liip Debian Packager Write a manifest in YAML Build Debian packages with MAKE Install with apt-get install Server specific settings are asked during install, change later with dpkg-reconfigure Maintain a global overview of all application dependencies in case of (security) updates
  34. 34. Third Party Bundles @weaverryan Ryan WeaverHeres a new years resolution: to *always*work on an existing Symfony2 bundle andnever recreate my own. #focus #teamwork27 Dec
  35. 35. Third Party BundlesMany vendors have already published bundles: FriendsOfSymfony ( UserBundle (forked from knplabs DoctrineUserBundle) FacebookBundle (forked from kriswallsmith) Liip ( FunctionalTestBundle MultiplexBundle ViewBundle Sonata ( BaseApplicationBundleAdditionally, a few sites currently index community bundles:
  36. 36. Third Party BundlesBundles should follow the best practicesNo version-tagging or official package manager (yet)Use bundles by adding git submodules to your projectMaintain your own fork and "own" what you useNot all bundles are equally maintained Symfony2 API changes => broken bundles If you track fabpot/symfony, learn to migrate bundlesAvoid rewriting a bundles services/parameters directly The bundles DI extension should allow for such configuration; if not, submit a pull request If absolutely necessary, a CompilerPass is cleaner
  37. 37. Contributing to Third Party Bundles Similar to Symfony2s own patch guidlines Fork and add remote repository Merge regularly to keep up-to-date Avoid committing directly to your master Merges from upstream should be fast-forwards Once upstream changes are stable, bump your projects submodule pointer
  38. 38. Contributing to Third Party Bundles Create branches for patches and new features Cant wait to use this in your project? Temporarily change your project submodule to point to your branch until your pull request is accepted. Help ensure that your pull request merges cleanly Create feature branch based on upstreams master Rebase on upstreams master when finished
  39. 39. Contributing to Third Party Bundles Was your pull request accepted? Congratulations! Dont merge your feature branch into master! Doing so would cause your master to divert Merge upstreams master into your master Delete your feature branch Update your projects submodule to point to master
  40. 40. ResourcesIf you want to jump in and contribute: you are still fuzzy on Dependency Injection: you keep up with Fabiens Symfony2 repository: