Guide to @EnableConfigurationProperties

Bevezetés

ebben a gyors oktatóanyagban megmutatjuk, hogyan kell használni a @EnableConfigurationProperties annotációt a @ConfigurationProperties annotált osztályokkal.

a @EnableConfigurationProperties annotáció célja

a@EnableConfigurationProperties annotáció szigorúan a @ConfiguratonProperties-hez kapcsolódik.

lehetővé teszi a @ConfigurationProperties annotált osztályok támogatását alkalmazásunkban. Érdemes azonban rámutatni, hogy a Spring Boot dokumentációja szerint minden projekt automatikusan tartalmazza a @EnableConfigurationProperties fájlt. Ezért a @ConfiguratonProperties támogatás implicit módon be van kapcsolva minden tavaszi rendszerindító alkalmazásban.

annak érdekében, hogy egy konfigurációs osztályt használjunk a projektünkben, regisztrálnunk kell azt normál tavaszi babként.

először is kommentálhatunk egy ilyen osztályt @komponenssel. Alternatív megoldásként használhatunk egy @Bean factory módszert is.

bizonyos helyzetekben azonban inkább a @ConfigurationProperties osztályt tartjuk egyszerű POJO-ként. Ez az, amikor a @EnableConfigurationProperties jól jön. Az összes konfigurációs babot közvetlenül ezen a megjegyzésen adhatjuk meg.

ez egy kényelmes módja annak, hogy gyorsan regisztrálni @ConfigurationProperties jegyzetekkel bab.

a @EnableConfigurationProperties használata

most nézzük meg, hogyan kell a @EnableConfigurationProperties-t használni a gyakorlatban.

először meg kell határoznunk a példa konfigurációs osztályunkat:

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

vegye figyelembe, hogy az AdditionalProperties-t csak @ConfigurationProperties-szel jegyeztük fel. Ez még mindig egy egyszerű POJO!

végül regisztráljuk konfigurációs babunkat a @EnableConfigurationProperties használatával:

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

ez minden! Most használhatunk Továbbitulajdonságok, mint bármely más tavaszi bab.

következtetés

ebben a gyors oktatóanyagban bemutattunk egy kényelmes módszert a @ConfigurationProperties jegyzetekkel ellátott osztály gyors regisztrálására tavasszal.

mint általában, az ebben a cikkben használt összes példa elérhető a GitHub – on.