Alléger le nombre de requêtes les éléments d'un module Symfony : Différence entre versions

De e-glop
(gros nettoyage pour changement de version de symfony (?))
 
(4 révisions intermédiaires par le même utilisateur non affichées)
Ligne 36 : Ligne 36 :
 
   (...)
 
   (...)
  
== Solution pour la fiche ''prescription'' ==
+
== Solution générique pour tous les appels au modèle ==
  
=== Optimiser la classe ''Prescription'' ===
+
La problématique suivante vient du fait que très souvent, tout un ensemble d'informations externes au modèle unique appelé sont utilisées pour définir ce dernier. Prenons par exemple un organisme qui a des adhérents. Partout où nous aurons à faire à un organisme, nous aurons besoin soit du nombre d'adhérents, soit de leur liste, etc. Il est peu pratique de redéfinir à chaque fois la requête permettant d'optimiser l'accès à la base de données.
  
Nous allons préparer la classe PrescriptionTable pour lui donner la capacité à aller chercher (totalement ou non) automatiquement ses relations. Afin de pouvoir utiliser ces fonctionnalités, il faudra ensuite passer par la méthode '''Doctrine::getTable('Prescription')->getRecord()'''.
+
Ainsi, pour aller chercher systématiquement les informations connexes dont vous aurez besoin, il est possible de :
  
==== automatisé ====
+
=== Surcharger la méthode ''Doctrine_Table->createQuery()'' (simple) ===
  
'''lib/model/doctrine/PrescriptionTable.class.php''' (ne charge que les relations directes)
+
Prenons le modèle ''Organisme'' et ses ''Adherents' :
  
   (...)
+
   // lib/model/doctrine/OrganismeTable.class.php
   public function construct()
+
   class OrganismeTable
 
   {
 
   {
     $this->query = $this->createQuery('p');
+
     // (...)
     foreach($this->getRelations() as $key => $info)
+
    public function createQuery($alias = '')
      $this->query->leftJoin('p'.$key.' '.substr($key, 0, 3));
+
     {
 +
      $query = parent::createQuery($alias)
 +
        ->leftJoin($alias.'.Adherents');
 +
      return $query;
 +
    }
 +
    // (...)
 
   }
 
   }
 
 
  public function getRecords($criterias = null,$order_by = null)
 
  {
 
    if ( is_array($criterias) )
 
    foreach ( $criterias as $criteria => $value )
 
      $this->query->andWhere($criteria.' = ?',$value);
 
   
 
    if ( $order_by )
 
      $this->query->orderBy($order_by);
 
     
 
    return $this->query->execute();
 
  }
 
  (...)
 
  
==== manuel ====
+
C'est aussi simple que cela...
 +
 
 +
=== Surcharger la méthode ''Doctrine_Table->createQuery()'' (complexe) ===
  
'''lib/model/doctrine/PrescriptionTable.class.php''' (charge toutes les relations souhaitées)
+
Le problème survient lorsque vous aurez à manipuler plusieurs tables, jointes de manière relativement plus complexe que dans l'exemple précédent. La solution que nous pourrons retenir prendrait alors la forme suivante (sans préciser le schéma, puisqu'ici ce n'est que l'astuce qui est intéressante) :
  
   (...)
+
   // lib/model/doctrine/OrganismeTable.class.php
  public function construct()
