performance-classloading.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="performance.classloading">
  5. <title>Laden von Klassen</title>
  6. <para>
  7. Jeder der jemals Profiling von Zend Framework Anwendungen durchführen muß, wird sofort
  8. feststellen dass das Laden von Klassen relativ teuer ist im Zend Framework. Zwischen der
  9. reinen Anzahl von Klassendateien die für viele Komponenten geladen werden müssen, und der
  10. Verwendung von Plugins die keine 1:1 Verknüpfung zwischen Ihrem Klassennamen und dem
  11. Dateisystem haben, können die Aufrufe zu <methodname>include_once()</methodname> und
  12. <methodname>require_once()</methodname> problematisch sein. Diese Kapitel versucht einige
  13. konkrete Lösungen für diese Probleme zu geben.
  14. </para>
  15. <sect2 id="performance.classloading.includepath">
  16. <title>Wie kann ich meinen include_path optimieren?</title>
  17. <para>
  18. Eine triviale Optimierung die man machen kann um die Geschwindigkeit für das Laden der
  19. Klassen zu erhöhen ist es, auf den include_path besonders Rücksicht zu nehmen. Im
  20. speziellen, sollte man vier Dinge tun: Absolute Pfade verwenden (oder Pfade relativ zu
  21. absoluten Pfaden), die Anzahl der Include Pfade die man definiert reduzieren, den
  22. include_path von Zend Framework so früh wie möglich zu haben, und am Ende von
  23. include_path nur den aktuellen Verzechnispfad inkludieren.
  24. </para>
  25. <sect3 id="performance.classloading.includepath.abspath">
  26. <title>Absolute Pfade verwenden</title>
  27. <para>
  28. Auch wenn das wie eine Mikro-Optimierung aussieht, ist es Fakt das wenn man es
  29. nicht durchführt, die Vorteile von <acronym>PHP</acronym>'s RealPath Cache sehr
  30. klein sind, und als Ergebnis, das OpCode Caching nicht so schnell sein wird wie man
  31. erwarten könnte.
  32. </para>
  33. <para>
  34. Es gibt zwei einfache Wege um das Sicherzustellen. Erstens, kann man die Pfade in
  35. der <filename>php.ini</filename>, <filename>httpd.conf</filename>, oder
  36. <filename>.htaccess</filename> Hardcoded hineinschreiben. Zweitens, kann man
  37. <acronym>PHP</acronym>'s <methodname>realpath()</methodname> Funktion verwendet
  38. wenn man den include_path setzt:
  39. </para>
  40. <programlisting language="php"><![CDATA[
  41. $paths = array(
  42. realpath(dirname(__FILE__) . '/../library'),
  43. '.',
  44. );
  45. set_include_path(implode(PATH_SEPARATOR, $paths);
  46. ]]></programlisting>
  47. <para>
  48. Man <emphasis>kann</emphasis> relative Pfade verwenden -- solange Sie relativ zu
  49. einem absoluten Pfad sind:
  50. </para>
  51. <programlisting language="php"><![CDATA[
  52. define('APPLICATION_PATH', realpath(dirname(__FILE__)));
  53. $paths = array(
  54. APPLICATION_PATH . '/../library'),
  55. '.',
  56. );
  57. set_include_path(implode(PATH_SEPARATOR, $paths);
  58. ]]></programlisting>
  59. <para>
  60. Wie auch immer, selbst auf diese Art, ist es typischerweise eine triviale Aufgabe
  61. um den Pfad einfach an <methodname>realpath()</methodname> zu übergeben.
  62. </para>
  63. </sect3>
  64. <sect3 id="performance.classloading.includepath.reduce">
  65. <title>Die Anzahl der Include Pfade die man definiert reduzieren</title>
  66. <para>
  67. Include Pfade werden in der Reihenfolge in der Sie im include_path vorkommen
  68. durchsucht. Natürlich bedeutet das, das man ein Ergebnis schneller erhält wenn die
  69. Datei im ersten Scan gefunden wird, statt im letzten. Deswegen ist eine
  70. offensichtliche Verbesserung wenn man einfach die Anzahl der Pfade im include_path
  71. nur auf die reduziert die man benötigt. Man muß sich jeden include_path den man
  72. definiert hat anschauen, und feststellen ob aktuell irgendeine Funktionalität in
  73. diesem Pfad ist, die in der eigenen Anwendung verwendet wird; wenn nicht, dann
  74. entfernen Sie ihn.
  75. </para>
  76. <para>
  77. Eine weitere Optimierung ist es Pfade zu kombinieren. Zum Beispiel folgt Zend
  78. Framework der Namenskonvention von <acronym>PEAR</acronym>; deswegen kann man, wenn
  79. man <acronym>PEAR</acronym> Bibliotheken verwendet (oder Bibliotheken von anderen
  80. Frameworks oder Komponentenbibliotheken die dem <acronym>PEAR</acronym> CS folgen),
  81. versuchen alle diese Bibliotheken in den gleichen include_path zu geben. Das kann
  82. oft durchgeführt werden indem etwas einfaches wie ein SymLink auf eine oder mehrere
  83. Bibliotheken in ein generelles Verzeichnis gelegt wird.
  84. </para>
  85. </sect3>
  86. <sect3 id="performance.classloading.includepath.early">
  87. <title>Definiere den include_path zum Zend Framework so früh wie möglich</title>
  88. <para>
  89. Als Fortführung des vorherigen Vorschlags, ist eine weitere offensichtliche
  90. Optimierung die Definierung vom include_path vom Zend Framework so früh wie möglich
  91. im include_path. In den meisten Fällen sollte er der Erste in der Liste sein. Das
  92. stellt sicher das die Dateien die vom Zend Framework included werden schon beim
  93. Ersten Scan gefunden werden.
  94. </para>
  95. </sect3>
  96. <sect3 id="performance.classloading.includepath.currentdir">
  97. <title>Definiere das aktuelle Verzeichnis als letztes oder gar nicht</title>
  98. <para>
  99. Die meisten Beispiele von include_path zeigen die Verwendung des aktuellen
  100. Verzeichnisses oder '.'. Das ist üblich um sicherzustellen das Skripte die im
  101. gleichen Verzeichnis wie die Datei die Sie benötigt geladen werden können.
  102. Trotzdem, zeigen die gleichen Beispiele typischerweise dieses Pfadelement als
  103. erstes Element im include_path -- was bedeuetet das der aktuelle Verzeichnisbaum
  104. immer zuerst gescannt wird. In den meisten Fällen, wenn man Zend Framework
  105. Anwendungen hat, ist das nicht gewünscht, und der Pfad kann ohne Probleme als
  106. letztes Element in der Liste verschoben werden.
  107. </para>
  108. <example id="performance.classloading.includepath.example">
  109. <title>Beispiel: Optimierter include_path</title>
  110. <para>
  111. Fügen wir also alle diese Vorschläge zusammen. Unsere Annahme wird sein, das
  112. man ein oder mehrere <acronym>PEAR</acronym> Bibliotheken in Verbindung mit dem
  113. Zend Framework verwendet -- möglicherweise die PHPUnit und
  114. <classname>Archive_Tar</classname> Bibliotheken -- und das man
  115. offensichtlicherweise die Dateien relativ zur aktuellen Datei einfügen muß.
  116. </para>
  117. <para>
  118. Zuerst, erstellen wir ein Bibliotheksverzeichnis in unserem Projekt. Innerhalb
  119. dieses Verzeichnisses, erstellen wir einen Symlink zu unserer Zend Framework
  120. <filename>library/Zend</filename> Verzeichnis, wie auch dem notwendigen
  121. Verzeichnis von unserer <acronym>PEAR</acronym> Installation:
  122. </para>
  123. <programlisting language="php"><![CDATA[
  124. library
  125. Archive/
  126. PEAR/
  127. PHPUnit/
  128. Zend/
  129. ]]></programlisting>
  130. <para>
  131. Das erlaubt es und unseren eigenen Blbiliothekscode hinzuzufügen wenn das
  132. notwendig werden sollte, wärend andere verwendete Bibliotheken intakt bleiben.
  133. </para>
  134. <para>
  135. Als nächstes erstellen wir unseren include_path programmtechnisch in unserer
  136. <filename>public/index.php</filename> Datei. Das erlaubt es uns unseren Code in
  137. unserem Dateisystem zu verschieben, ohne das es notwendig ist jedesmal den
  138. include_path zu bearbeiten.
  139. </para>
  140. <para>
  141. Wir borgen uns Ideen von jedem der obigen Vorschläge aus: Wir verwenden
  142. absolute Pfade, die durch die Verwendung von
  143. <methodname>realpath()</methodname> erkannt werden; wir fügen den Zend
  144. Framework so früh wie möglich in den include_path ein; wir haben bereits
  145. Include Pfade erstellt; und wir geben das aktuelle Verzeichnis als letzten Pfad
  146. hinein. Faktisch, machen wir es hier sehr gut -- wir werden mit nur zwei Pfaden
  147. enden.
  148. </para>
  149. <programlisting language="php"><![CDATA[
  150. $paths = array(
  151. realpath(dirname(__FILE__) . '/../library'),
  152. '.'
  153. );
  154. set_include_path(implode(PATH_SEPARATOR, $paths));
  155. ]]></programlisting>
  156. </example>
  157. </sect3>
  158. </sect2>
  159. <sect2 id="performance.classloading.striprequires">
  160. <title>Wie kann man unnötige require_once Anweisungen entfernen?</title>
  161. <para>
  162. Lazy Loading ist eine Optimierungstechnik die entwickelt wurde um die teure Operation
  163. des Ladens einer Klassendatei bis zum Letztmöglichen Moment zu verzögern -- bzw., wenn
  164. ein Objekt dieser Klasse instanziiert wird, wenn eine statische Klassenmethode
  165. aufgerufen wird, oder wenn auf eine Klassenkonstante oder statische Eigenschaft
  166. referenziert wird. <acronym>PHP</acronym> unterstützt das durch Autoloading, welches es
  167. erlaubt ein oder mehrere Callbacks zu definieren die in Reihenfolge aufgerufen werden
  168. um einen Klassennamen mit einer Datei zu verbinden.
  169. </para>
  170. <para>
  171. Trotzdem sind die meisten Vorteile man Autoloading erwarten könnte, hinfällig wenn der
  172. Bibliothekscode weiterhin <methodname>require_once()</methodname> Aufrufe durchführt --
  173. was präzise der Fall ist beim Zend Framework. Die Frage ist also: Wie kann man diese
  174. <methodname>require_once()</methodname> Aufrufe entfernen um die Geschwindigkeit vom
  175. Autoloader zu maximieren?
  176. </para>
  177. <sect3 id="performance.classloading.striprequires.sed">
  178. <title>Aufrufe von require_once mit find und sed entfernen</title>
  179. <para>
  180. Ein einfacher Weg um <methodname>require_once()</methodname> Aufrufe zu entfernen
  181. ist die Verwendung der <acronym>UNIX</acronym> Utilities 'find' und 'set' in
  182. Verbindung um jeden Aufruf auszukommentieren. Führe die folgenden Anweisungen aus
  183. (wobei '%' der Shell Prompt ist):
  184. </para>
  185. <programlisting language="shell"><![CDATA[
  186. % cd path/to/ZendFramework/library
  187. % find . -name '*.php' -not -wholename '*/Loader/Autoloader.php' \
  188. -not -wholename '*/Application.php' -print0 | \
  189. xargs -0 sed --regexp-extended --in-place 's/(require_once)/\/\/ \1/g'
  190. ]]></programlisting>
  191. <para>
  192. Dieser Ein-Zeiler (wegen der Lesbarkeit in zwei Zeilen gebrochen) geht durch jede
  193. <acronym>PHP</acronym> Datei und sagt Ihr das jede Instanz von 'require_once' mit
  194. '// require_once' ersetzt werden soll, was jede dieser Anweisungen effektiv
  195. auskommentiert. (Es stellt sicher das <methodname>require_once()</methodname>
  196. Aufrufe innerhalb von <classname>Zend_Application</classname> und
  197. <classname>Zend_Loader_Autoloader</classname> bleiben, da diese Klassen ohne Sie
  198. nicht funktionieren.)
  199. </para>
  200. <para>
  201. Dieses Kommando sollte in einem automatischen Build oder Release Prozess ganz
  202. trivial hinzugefügt werden. Es sollte trotzdem klar sein das man, wenn man diese
  203. Technik verwendet, Autoloading verwendetn <emphasis>muss</emphasis>; man kann das
  204. von der eigenen "<filename>public/index.php</filename>" Datei mit dem folgenden
  205. Code tun:
  206. </para>
  207. <programlisting language="php"><![CDATA[
  208. require_once 'Zend/Loader/Autoloader.php';
  209. Zend_Loader_Autoloader::getInstance();
  210. ]]></programlisting>
  211. </sect3>
  212. </sect2>
  213. <sect2 id="performance.classloading.pluginloader">
  214. <title>Wie kann ich das Laden der Plugins beschleunigen?</title>
  215. <para>
  216. Viele Komponenten haben Plugins, welche es erlauben eigene Klassen zu Erstellen und in
  217. der Komponente zu verwenden, sowie bestehende Standardplugins vom Zend Framework, zu
  218. überladen. Das bietet eine wichtige Flexibilität für den Framework, aber zu einem
  219. Preis: Das Laden der Plugins ist eine recht teure Aufgabe.
  220. </para>
  221. <para>
  222. Der Pluginlader erlaubt es Klassenpräfixe / Pfadpaare zu registrieren, was es erlaubt
  223. Klassendateien in nicht-standard Pfaden zu spezifizieren. Jeder Präfix kann mehrere mit
  224. Ihm assoziierte Pfade haben. Intern durchläuft der Pluginlader jeden Präfix, und dann
  225. jeden Ihm angehängten Pfad, testet od die Datei existiert und unter diesem Pfad lesbar
  226. ist. Dann lädt er Sie, und testet ob die Klasse nach der er sucht vorhanden ist. Sie
  227. man sich vorstellen kann, kann das zu vielen Aufrufe auf das Dateisystem führen.
  228. </para>
  229. <para>
  230. Multipliziert mit der anzahl der Komponenten die den PluginLoader verwenden, und man
  231. bekommt eine Idee von der Reichweite des Problems. Zu der Zeit zu der das geschrieben
  232. wird, verwenden die folgenden Komponenten den PluginLoader:
  233. </para>
  234. <itemizedlist>
  235. <listitem>
  236. <para><classname>Zend_Controller_Action_HelperBroker</classname>: Helfer</para>
  237. </listitem>
  238. <listitem>
  239. <para>
  240. <classname>Zend_Dojo</classname>: View Helfer, Form Elemente und Dekorator
  241. </para>
  242. </listitem>
  243. <listitem>
  244. <para><classname>Zend_File_Transfer</classname>: Adapter</para>
  245. </listitem>
  246. <listitem>
  247. <para>
  248. <classname>Zend_Filter_Inflector</classname>: Filter (verwendet vom ViewRenderer
  249. Action Helfer und <classname>Zend_Layout</classname>)
  250. </para>
  251. </listitem>
  252. <listitem>
  253. <para><classname>Zend_Filter_Input</classname>: Filter und Prüfungen</para>
  254. </listitem>
  255. <listitem>
  256. <para>
  257. <classname>Zend_Form</classname>: Elemente, Prüfungen, Filter, Dekoratore,
  258. Captcha und File Transfer Adapter
  259. </para>
  260. </listitem>
  261. <listitem><para><classname>Zend_Paginator</classname>: Adapter</para></listitem>
  262. <listitem><para><classname>Zend_View</classname>: Helfer, Filter</para></listitem>
  263. </itemizedlist>
  264. <para>
  265. Wie kann man die Anzahl der so gemachten Aufrufe reduzieren?
  266. </para>
  267. <sect3
  268. id="performance.classloading.pluginloader.includefilecache">
  269. <title>Verwenden des PluginLoaders Include-File Caches</title>
  270. <para>
  271. Zend Framework 1.7.0 fügt einen Include-File Cache zum PluginLoader hinzu. Diese
  272. Funktionalität schreibt "<methodname>include_once()</methodname>" Aufrufe in eine
  273. Datei, welche man dann in der Bootstrap Datei einfügen (include) kann. Wärend das
  274. einen extra <methodname>include_once()</methodname> Aufruf im Code bedeutet, stellt
  275. es auch sicher das der PluginLoader so früh wie möglich zurückkehrt.
  276. </para>
  277. <para>
  278. Die PluginLoader Dokumentation
  279. <link linkend="zend.loader.pluginloader.performance.example"> enthält ein kompettes
  280. Beispiel seiner Verwendung</link>.
  281. </para>
  282. </sect3>
  283. </sect2>
  284. </sect1>