Accueil › Spring Boot › @ConfigurationProperties : une configuration typée
@ConfigurationProperties : une configuration typée
Configurer l'applicationdebutant
@ConfigurationProperties lie un groupe de propriétés partageant un préfixe à un objet Java typé, au lieu d'un @Value par propriété :
@ConfigurationProperties(prefix = "app.mail")
public record MailProperties(String hote, int port, String expediteur) { }
app:
mail:
hote: smtp.boutique.fr
port: 587
expediteur: no-reply@boutique.fr
Pour qu'elle devienne un bean, la classe doit soit être annotée @Component, soit être déclarée avec @EnableConfigurationProperties(MailProperties.class) sur une @Configuration, soit être trouvée par @ConfigurationPropertiesScan (sur la classe principale, une seule fois pour tout le projet) :
@SpringBootApplication
@ConfigurationPropertiesScan
public class BoutiqueApplication { ... }
Puis on l'injecte comme n'importe quel bean :
@Service
public class MailService {
public MailService(MailProperties mailProperties) {
// mailProperties.hote(), mailProperties.port()…
}
}
Avantages sur @Value : structure (objets imbriqués, listes, maps), validation avec @Validated, et autocomplétion IDE grâce à spring-boot-configuration-processor.
Les termes à connaître
- @ConfigurationProperties
Annotation qui lie un groupe de propriétés partageant un préfixe à une classe (ou un
record) Java, champ par champ. Ex.@ConfigurationProperties(prefix = "app.mail")lie toutes les propriétésapp.mail.*.- @ConfigurationPropertiesScan
Placée sur la classe principale (ou une
@Configuration), elle fait rechercher automatiquement toutes les classes@ConfigurationPropertiesdu projet, sans avoir à les déclarer une par une.- @EnableConfigurationProperties
Alternative à
@ConfigurationPropertiesScan: enregistre explicitement une (ou plusieurs) classe@ConfigurationPropertiescomme bean, ex.@EnableConfigurationProperties(AppProperties.class).- @Validated
Sur une classe
@ConfigurationProperties, active la validation Bean Validation (@NotNull,@Min,@Email…) des propriétés au démarrage. En cas d'échec, l'application ne démarre pas.- Record de configuration
Un
recordJava peut porter@ConfigurationProperties: ses composants (immuables) deviennent les propriétés liées. Spring Boot 3 reconnaît automatiquement ce mode de liaison par constructeur, sans annotation supplémentaire.- Duration et DataSize
Types dédiés pour les durées (
Duration, ex.15s,2m,500ms) et les tailles (DataSize, ex.10MB,1GB), reconnus automatiquement par le binder de@ConfigurationProperties.- spring-boot-configuration-processor
Dépendance optionnelle (annotation processor) qui génère des métadonnées à la compilation, utilisées par l'IDE pour l'autocomplétion et la documentation des propriétés personnalisées.
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.