+
   class OrganismeTable
  {
 
    $this->query = $this->createQuery('p')
 
      ->leftJoin('p.Beneficiaire b')
 
      ->leftJoin('p.Individu i')
 
      ->leftJoin('i.Prescripteur p2')
 
      ->leftJoin('p.PrestationsEntreprise pe')
 
      ->leftJoin('pe.Individu pei')
 
      ->leftJoin('pei.Entreprise e')
 
      ->leftJoin('p.Objectifs o')
 
      ->leftJoin('p.PrescriptionApres3mois pa3m')
 
      ->leftJoin('p.PrescriptionFormation pf')
 
      ->leftJoin('p.PrescriptionEmploi pem')
 
      ->orderBy('p.id DESC');
 
  }
 
 
 
   public function getRecords($criterias = null,$order_by = null)
 
 
   {
 
   {
     if ( is_array($criterias) )
+
     // (...)
     foreach ( $criterias as $criteria => $value )
+
     public function createQuery($alias = '')
       $this->query->andWhere($criteria.' = ?',$value);
+
    {
   
+
       $c = $alias != 'c' ? 'c' : 'c1';
    if ( $order_by )
+
       $p = $alias != 'p' ? 'p' : 'p1';
       $this->query->orderBy($order_by);
 
 
        
 
        
    return $this->query->execute();
+
      $query = parent::createQuery($alias)
 +
          ->leftJoin("$alias.Professionals $p")
 +
          ->leftJoin("$p.ProfessionalType")
 +
          ->leftJoin("$p.Contact $c")
 +
          ->orderBy("$alias.name, $c.name, $c.firstname, $p.name");
 +
      return $query;
 +
    }
 +
    // (...)
 
   }
 
   }
  (...)
 
 
=== Passer par l'appel PrescriptionTable::getRecords() pour obtenir l'objet ===
 
 
Dans les classes ayant pour des prescriptions en relation, sur-charger la fonction '''->getPrescriptions()''' (''Prescriptions'' étant défini dans le modèle de données) :
 
 
'''lib/model/doctrine/Individu.class.php'''
 
 
  (...)
 
  public function getPrescriptions()
 
  {
 
    return Doctrine::getTable('Prescription')->getRecords(
 
      array('individu_id' => $this->id),
 
      'id DESC'
 
    );
 
  }
 
  (...)
 
 
