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 all commits
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
32 changes: 32 additions & 0 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1295,6 +1295,32 @@ can use this simpler configuration:
</class>
</serializer>

Performance
-----------

To figure which normalizer (or denormalizer) must be used to handle an object,
the :class:`Symfony\\Component\\Serializer\\Serializer` class will call the
:method:`Symfony\\Component\\Serializer\\Normalizer\\NormalizerInterface::supportsNormalization`
(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 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::

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 All @@ -1304,6 +1330,11 @@ Learn more

/serializer

.. seealso::

Normalizers for the Symfony Serializer Component supporting popular web API formats
(JSON-LD, GraphQL, HAL and JSONAPI) are available as part of the `API Platform`_ project.

.. seealso::

A popular alternative to the Symfony Serializer Component is the third-party
Expand All @@ -1320,3 +1351,4 @@ Learn more
.. _CSV: https://tools.ietf.org/html/rfc4180
.. _`RFC 7807`: https://tools.ietf.org/html/rfc7807
.. _`Value Objects`: https://en.wikipedia.org/wiki/Value_object
.. _`API Platform`: https://api-platform.com