10000 [Serializer] Cache the normalizer to use when possible by dunglas · Pull Request #10316 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[Serializer] Cache the normalizer to use when possible #10316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 12, 2018
Merged

[Serializer] Cache the normalizer to use when possible #10316

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ccdf894
[Serializer] Cache the normalizer to use when possible
dunglas Sep 10, 2018
8e09eeb
RST
dunglas Sep 10, 2018
8d6ca70
RST
dunglas Sep 10, 2018
3e2e30f
Minor reword
javiereguiluz Sep 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Minor reword
  • Loading branch information
@javiereguiluz
javiereguiluz authored Sep 12, 2018
commit 3e2e30f1e991cadacdab62e90441c55c79584c8a
27 changes: 13 additions & 14 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1304,23 +1304,22 @@ the :class:`Symfony\\Component\\Serializer\\Serializer` class will call the
(or :method:`Symfony\\Component\\Serializer\\Normalizer\\DenormalizerInterface::supportsDenormalization`)
of all registered normalizers (or denormalizers) in a loop.

The result of these methods can vary depending of the value of the object to serialize, of the format to
use, and of the context. Consequently, **it is not cached** by default.

Because they are called recursively, these methods are usually a huge performance bottleneck. Moreover, most
normalizers (and denormalizers) always return the same result when the object's type, and the format are
the same.

To hint the serializer that it's safe to cache the result of these methods (and then dramatically improve the
overall performance), such normalizers (and denormalizers) should implement the
:class:`Symfony\\Component\\Serializer\\Normalizer\\CacheableSupportsMethodInterface` and return ``true`` when
The result of these methods can vary depending on the object to serialize, the
format and the context. That's why the result **is not cached** by default and
can result in a significant performance bottleneck.

However, most normalizers (and denormalizers) always return the same result when
the object's type and the format are the same, so the result can be cached. To
do so, make those normalizers (and denormalizers) implement the
:class:`Symfony\\Component\\Serializer\\Normalizer\\CacheableSupportsMethodInterface`
and return ``true`` when
:method:`Symfony\\Component\\Serializer\\Normalizer\\CacheableSupportsMethodInterface::hasCacheableSupportsMethod`
is called.

.. note::

Built-in :ref:`normalizers and denormalizers <component-serializer-normalizers>`, as well the ones
included in `API Platform`_ natively implement this interface.
.. note::
All built-in :ref:`normalizers and denormalizers <component-serializer-normalizers>`
as well the ones included in `API Platform`_ natively implement this interface.

Learn more
----------
Expand Down
0