Formations — 1 037 leçons en français

Accueil › Spring Boot › Déclarer des beans : @Component et @Bean

Déclarer des beans : @Component et @Bean

Les fondamentaux — IoC et injection de dépendancesdebutant

Il y a deux façons principales de déclarer un bean.

1. Annoter la classe avec @Component ou un de ses stéréotypes. Spring la trouve tout seul grâce au component scan :

@Service
public class CommandeService { ... }

@Repository
public class JpaCommandeRepository implements CommandeRepository { ... }

@RestController
public class CommandeController { ... }

2. Écrire une méthode @Bean dans une classe @Configuration. L'objet retourné devient un bean. On l'utilise surtout pour les classes externes :

@Configuration
public class ClientsConfig {

    @Bean
    public RestClient paiementClient(RestClient.Builder builder) {
        return builder.baseUrl("https://api.paiement.example").build();
    }
}

Le scan part du package de la classe @SpringBootApplication et inclut ses sous-packages.

Les termes à connaître

@Component

Annotation qui marque une classe comme bean. Spring la détecte automatiquement au démarrage grâce au component scan et en crée une instance.

Stéréotypes : @Service, @Repository, @Controller

Des variantes de @Component qui indiquent le rôle de la classe. @Service : logique métier. @Repository : accès aux données, avec en plus la traduction des exceptions techniques (JDBC, JPA) en DataAccessException de Spring. @Controller : contrôleur web. @RestController = @Controller + @ResponseBody (les retours sont écrits en JSON).

Component scan

Le parcours des packages, au démarrage, pour trouver les classes annotées @Component (et ses dérivés). Avec Spring Boot, il part du package de la classe @SpringBootApplication et inclut tous ses sous-packages.

@SpringBootApplication

Raccourci pour trois annotations : @SpringBootConfiguration (une @Configuration), @EnableAutoConfiguration (active l'auto-configuration de Spring Boot) et @ComponentScan (lance le scan à partir de ce package).

@Configuration

Classe qui regroupe des méthodes @Bean. Spring en crée une sous-classe (proxy CGLIB) pour que l'appel d'une méthode @Bean depuis une autre renvoie toujours le même singleton au lieu d'un nouvel objet.

@Bean

Annotation sur une méthode : l'objet qu'elle retourne devient un bean. Idéal pour les classes que vous ne pouvez pas annoter (librairies externes) ou dont la création demande de la logique. Les paramètres de la méthode sont injectés par Spring.

Nom d'un bean

Chaque bean a un nom. Par défaut : le nom de la classe avec une minuscule pour @Component (CommandeService → commandeService), le nom de la méthode pour @Bean. On peut le changer : @Service("monService"), @Bean("monBean").

Auto-configuration

Mécanisme de Spring Boot qui crée automatiquement des beans selon ce qui est présent dans le classpath et la configuration (par exemple un DataSource si un driver de base de données est présent). Vos propres beans sont prioritaires : l'auto-configuration s'efface si vous définissez le vôtre.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.