Sprievodca po @EnableConfigurationProperties
1. Úvod
V tomto rýchlom návode ukážeme si, ako používať @EnableConfigurationProperties anotácia s @ConfigurationProperties anotované triedy.
2. Účel @EnableConfigurationProperties Anotácia
@EnableConfigurationProperties anotácia je striktne spojená s @ConfiguratonProperties.
Umožňuje podporu pre @ConfigurationProperties anotované triedy v našej aplikácii. Za zmienku však stojí, že dokumentácia Spring Boot hovorí, každý projekt automaticky obsahuje @EnableConfigurationProperties. Preto @ConfiguratonProperties podpora je implicitne zapnutá v každej aplikácii Spring Boot.
Aby sme v našom projekte mohli použiť konfiguračnú triedu, musíme ju zaregistrovať ako bežnú jarnú fazuľu.
V prvom rade môžeme takúto triedu anotovať @ Komponent. Prípadne môžeme použiť a @Bean továrenská metóda.
V určitých situáciách však možno si radšej necháme a @ConfigurationProperties triedy ako jednoduchý POJO. Toto je kedy @EnableConfigurationProperties príde vhod. Všetky konfiguračné fazule môžeme určiť priamo v tejto anotácii.
Toto je pohodlný spôsob rýchlej registrácie @ConfigurationProperties anotované fazule.
3. Používanie @EnableConfigurationProperties
Teraz sa pozrime, ako sa používa @EnableConfigurationProperties v praxi.
Najprv musíme definovať našu príkladnú konfiguračnú triedu:
@ConfigurationProperties (prefix = "additional") verejná trieda AdditionalProperties {súkromná reťazcová jednotka; súkromné int max; // štandardné getre a setre}
Upozorňujeme, že sme anotovali Ďalšie vlastnosti iba s @ConfigurationProperties. Stále je to jednoduché POJO!
Nakoniec zaregistrujme našu konfiguračnú fazuľu pomocou @EnableConfigurationProperties:
@Configuration @EnableConfigurationProperties (AdditionalProperties.class) verejná trieda AdditionalConfiguration {@Autowired private AdditionalProperties additionalProperties; // využiť viazané vlastnosti}
To je všetko! Teraz môžeme použiť Ďalšie vlastnosti ako každá iná jarná fazuľa.
4. Záver
V tomto rýchlom návode sme si predstavili pohodlný spôsob, ako rýchlo zaregistrovať znak @ConfigurationProperties komentovaná trieda na jar.
Ako obvykle sú všetky príklady použité v tomto článku dostupné na GitHub.