Accueil › Spring Boot › L'auto-configuration : le principe
L'auto-configuration : le principe
Démarrer un projet Spring Bootdebutant
L'auto-configuration crée automatiquement des beans d'infrastructure selon ce qui est présent dans le classpath et la configuration. Elle est activée par @EnableAutoConfiguration, inclus dans @SpringBootApplication.
Concrètement : Spring Boot embarque des centaines de classes de configuration candidates (dans spring-boot-autoconfigure), listées dans un fichier META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports. Chacune ne s'active que si ses conditions sont remplies :
@AutoConfiguration
@ConditionalOnClass(DataSource.class) // le driver JDBC est présent
@ConditionalOnMissingBean(DataSource.class) // vous n'avez pas déjà défini le vôtre
public class DataSourceAutoConfiguration {
@Bean
public DataSource dataSource(DataSourceProperties properties) { ... }
}
Règle essentielle : vos beans sont toujours prioritaires. Si vous définissez votre propre DataSource, l'auto-configuration s'efface grâce à @ConditionalOnMissingBean. Vous n'avez donc jamais besoin de « désactiver » quoi que ce soit pour personnaliser une infrastructure : il suffit de fournir votre propre bean.
Les termes à connaître
- @EnableAutoConfiguration
Annotation qui active l'auto-configuration de Spring Boot ; incluse dans
@SpringBootApplication. Elle déclenche l'évaluation d'un ensemble de classes de configuration candidates, chacune activée ou non selon ses conditions.- @ConditionalOnClass
Condition qui n'active une configuration que si une classe donnée est présente dans le classpath. Exemple : la configuration Jackson ne s'active que si
ObjectMapperest disponible (apporté parspring-boot-starter-webou-json).- @ConditionalOnMissingBean
Condition qui n'active un bean que si aucun bean du même type n'a déjà été défini par l'application. C'est ce qui permet à vos propres beans d'être toujours prioritaires sur ceux de l'auto-configuration.
- @ConditionalOnProperty
Condition qui active une configuration selon la valeur d'une propriété (
application.properties/.yml). Exemple :@ConditionalOnProperty(name = "ma.fonction.activee", havingValue = "true").- AutoConfiguration.imports
Fichier
META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports, présent dans le jarspring-boot-autoconfigure, qui liste toutes les classes de configuration candidates à l'auto-configuration (une par ligne). Chacune est ensuite retenue ou écartée selon ses conditions.- Rapport des conditions
Journal détaillant, pour chaque classe de configuration candidate, pourquoi elle a été retenue (« matched ») ou écartée (« did not match »). Affiché en lançant l'application avec
--debug, oudebug=truedansapplication.properties.- Exclure une auto-configuration
Désactiver explicitement une classe d'auto-configuration, avec
excludesur@SpringBootApplicationou la propriétéspring.autoconfigure.exclude. Utile quand l'auto-configuration par défaut ne convient pas (ex. gérer soi-même leDataSource).
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.