performance-classloading.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. <!-- EN-Revision: 13910 -->
  2. <sect1 id="performance.classloading">
  3. <title>Chargement des classes</title>
  4. <para>Tous ceux qui ont déjà réalisé le profilage d'une application Zend Framework reconnaîtront immédiatement que
  5. le chargement des classes y est relativement coûteux. Entre le nombre important de fichier de classe qui doivent
  6. être chargées pour un grand nombre de composants et l'utilisation des plugins qui n'impliquent pas une relation 1:1
  7. entre leur nom de classe et le système de fichier, les différents appels de <code>include_once</code> et
  8. <code>require_once</code> peuvent être problématique. Ce chapitre a pour but de fournir des solutions concrètes pour
  9. solutionner ces problèmes.</para>
  10. <sect2 id="performance.classloading.includepath">
  11. <title>Comment optimiser mon include_path?</title>
  12. <para>Une optimisation triviale pour accélérer la vitesse de chargement des classes est de faire attention à
  13. votre <code>include_path</code>. En particulier, vous devriez faire quatre choses : utilisez des chemins absolus
  14. (ou des chemins relatifs à des chemins absolus), réduire le nombre des chemins à inclure, définir le dossier de
  15. Zend Framework le plus tôt possible dans l'<code>include_path</code> et inclure le dossier courant en dernier
  16. dans votre <code>include_path</code>.</para>
  17. <sect3 id="performance.classloading.includepath.abspath">
  18. <title>Utiliser des chemins absolus</title>
  19. <para>Tandis que ceci peut sembler une micro-optimisation, le fait est que si vous ne le faites pas, vous
  20. n'obtiendrez qu'un très petit avantage de la mise en cache du realpath de PHP, et en conséquence, le cache
  21. d'opcode ne fonctionnera pas tout à fait comme vous pourriez l'imaginer.</para>
  22. <para>Il y a deux manières simples de s'assurer de ceci. Premièrement, vous pouvez le mettre en dur dans
  23. votre <filename>php.ini</filename>, <filename>httpd.conf</filename>, ou <filename>.htaccess</filename>.
  24. Deuxièmement, vous pouvez utiliser la fonction <code>realpath()</code> de PHP au moment du paramétrage de
  25. votre <code>include_path</code> :</para>
  26. <programlisting role="php"><![CDATA[
  27. $paths = array(
  28. realpath(dirname(__FILE__) . '/../library'),
  29. '.',
  30. );
  31. set_include_path(implode(PATH_SEPARATOR, $paths);
  32. ]]></programlisting>
  33. <para>Vous <emphasis>pouvez</emphasis> utiliser des chemins relatifs - du moment qu'ils sont relatifs à un
  34. chemin absolu :</para>
  35. <programlisting role="php"><![CDATA[
  36. define('APPLICATION_PATH', realpath(dirname(__FILE__)));
  37. $paths = array(
  38. APPLICATION_PATH . '/../library'),
  39. '.',
  40. );
  41. set_include_path(implode(PATH_SEPARATOR, $paths);
  42. ]]></programlisting>
  43. <para>Néanmoins, c'est typiquement une tâche insignifiante de fournir simplement le chemin à
  44. <code>realpath()</code>.</para>
  45. </sect3>
  46. <sect3 id="performance.classloading.includepath.reduce">
  47. <title>Réduire le nombre de dossier défini dans l'include_path</title>
  48. <para>Les chemins d'inclusion sont scannés dans l'ordre dans lequel ils apparaissent dans
  49. l'<code>include_path</code>. Évidemment, ceci veut dire que vous aurez un résultat plus rapide si le fichier
  50. est trouvé dans le premier chemin scanné que si vous le trouvez dans le dernier chemin scanné. De plus, une
  51. amélioration plutôt évidente est de diminuer tout simplement le nombre de chemins dans votre
  52. <code>include_path</code> à seulement de ce que vous avez réellement besoin. Regardez chaque chemin que vous
  53. avez défini dans votre include_path pour déterminer si vous avez réellement besoin d'une fonctionnalité dans
  54. votre application ; si ce n'est pas le cas, enlevez le.</para>
  55. <para>Une autre optimisation consiste en la combinaison de chemins. Par exemple, Zend Framework suit la
  56. convention de nommage PEAR ; ainsi , si vous utilisez des librairies PEAR (ou d'autres framework ou
  57. librairies de composants qui respectent la convention de nommage PEAR), essayez de mettre toutes ces
  58. librairies dans le même chemin de l'<code>include_path</code>. Ceci peut souvent être réalisé par quelque
  59. chose d'assez simple comme de créer des liens symboliques vers une ou plusieurs bibliothèques dans un
  60. dossier commun.</para>
  61. </sect3>
  62. <sect3 id="performance.classloading.includepath.early">
  63. <title>Définir le dossier de Zend Framework le plus tôt possible dans l'include_path</title>
  64. <para>Pour continuer avec les suggestions précédentes, une autre optimisation évidente est de définir le
  65. dossier de Zend Framework le plus tôt possible dans votre <code>include_path</code>. Dans la plupart des
  66. cas, il devrait être le premier de la liste. Ceci permet de s'assurer les fichiers de Zend Framework à
  67. inclure le sont dès le premier scan.</para>
  68. </sect3>
  69. <sect3 id="performance.classloading.includepath.currentdir">
  70. <title>Définir le dossier courant le plus tard possible ou pas du tout</title>
  71. <para>La plupart des exemples d'<code>include_path</code> montre l'utilisation du répertoire courant
  72. ("<code>.</code>"). Ceci est pratique pour s'assurer que les scripts dans le même dossier que le fichier
  73. courant peuvent aussi être chargés. Cependant ces mêmes exemples montrent souvent ce dossier comme étant le
  74. premier de la liste des include_path - ce qui veut dire l'arbre de dossiers courant est toujours scanné en
  75. premier. La plupart du temps, avec Zend Framework, ce n'est pas nécessaire, et ce dossier peut tout
  76. naturellement être mis en dernière position de la liste.</para>
  77. <example id="performance.classloading.includepath.example">
  78. <title>Exemple : optimisation de l'include_path</title>
  79. <para>Essayons de mettre ensemble toutes ces suggestions. Considérons que nous utilisons une ou
  80. plusieurs composants PEAR en conjonction avec Zend Framework - par exemple les composants PHPUnit et
  81. Archive_Tar - et qu'il est occasionnellement nécessaire d'inclure les fichiers relativement au fichier
  82. courant.</para>
  83. <para>Premièrement, nous allons créer un dossier pour les librairies dans notre projet. Dans ce même
  84. dossier, nous allons créer un lien symbolique vers notre dossier Zend Framework
  85. "<filename>library/Zend</filename>", ainsi que les dossiers nécessaires dans notre installation PEAR
  86. :</para>
  87. <programlisting role="php"><![CDATA[
  88. library
  89. Archive/
  90. PEAR/
  91. PHPUnit/
  92. Zend/
  93. ]]></programlisting>
  94. <para>Ceci nous permet d'ajouter notre propre librairie si nécessaire, tout en laissant intact les
  95. librairies partagées.</para>
  96. <para>Ensuite, nous optons pur la création de notre <code>include_path</code> par programme à
  97. l'intérieur de notre fichier <filename>public/index.php</filename>. Ceci nous permet de déplacer notre
  98. code dans le système de fichiers, sans devoir éditer l'<code>include_path</code> à chaque fois.</para>
  99. <para>Nous emprunterons des idées à chacune des suggestions ci-dessus : nous utiliserons les chemins
  100. absolus, déterminé en utilisant le <code>realpath()</code> ; nous positionnerons Zend Framework au
  101. plus tôt dans l'<code>include_path</code> ; nous avons déjà vérifié les chemins d'inclusions nécessaires
  102. ; et nous mettrons le dossier courant comme dernier chemin. En fait, nous faisons tout bien ici - nous
  103. allons donc terminer avec seulement deux chemins. </para>
  104. <programlisting role="php"><![CDATA[
  105. $paths = array(
  106. realpath(dirname(__FILE__) . '/../library'),
  107. '.'
  108. );
  109. set_include_path(implode(PATH_SEPARATOR, $paths));
  110. ]]></programlisting>
  111. </example>
  112. </sect3>
  113. </sect2>
  114. <sect2 id="performance.classloading.striprequires">
  115. <title>Comment éliminer les déclarations require_once non nécessaires ?</title>
  116. <para>Le chargement tardif ("lazy loading") est une technique d'optimisation conçue pour repousser l'opération
  117. coûteuse de chargement d'une classe jusqu'au dernier moment possible - c'est-à-dire lors de l'instanciation d'un
  118. objet de cette classe, ou lors de l'utilisation d'une constante de classe ou d'une propriété statique. PHP
  119. supporte tout ceci via l'autoloading (ou "chargement automatique"), ce qui vous permet de définir un ou
  120. plusieurs callbacks à exécuter dans le but de faire correspondre un nom de classe à un fichier.</para>
  121. <para>Cependant, la plupart des avantages que vous pourrez retirer de l'autoloading sont diminués si le code de
  122. votre librairie exécute toujours des appels à <code>require_once</code> - ce qui est précisément le cas de Zend
  123. Framework. La question est donc : comment éliminer ces déclarations <code>require_once</code> dans le but de
  124. maximiser les performances de l'autoloader.</para>
  125. <sect3 id="performance.classloading.striprequires.sed">
  126. <title>Effacer les appels de require_once avec find et sed</title>
  127. <para>Une manière simple d'effacer les appels require_once est d'utiliser les utilitaires Unix "find" en
  128. conjonction avec "sed" pour passe en commentaires tous les appels. Essayez d'exécuter les commandes
  129. suivantes (où "%" indique le prompteur shell) :</para>
  130. <programlisting role="shell"><![CDATA[
  131. % cd chemin/vers/la/librarie/ZendFramework
  132. % find . -name '*.php' -print0 | xargs -0 \
  133. sed --regexp-extended --in-place 's/(require_once)/\/\/ \1/g'
  134. ]]></programlisting>
  135. <para>Cette ligne unique (coupée en deux pour la lisibilité) itère parmi les fichiers PHP et y remplace
  136. toute les instances de <code>require_once</code> par <code>//require_once</code>, c'est-à-dire en commentant
  137. toutes ces lignes.</para>
  138. <para>Cette commande peut être simplement ajoutée à un script de construction automatique ou à un processus
  139. de mise en production, permettent ainsi d'augmenter les performances de votre application en production. Il
  140. est à noter, cependant, que si vous utilisez cette technique, vous <emphasis>devez</emphasis> utiliser
  141. l'autoloading ; vous pouvez l'activer dans votre fichier <filename>public/index.php</filename> en ajoutant
  142. le code suivant :</para>
  143. <programlisting role="php"><![CDATA[
  144. require_once 'Zend/Loader.php'; // ce require_once reste cependant nécessaire
  145. Zend_Loader::registerAutoload();
  146. ]]></programlisting>
  147. </sect3>
  148. </sect2>
  149. <sect2 id="performance.classloading.pluginloader">
  150. <title>Comment accélérer le chargement des plugins ?</title>
  151. <para>Certains composants utilisent les plugins, ce qui vous permet de créer vos propres classes afin de les
  152. utiliser avec le composant, de même que de surcharger les plugins standard existants embarqués dans Zend
  153. Framework. Ceci fournit une importante flexibilité au framework, mais a un prix : le chargement des plugins est
  154. une tâche assez coûteuse.</para>
  155. <para>Le chargeur de plugins vous permet de définir des paires préfixe de classe / chemin, vous autorisant ainsi
  156. à spécifier des fichiers de classe dans des chemins de dossiers non standard. Chaque préfixe peut avoir de
  157. multiples chemins associés. En interne, le chargeur de plugins boucle à travers chaque préfixe, et ensuite à
  158. travers chaque chemin lui étant associé, en testant l'existence du fichier et s'il est accessible dans ce
  159. chemin. Il le charge ensuite, et teste pour voir si la classe recherchée est bien disponible. Comme vous pouvez
  160. l'imaginer, tout ceci entraîne des appels aux stats du système de fichiers.</para>
  161. <para>Multipliez ceci par le nombre de composants qui utilisent le PluginLoader, et vous aurez une idée de
  162. l'importance de ce problème. Au moment de l'écriture de ce document, les composants suivants utilisent le
  163. PluginLoader :</para>
  164. <itemizedlist>
  165. <listitem>
  166. <para><classname>Zend_Controller_Action_HelperBroker</classname> : aides d'action</para>
  167. </listitem>
  168. <listitem>
  169. <para><classname>Zend_Dojo</classname> : aides de vues, éléments de formulaires et décorateurs</para>
  170. </listitem>
  171. <listitem>
  172. <para><classname>Zend_File_Transfer</classname> : adaptateurs</para>
  173. </listitem>
  174. <listitem>
  175. <para><classname>Zend_Filter_Inflector</classname> : filtres (utilisé par l'aide d'action
  176. <code>ViewRenderer</code> et <classname>Zend_Layout</classname>)</para>
  177. </listitem>
  178. <listitem>
  179. <para><classname>Zend_Filter_Input</classname> : filtres et validateurs</para>
  180. </listitem>
  181. <listitem>
  182. <para><classname>Zend_Form</classname> : éléments, validateurs, filtres, décorateurs, captcha et adaptateur pour
  183. les transferts de fichiers</para>
  184. </listitem>
  185. <listitem>
  186. <para><classname>Zend_Paginator</classname> : adaptateurs</para>
  187. </listitem>
  188. <listitem>
  189. <para><classname>Zend_View</classname> : aides de vues, filtres</para>
  190. </listitem>
  191. </itemizedlist>
  192. <para>Comment réduire le nombre des appels réalisés ?</para>
  193. <sect3 id="performance.classloading.pluginloader.includefilecache">
  194. <title>Utiliser le fichier de cache des inclusions du PluginLoader</title>
  195. <para>Zend Framework 1.7.0 ajoute un fichier de cache des inclusions au PluginLoader. Cette fonctionnalité
  196. écrit dans un fichier les appels "<code>include_once</code>", que vous pouvez ensuite inclure dans votre
  197. fichier d'amorçage. Même si ceci introduit de nouveaux appels include_once dans votre code, cela permet de
  198. s'assurer que le PluginLoader les retournera au plus vite.</para>
  199. <para>La documentation du PluginLoader <link linkend="zend.loader.pluginloader.performance.example">inclue
  200. un exemple complet de son utilisation</link>.</para>
  201. </sect3>
  202. </sect2>
  203. </sect1>
  204. <!--
  205. vim:se ts=4 sw=4 et:
  206. -->