Accueil › Spring Boot › Créer son propre starter
Créer son propre starter
Auto-configuration en profondeuravance
Un starter Spring Boot bien conçu se compose en pratique de deux modules : un module d'auto-configuration (le code, les classes @AutoConfiguration, les @ConfigurationProperties) et un module starter au sens strict, qui ne contient aucune classe et se contente de déclarer les dépendances (l'auto-configuration, la bibliothèque cliente, ses dépendances transitives). Un projet peut ainsi dépendre du module d'auto-configuration seul, sans passer par le starter, si son propre mécanisme d'assemblage de dépendances diffère.
La convention de nommage compte : spring-boot-starter-* est réservé aux starters officiels. Un starter tiers s'appelle acme-spring-boot-starter, son module d'auto-configuration acme-spring-boot-autoconfigure.
Le cœur du module d'auto-configuration :
@AutoConfiguration
@ConditionalOnClass(AcmeClient.class)
@EnableConfigurationProperties(AcmeProperties.class)
public class AcmeAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public AcmeClient acmeClient(AcmeProperties properties) {
return new AcmeClient(properties.getUrl(), properties.getTimeout());
}
}
@ConditionalOnMissingBean sur chaque bean fourni garantit qu'un bean défini par l'application consommatrice prend toujours le dessus, sans qu'elle ait besoin d'exclure quoi que ce soit. La classe est déclarée candidate en l'ajoutant, une par ligne, au fichier META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports.
Les termes à connaître
- Starter
Module qui ne contient aucun code : seulement des dépendances Maven/Gradle regroupées (la bibliothèque, son auto-configuration, ses dépendances transitives). C'est le module que les projets consommateurs ajoutent à leur
pom.xml.- Module d'auto-configuration
Module séparé, contenant les classes
@AutoConfigurationet les@ConfigurationProperties. Le starter en dépend ; ce découpage en deux modules permet à un projet de dépendre de l'auto-configuration seule, sans passer par le starter, si besoin.- Convention de nommage
Le préfixe
spring-boot-starter-*(ex.spring-boot-starter-web) est réservé aux starters officiels maintenus par l'équipe Spring Boot. Un starter tiers se nomme<nom>-spring-boot-starter(ex.acme-spring-boot-starter), et son module d'auto-configuration<nom>-spring-boot-autoconfigure.- AutoConfiguration.imports
Fichier
META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.importsdu module d'auto-configuration, listant en clair (une classe par ligne, nom complet) les classes@AutoConfigurationà enregistrer comme candidates.- spring-boot-configuration-processor
Dépendance (portée
optionalouannotationProcessor) qui génère, à la compilation,META-INF/spring-configuration-metadata.json: les métadonnées qui alimentent l'autocomplétion et la documentation des propriétés dans l'IDE, à partir des classes@ConfigurationProperties.- @ConditionalOnMissingBean (dans un starter)
Posée sur chaque
@Beanfourni par le starter, elle garantit que tout bean défini par l'application consommatrice prime automatiquement sur celui du starter, sans qu'elle ait besoin d'exclure quoi que ce soit.- ApplicationContextRunner
Classe utilitaire (
org.springframework.boot.test.context.runner) pour tester une auto-configuration isolément, sans démarrer une vraie application :withUserConfiguration(...),withPropertyValues(...),withClassLoader(...), puisrun(context -> ...).
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.