=== Dans les templates / partials ===
 
 
L'appel à la collection ''Prescriptions'' issu de l'objet courant ('''$object''') passera automatiquement par la fonction que vous avez défini... qui optimisera alors naturellement les objets ''Prescription'' contenus.
 
 
== Conclusion ==
 
 
Pour vérifier l'efficacité de notre solution, rechargeons la liste des prescriptions : nous sommes passé de 58 à 7 requêtes, et à un temps d'exécution proportionnel... Rechargeons maintenant une fiche prescription : nous sommes passé de 88 à 8 requêtes. CQFD.
 
 
== Améliorations possibles ==
 
 
Il faudrait maintenant automatiser la recherche des relations (manuelles ou non) lors de la création d'un objet, sans passer par la méthode '''MyclassTable::getRecords()'''. Si vous avez l'astuce, merci de [http://www.libre-informatique.fr/sw/04-Contact me contacter].
 
  
 
== Webographie et remerciements ==
 
== Webographie et remerciements ==
  
 
* [http://www.symfony-project.org/jobeet/1_2/Doctrine/fr/12#chapter_12_sub_table_method Practical Symfony, Jour 12 : L'Admin Generator]
 
* [http://www.symfony-project.org/jobeet/1_2/Doctrine/fr/12#chapter_12_sub_table_method Practical Symfony, Jour 12 : L'Admin Generator]
* Garfield-fr sur #symfony-fr @ freenode et son exemple (si les liens sont encore fonctionnels) :
+
* [http://www.funstaff.ch/ Garfield-fr] sur #symfony-fr @ freenode et ses excellents exemples
** [http://pastie.textmate.org/private/hsklo4ig3xdysdores2w schema.yml]
+
 
** [http://pastie.textmate.org/private/xupcmzyjepspctxbuo3p4a ArticleTable.class]
+
[[Catégorie:Informatique]]
** [http://pastie.textmate.org/private/jxoevv56s83bgkn5uuzsow actions.class.php]
 
** [http://pastie.textmate.org/private/qigdbvx8cdx9kdauuzafxw un partial pour exemple]
 

Version actuelle datée du 29 décembre 2010 à 13:06

Présentation de la problématique

Un module généré par doctrine:generate-admin dans Symfony génère un nombre de requêtes important et ralentit sensiblement le fonctionnement de votre application. Vous cherchez donc à optimiser la/les requête/s générées automatiquement, quitte à mettre les mains dans le code.

Ici l'exemple portera sur une liste de prescriptions auquelles sont associées un bénéficiaire et un individu. Cet individu est lui-même rattaché à un organisme prescripteur. Le nombre de requêtes générées sans intervention pour leur listing est au départ de 58 pour une pagination de 20 enregistrements. Pour la fiche prescription en édition, de 88.

Nous souhaitons afficher, pour résumer, les informations relatives à la prescription, ainsi que celles directement liées au bénéficiaire et au prescripteur (en passant par la table Individu qui est celle rattachée à notre table Prescription originelle).

Solution pour les listes generate-admin

Créer une requête personnalisée optimisée

Nous allons créer une requête permettant de retrouver l'ensemble des champs nécessaires à l'affichage de la liste, dans la classe PrescriptionTable du modèle. Ainsi dans le fichier lib/model/doctrine/PrescriptionTable.class.php :

 (...)
 public function retrieveInformationsForListing(Doctrine_Query $q)
 {
   $rootAlias = $q->getRootAlias();
   $q->leftJoin($rootAlias . '.Individu i')
     ->leftJoin('i.Prescripteur') 
     ->leftJoin($rootAlias . '.Beneficiaire b');
   return $q;
 }
 (...)

Déclaration de cette méthode dans le generator.yml

Il est maintenant nécessaire de déclarer l'utilisation de cette méthode au moment de la construction de la liste. Pour se faire, ajouter la ligne suivante dans le fichier apps/backend/modules/prescription/config/generator.yml :

 (...)
 config:
     list:
       title: Liste des prescriptions
       display: [=Beneficiaire, prescripteur]
       table_method: retrieveInformationsForListing
 (...)

Solution générique pour tous les appels au modèle

La problématique suivante vient du fait que très souvent, tout un ensemble d'informations externes au modèle unique appelé sont utilisées pour définir ce dernier. Prenons par exemple un organisme qui a des adhérents. Partout où nous aurons à faire à un organisme, nous aurons besoin soit du nombre d'adhérents, soit de leur liste, etc. Il est peu pratique de redéfinir à chaque fois la requête permettant d'optimiser l'accès à la base de données.

Ainsi, pour aller chercher systématiquement les informations connexes dont vous aurez besoin, il est possible de :

Surcharger la méthode Doctrine_Table->createQuery() (simple)

Prenons le modèle Organisme et ses Adherents' :

 // lib/model/doctrine/OrganismeTable.class.php
 class OrganismeTable
 {
   // (...)
   public function createQuery($alias = )
   {
      $query = parent::createQuery($alias)
        ->leftJoin($alias.'.Adherents');
      return $query;
   }
   // (...)
 }

C'est aussi simple que cela...

Surcharger la méthode Doctrine_Table->createQuery() (complexe)

Le problème survient lorsque vous aurez à manipuler plusieurs tables, jointes de manière relativement plus complexe que dans l'exemple précédent. La solution que nous pourrons retenir prendrait alors la forme suivante (sans préciser le schéma, puisqu'ici ce n'est que l'astuce qui est intéressante) :

 // lib/model/doctrine/OrganismeTable.class.php
 class OrganismeTable
 {
   // (...)
   public function createQuery($alias = )
   {
     $c = $alias != 'c' ? 'c' : 'c1';
     $p = $alias != 'p' ? 'p' : 'p1';
     
     $query = parent::createQuery($alias)
         ->leftJoin("$alias.Professionals $p")
         ->leftJoin("$p.ProfessionalType")
         ->leftJoin("$p.Contact $c")
         ->orderBy("$alias.name, $c.name, $c.firstname, $p.name");
     return $query;
   }
   // (...)
 }

Webographie et remerciements