Guide till @EnableConfigurationProperties

introduktion

i den här snabba handledningen visar vi hur du använder en @EnableConfigurationProperties-anteckning med @ConfigurationProperties-annoterade klasser.

syftet med @ EnableConfigurationProperties Annotation

@EnableConfigurationProperties annotation är strikt kopplad till @ConfiguratonProperties.

det möjliggör stöd för @ConfigurationProperties annoterade klasser i vår ansökan. Det är dock värt att påpeka att vårstartdokumentationen säger att varje projekt automatiskt innehåller @EnableConfigurationProperties. Därför är @ ConfiguratonProperties support implicit aktiverat i varje Spring Boot-applikation.

för att kunna använda en konfigurationsklass i vårt projekt måste vi registrera den som en vanlig Vårböna.

först och främst kan vi kommentera en sådan klass med @Component. Alternativt kan vi använda en @Bean factory-metod.

men i vissa situationer kanske vi föredrar att hålla en @ ConfigurationProperties-klass som en enkel POJO. Det här är när @EnableConfigurationProperties kommer till nytta. Vi kan ange alla konfigurationsbönor direkt på denna anteckning.

detta är ett bekvämt sätt att snabbt registrera @ConfigurationProperties annoterade bönor.

använda @EnableConfigurationProperties

låt oss nu se hur du använder @EnableConfigurationProperties i praktiken.

först måste vi definiera vår exempelkonfigurationsklass:

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

Observera att vi kommenterade AdditionalProperties endast med @ConfigurationProperties. Det är fortfarande en enkel POJO!

slutligen, låt oss registrera vår konfigurationsböna med @EnableConfigurationProperties:

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

det är allt! Vi kan nu använda Ytterligareegenskaper som alla andra Vårbönor.

slutsats

i denna snabba handledning presenterade vi ett bekvämt sätt att snabbt registrera en @ConfigurationProperties-annoterad klass på våren.

som vanligt är alla exempel som används i den här artikeln tillgängliga över på GitHub.