Przewodnik po @EnableConfigurationProperties

wprowadzenie

w tym krótkim samouczku pokażemy, jak używać adnotacji @EnableConfigurationProperties z klasami z adnotacjami @ ConfigurationProperties.

cel adnotacji @EnableConfigurationProperties

adnotacja@EnableConfigurationProperties jest ściśle powiązana z @ConfiguratonProperties.

umożliwia obsługę klas z adnotacjami @ ConfigurationProperties w naszej aplikacji. Warto jednak zaznaczyć, że dokumentacja Spring Boot mówi, że każdy projekt automatycznie zawiera @EnableConfigurationProperties. Dlatego obsługa @ConfiguratonProperties jest domyślnie włączona w każdej aplikacji uruchamiającej sprężynę.

aby użyć klasy konfiguracyjnej w naszym projekcie, musimy ją zarejestrować jako zwykłą Spring bean.

po pierwsze, możemy przypisać taką klasę za pomocą @Component. Alternatywnie możemy użyć metody @ Bean factory.

jednakże, w pewnych sytuacjach, możemy preferować zachowanie klasy @ ConfigurationProperties jako prostego POJO. Wtedy przydaje się @EnableConfigurationProperties. Możemy określić całą konfigurację bezpośrednio na tej adnotacji.

jest to wygodny sposób na szybką rejestrację @ ConfigurationProperties.

używanie @EnableConfigurationProperties

teraz zobaczmy, jak używać @EnableConfigurationProperties w praktyce.

najpierw musimy zdefiniować naszą przykładową klasę konfiguracji:

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

zauważ, że adnotowaliśmy AdditionalProperties tylko za pomocą @ConfigurationProperties. To wciąż proste POJO!

na koniec zarejestrujmy naszą konfigurację za pomocą @EnableConfigurationProperties:

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

to wszystko! Możemy teraz używać dodatkowych właściwości, jak każda inna fasola Wiosenna.

podsumowanie

w tym krótkim samouczku przedstawiliśmy wygodny sposób na szybką rejestrację klasy @ConfigurationProperties z adnotacjami na wiosnę.

jak zwykle wszystkie przykłady użyte w tym artykule są dostępne na Githubie.