khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 10:46:21 +07:00
Code Issues Packages Projects Releases Wiki Activity

feat(dev-manual): Document performance optimizations with class loaders

Browse Source 
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
This commit is contained in:
Christoph Wurst
2023-01-20 16:56:25 +01:00
parent 1cf714287e
commit f851c6ce90
2 changed files with 29 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
developer_manual/digging_deeper/classloader.rst
View File

@@ -10,7 +10,7 @@ The classloader is provided by Nextcloud and loads all your classes automaticall
PSR-4 autoloading
-----------------
Nextcloud uses a PSR-4 autoloader. The namespace **\\OCA\\MyApp**
Nextcloud uses a :ref:`PSR-0 autoloader<psr4>`. The namespace **\\OCA\\MyApp**
is mapped to :file:`/apps/myapp/lib/`. Afterwards normal PSR-4 rules apply, so
a folder is a namespace section in the same casing and the class name matches
the file name.
@@ -32,3 +32,26 @@ info.xml in the following way:
A second PSR-4 root is available when running tests. **\\OCA\\MyApp\\Tests** is
thereby mapped to :file:`/apps/myapp/tests/`.
.. _app-custom-classloader:
Replacing Nextcloud's autoloader
--------------------------------
Nextcloud's autoloader for apps is flexible and robust but not always the fastest. You can improve the loading speed of your app by shipping and optimizing a Composer class loader with the app.
First of all, familiarize yourself with the `Composer autoloader optimization options <https://getcomposer.org/doc/articles/autoloader-optimization.md>`_ and how they work. (Authoritative) class maps are a good fit for Nextcloud apps.
Once Composer is set up and class maps have been dumped, you can replace the generic Nextcloud class loader with the Composer class loader. This is done by placing a file at `composer/autoload.php`. If Nextcloud finds this file for an app, no generic class loader will be registered. The following contents will wire the file to Composer's generated ``autoloader.php`` file:
.. code-block:: php
:caption: composer/autoload.php
<?php
declare(strict_types=1);
require_once __DIR__ . '/../vendor/autoload.php';
.. note:: Make sure the auto loader is generated at release time and all files are included in the release tarball

5
developer_manual/digging_deeper/performance.rst
View File

@@ -8,6 +8,11 @@ This document introduces some common considerations and tips on improving perfor
.. note::**Tips welcome**: More tips and ideas on performance are very welcome!
PHP Performance
---------------
* Autoloader: Consider using an :ref:`optimized class loader<app-custom-classloader>`. The application code does not have to change for this optimization.
Database performance
--------------------