What to expect when Doctrine 3 comes out

WHAT TO EXPECT WHEN DOCTRINE 3 COMES OUT

@dbrumann / [email protected] 2

WHEN WILL IT BE RELEASED? @dbrumann / [email protected] 4

WHAT I WILL COVER… WHAT HAS CHANGED? HOW HAS IT
CHANGED? HOW TO ADAPT FOR THE CHANGE? @dbrumann / [email protected] 5

ONLY A SELECTION NO "UNDER THE HOOD"-DETAILS @dbrumann / [email protected]
6

THANKS TO 7

[email protected] 8

ROADMAP MAPPING UUID GENERATOR NAMED QUERIES NAMESPACE ALIASES PROXY OBJECTS
CLASS METADATA ENTITY MANAGER SECOND LEVEL CACHE @dbrumann / [email protected] 10

MAPPING @dbrumann / [email protected] 11

YAML-MAPPING IS DEPRECATED IN 2.6 WILL BE REMOVED IN DOCTRINE
3 SYMFONY BEST PRACTICES: ANNOTATIONS @dbrumann / [email protected] 15

use Doctrine\ORM\Mapping as ORM; @dbrumann / [email protected] 16

use Doctrine\ORM\Annotation as ORM; ANNOTATION-MAPPING @dbrumann / [email protected] 17

UUID GENERATOR @dbrumann / [email protected] 18

