performance-classloading.xml 15 KB

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