Guía para @EnableConfigurationProperties

Introducción

En este tutorial rápido, mostraremos cómo usar una anotación de @ EnableConfigurationProperties con clases anotadas de @ConfigurationProperties.

Propósito de la anotación de @EnableConfigurationProperties

La anotación de@EnableConfigurationProperties está estrictamente conectada a @ConfiguratonProperties.

Permite admitir clases anotadas @ConfigurationProperties en nuestra aplicación. Sin embargo, vale la pena señalar que la documentación de Spring Boot dice que cada proyecto incluye automáticamente @EnableConfigurationProperties. Por lo tanto, el soporte de @ConfiguratonProperties se activa implícitamente en cada aplicación de arranque por resorte.

Para usar una clase de configuración en nuestro proyecto, necesitamos registrarla como un frijol de primavera regular.

En primer lugar, podemos anotar dicha clase con @Component. Alternativamente, podemos usar un método de fábrica @Bean.

Sin embargo, en ciertas situaciones, podemos preferir mantener una clase @ConfigurationProperties como un POJO simple. Esto es cuando @EnableConfigurationProperties es útil. Podemos especificar todos los frijoles de configuración directamente en esta anotación.

Esta es una forma conveniente de registrar rápidamente frijoles anotados @ConfigurationProperties.

Usando @EnableConfigurationProperties

Ahora, veamos cómo usar @EnableConfigurationProperties en la práctica.

Primero, necesitamos definir nuestra clase de configuración de ejemplo:

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

Tenga en cuenta que anotamos las propiedades adicionales solo con @ConfigurationProperties. ¡Sigue siendo un simple POJO!

Por último, vamos a registrar nuestro bean de configuración utilizando @EnableConfigurationProperties:

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

¡Eso es todo! Ahora podemos usar propiedades adicionales como cualquier otro frijol de primavera.

Conclusión

En este tutorial rápido, presentamos una forma conveniente de registrar rápidamente una clase anotada @ConfigurationProperties en primavera.

Como de costumbre, todos los ejemplos utilizados en este artículo están disponibles en GitHub.

Aprender a construir su API
con la Primavera?

Descargar el E-book