Service Autoconfiguration Using Attributes¶
Contributed by
Nicolas Grekas
in #39804.
Service autoconfiguration allows to automatically apply certain configuration to your services, based on your service’s class. This is useful for example to apply certain service tag to classes that implement some interface (e.g. when you create a class implementing Twig\Extension\AbstractExtension, Symfony applies the twig.extension tag to it so you can use it without configuring it). PHP attributes are one of the best new features introduced in PHP 8. They allow to add machine-readable metadata to your code. That’s why in Symfony 5.3 we’ve combined both to allow autoconfigure services using PHP attributes. In previous Symfony versions, you could add the following to your kernel or dependency injection extension: 1 2$container->registerForAutoconfiguration(SomeInterface::class) ->addTag('app.some_tag'); In Symfony 5.3 you can remove this configuration if you like and use instead the
[Autoconfigure] attribute on the PHP interface:
1 2 3 4 5 6 7 8 9 10# src/SomeNamespace/SomeInterface.php namespace App\SomeNamespace; use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
[Autoconfigure(tags: ['app.some_tag'])]
interface SomeInterface { // ... } In addition to tags, you can autoconfigure other service properties, such as method calls, service configurators, whether the service is public/shared/lazy, etc. Autoconfigurable Attributes¶
Contributed by
Alexander M. Turek
and Nicolas Grekas
in #39897,
#40234
and #40556.
A different but related feature introduced in Symfony 5.3 allows you to use PHP attributes to autoconfigure instances of classes instead of interfaces. For example, in previous Symfony applications your configuration had to include the following about controllers: 1 2 3 4 5# config/services.yaml App\Controller\: resource: '../src/Controller/' tags: ['controller.service_arguments']
...
This was necessary to apply the controller.service_arguments tag to all the services whose classes where stored in the src/Controller/ directory of your application (this tag allows autowiring the arguments of all controller methods, not only its constructor). In Symfony 5.3 you can remove that configuration if you like and apply instead the following attribute to all your controllers that need that feature: 1 2 3 4 5 6 7 8// src/Controller/MyController.php use Symfony\Component\HttpKernel\Attribute\AsController;
[AsController]
class MyController { // ... } These attribute names follow the pattern #[As...]. Symfony 5.3 provides
[AsCommand] to define a PHP class as a Symfony console command,
[AsEventListener] to define a PHP class as a Symfony event listener, etc.
Note that you don’t need to add these attributes when upgrading to Symfony 5.3. They are an optional way of achieving the same that you get when using autoconfigure: true in config/services.yaml in your current applications.
Sponsor the Symfony project.
Connectez-vous pour ajouter un commentaire
Autres messages de ce groupe
This blog post highlights the key accomplishments of the Symfony project in 2024. We are grateful for your continuous support, which enabled the Symfony project to achieve a remarkable year.
Releases
This week, Symfony 6.4.17, 7.1.10 and 7.2.2 maintenance versions were released. In addition, we published more information about the upcoming SymfonyOnline January 2025 conference.
Symfony developmen
Get ready for the exciting SymfonyOnline January 2025, kicking off shortly on January 16-17! There’s still time to register and join the international online Symfony conference—along with pre-
Symfony 6.4.17 has just been released. Here is the list of the most important changes since 6.4.16:
bug #59304 [PropertyInfo] Remove @internal from PropertyReadInfo and PropertyWriteInfo (Dario G
Symfony 7.1.10 has just been released. Here is the list of the most important changes since 7.1.9:
bug #59304 [PropertyInfo] Remove @internal from PropertyReadInfo and PropertyWriteInfo (Dario Gu
Symfony 7.2.2 has just been released. Here is the list of the most important changes since 7.2.1:
bug #59304 [PropertyInfo] Remove @internal from PropertyReadInfo and PropertyWriteInfo (Dario Gua
This week, we launched the new Twig playground, a tool that lets you test and experiment with Twig features in a safe, sandboxed environment. While Symfony development activity was lighter than usual