Guide de @EnableConfigurationProperties

Introduction

Dans ce tutoriel rapide, nous allons montrer comment utiliser une annotation @EnableConfigurationProperties avec des classes annotées @ConfigurationProperties.

But de l’annotation @EnableConfigurationProperties

L’annotation @EnableConfigurationProperties est strictement liée à @ConfiguratonProperties.

Il permet de prendre en charge les classes annotées @ConfigurationProperties dans notre application. Cependant, il convient de souligner que la documentation de démarrage Spring indique que chaque projet inclut automatiquement @EnableConfigurationProperties. Par conséquent, la prise en charge de @ConfiguratonProperties est implicitement activée dans chaque application Spring Boot.

Afin d’utiliser une classe de configuration dans notre projet, nous devons l’enregistrer en tant que bean Spring régulier.

Tout d’abord, nous pouvons annoter une telle classe avec @Component. Alternativement, nous pouvons utiliser une méthode d’usine @Bean.

Cependant, dans certaines situations, nous pouvons préférer conserver une classe @ConfigurationProperties comme un simple POJO. C’est à ce moment que @EnableConfigurationProperties est utile. Nous pouvons spécifier tous les beans de configuration directement sur cette annotation.

C’est un moyen pratique d’enregistrer rapidement des beans annotés @ConfigurationProperties.

Utilisation de @EnableConfigurationProperties

Maintenant, voyons comment utiliser @EnableConfigurationProperties dans la pratique.

Tout d’abord, nous devons définir notre exemple de classe de configuration:

@ConfigurationProperties(prefix = "additional")public class AdditionalProperties { private String unit; private int max; // standard getters and setters}

Notez que nous avons annoté les propriétés supplémentaires uniquement avec @ConfigurationProperties. C’est toujours un simple POJO!

Enfin, enregistrons notre bean de configuration en utilisant @EnableConfigurationProperties:

@Configuration@EnableConfigurationProperties(AdditionalProperties.class)public class AdditionalConfiguration { @Autowired private AdditionalProperties additionalProperties; // make use of the bound properties}

C’est tout! Nous pouvons maintenant utiliser d’autrespropriétés comme tout autre haricot de printemps.

Conclusion

Dans ce tutoriel rapide, nous avons présenté un moyen pratique d’enregistrer rapidement une classe annotée @ConfigurationProperties au printemps.

Comme d’habitude, tous les exemples utilisés dans cet article sont disponibles sur GitHub.

Apprendre à construire votre API
avec Spring ?

Télécharger le livre électronique