/** @ORM\Entity */ class Customer { /** * @ORM\Id *
@ORM\Column(type="guid") * @ORM\GeneratedValue(strategy="UUID") */ private $id; … @dbrumann / [email protected] 19

composer require ramsey/uuid-doctrine UUID GENERATOR @dbrumann / [email protected] 20

/** @ORM\Entity */ class Customer { /** * @ORM\Id *
@ORM\Column(type="uuid") * @ORM\GeneratedValue(strategy="NONE") */ private $id; public function __construct() { $this->id = Uuid::uuid4(); } public function getId(): string { return (string) $this->id; } @dbrumann / [email protected] 21

WILL BE REMOVED IN DOCTRINE 3 USE UUID-LIB (E.G. RAMSEY/UUID)
+ NONE-GENERATOR UUID GENERATOR @dbrumann / [email protected] 22

NAMED (NATIVE) QUERIES @dbrumann / [email protected] 23

class AddressController extends AbstractController { public function index(EntityManagerInterface $entityManager): Response
{ $repository = $entityManager->getRepository(Address::class); $addresses = $repository->createNativeNamedQuery('findAll') ->getResult(); return $this->render('addresses/index.html.twig', [ 'addresses' => $addresses, ]); } } @dbrumann / [email protected] 26

LIST OF REMOVED CLASSES Doctrine\ORM\Mapping\ NamedQueries NamedQuery NamedNativeQuery ColumnResult FieldResult
EntityResult SqlResultSetMappings SqlResultSetMapping @dbrumann / [email protected] 27

Doctrine\ORM\EntityManager:: createNamedQuery createNamedNativeQuery Doctrine\ORM\EntityRepository:: createNamedQuery createNamedNativeQuery LIST OF REMOVED METHODS

WORKS FOR NOW WILL BE REMOVED IN DOCTRINE 3 MOVE
LOGIC (E.G. TO REPOSITORY) NAMED QUERIES @dbrumann / [email protected] 29

NAMESPACE ALIASES @dbrumann / [email protected] 30

SELECT p FROM AppBundle:Product p WHERE p.price > :price @dbrumann
/ [email protected] 31

SELECT p FROM AppBundle\Entity\Product p WHERE p.price > :price' @dbrumann

Doctrine\ORM\Configuration:: addEntityNamespace getEntityNamespace setEntityNamespaces getEntityNamespaces Doctrine\ORM\Mappin\AbstractClassMetadataFactory:: getFqcnFromAlias LIST OF REMOVED
METHODS @dbrumann / [email protected] 33

POPULAR IN SYMFONY APPS < 3.x WILL BE REMOVED IN
DOCTRINE 3! USE FULLY QUALIFIED CLASS NAME ::CLASS NAMESPACE ALIASES @dbrumann / [email protected] 34

PROXY OBJECTS @dbrumann / [email protected] 35

/** @ORM\Entity(…) */ class Customer { … /** * @ORM\OneToMany(targetEntity="App\Entity\Address",
mappedBy="customer") */ private $addresses; … public function getAddresses() { return this->addresses; } } @dbrumann / [email protected] 36

A proxy object is an object that is put in
place or used instead of the "real" object. A proxy object can add behavior to the object being proxied without that object being aware of it. In Doctrine 2, proxy objects are used to realize several features but mainly for transparent lazy-loading. https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/advanced-configuration.html#proxy-objects PROXY OBJECTS @dbrumann / [email protected] 41

<?php namespace Proxies\__CG__\App\Entity; /** * DO NOT EDIT THIS FILE
- IT WAS CREATED BY DOCTRINE'S PROXY GENERATOR */ class Order extends \App\Entity\Order implements \Doctrine\ORM\Proxy\Proxy { /** * @var \Closure the callback responsible for loading properties in the proxy object. This callback is called with * three parameters, being respectively the proxy object to be initialized, the method that triggered the * initialization process and an array of ordered parameters that were passed to that method. * * @see \Doctrine\Common\Persistence\Proxy::__setInitializer */ public $__initializer__; /** * @var \Closure the callback responsible of loading properties that need to be copied in the cloned object * * @see \Doctrine\Common\Persistence\Proxy::__setCloner */ public $__cloner__; /** * @var boolean flag indicating if this object was already initialized * * @see \Doctrine\Common\Persistence\Proxy::__isInitialized */ public $__isInitialized__ = false; /** * @var array properties to be lazy loaded, with keys being the property * names and values being their default values * * @see \Doctrine\Common\Persistence\Proxy::__getLazyProperties */ 43

/** * * @return array */ public function __sleep() {
if ($this->__isInitialized__) { return ['__isInitialized__', '' . "\0" . 'App\\Entity\\Order' . "\0" . 'id', '' . "\0" . 'App\\Entity\\Order' . "\0" . 'items', '' . "\0" . 'App\\Entity\\Order' . "\0" . 'createdOn']; } return ['__isInitialized__', '' . "\0" . 'App\\Entity\\Order' . "\0" . 'id', '' . "\0" . 'App\\Entity\\Order' . "\0" . 'items', '' . "\0" . 'App\\Entity\\Order' . "\0" . 'createdOn']; } /** * */ public function __wakeup() { if ( ! $this->__isInitialized__) { $this->__initializer__ = function (Order $proxy) { $proxy->__setInitializer(null); $proxy->__setCloner(null); $existingProperties = get_object_vars($proxy); foreach ($proxy->__getLazyProperties() as $property => $defaultValue) { if ( ! array_key_exists($property, $existingProperties)) { $proxy->$property = $defaultValue; } } }; } } /** * */ 44

WILL BE REPLACED WITH PROXYMANAGER-LIB (HOPEFULLY) NO CODE CHANGES ON
YOUR PART PROXY OBJECTS @dbrumann / [email protected] 45

NO MORE FATAL ERRORS DUE TO MISSING PROXY CLASSES PROXY
OBJECTS @dbrumann / [email protected] 46

final METHODS ARE NOW ALLOWED __clone NO LONGER CALLED BY
ORM __wakeup NO LONGER CALLED BY ORM serialize() ⚠ RECURSIVE INITIALIZATION ACCESSING PRIVATE STATE WITH REFLECTION TRIGGERS LAZY-LOADING LAZY LOADING @dbrumann / [email protected] 47

CLASS METADATA @dbrumann / [email protected] 48

Doctrine\ORM\Mapping\ClassMetadata:: getQuotedColumnName getQuotedTableName getQuotedJoinTableName getQuotedIdentifierColumnNames LIST OF REMOVED METHODS @dbrumann

Quoting is now always called. Implement your own Doctrine\ORM\Mapping\NamingStrategy to
manipulate your schema, tables and column names to your custom desired naming convention. @dbrumann / [email protected] 50

LOTS MORE CHANGES AROUND CLASSMETADATA MOSTLY REORGANIZATION AND RENAMING CLASS
METADATA @dbrumann / [email protected] 52

ENTITY MANAGER @dbrumann / [email protected] 53

Doctrine\ORM\EntityManager:: flush($entity = null) merge($entity) detach($entity) copy($entity) ENTITY MANAGER @dbrumann

Doctrine\ORM\EntityManager:: flush($entity = null) merge($entity) detach($entity) copy($entity) @dbrumann / [email protected]
56

FLUSH() CAN BE COSTLY DATA INTEGRITY BUGS FLUSHING A SINGLE
ENTITY @dbrumann / [email protected] 57

USE ENTITYMANAGER::CLEAR() MORE OFTEN USE EXPLICIT CHANGE TRACKING POLICIES @dbrumann
/ [email protected] 58 FLUSHING A SINGLE ENTITY

DATA INTEGRITY ISSUES MERGE/DETACH @dbrumann / [email protected] 59

EntityManager::detach() → EntityManager::clear() DETACH @dbrumann / [email protected] 60

NO ALTERNATIVE PROVIDED SHOULD BE PART OF YOUR BUSINESS DOMAIN
MERGE @dbrumann / [email protected] 61

SECOND LEVEL CACHE @dbrumann / [email protected] 62

The Second Level Cache is designed to reduce the amount
of necessary database access. It sits between your application and the database to avoid the number of database hits as much as possible. SECOND LEVEL CACHE @dbrumann / [email protected] 63

The second level cache functionality is marked as experimental for
now. It is a very complex feature and we cannot guarantee yet that it works stable in all cases. SECOND LEVEL CACHE @dbrumann / [email protected] 64

QUERY CACHE RESULT CACHE SECOND LEVEL CACHE DIFFERENTIATION @dbrumann /
[email protected] 65

COMPONENTS QUERY CACHE CACHED ENTITY PERSISTER CACHED COLLECTION PERSISTER ENTITY
HYDRATOR COLLECTION HYDRATOR CACHE FACTORY @dbrumann / [email protected] 66

DATA IS STORED IN DIFFERENT CACHE REGIONS EACH REGION HAS
SPECIFIC NAMESPACE AND LIFETIME CACHE FOR QUERIES/COLLECTIONS ONLY CONTAINS IDENTIFIERS CACHE REGIONS @dbrumann / [email protected] 67

CACHES ARE NOT AWARE OF CHANGES TO PERSISTENT STORE BY
OTHER APPLICATIONS PAGINATION COUNT QUERIES ARE NOT CACHED NOT ALL CACHES WORK IN DISTRIBUTED ENVS LIMITATIONS @dbrumann / [email protected] 69

70 @dbrumann / [email protected]

71 @dbrumann / [email protected]

RECAP @dbrumann / [email protected] 72

RECAP MAPPING UUID GENERATOR NAMED QUERIES NAMESPACE ALIASES PROXY OBJECTS
CLASS METADATA ENTITY MANAGER SECOND LEVEL CACHE @dbrumann / [email protected] 73

MAPPING NO MORE YAML-MAPPING @dbrumann / [email protected] 74

ENTITY MANAGER BEHAVIOR CHANGES FOR FLUSH NO MORE DETACH, MERGE
& COPY @dbrumann / [email protected] 75

SECOND LEVEL CACHE "REPLACEMENT" FOR SINGLE ENTITY FLUSH, MERGE, DETACH

THANK YOU

What to expect when Doctrine 3 comes out

What to expect when Doctrine 3 comes out

More Decks by Denis Brumann

Other Decks in Programming

Featured

Transcript