Anleitung zu @EnableConfigurationProperties

Einführung

In dieser Kurzanleitung zeigen wir Ihnen, wie Sie eine Annotation @EnableConfigurationProperties mit annotierten Klassen von @ConfigurationProperties verwenden.

Zweck der Annotation @EnableConfigurationProperties

Die Annotation@EnableConfigurationProperties ist streng mit @ConfiguratonProperties verbunden.

Es ermöglicht die Unterstützung für @ConfigurationProperties annotierte Klassen in unserer Anwendung. Es ist jedoch erwähnenswert, dass die Spring Boot-Dokumentation besagt, dass jedes Projekt automatisch @EnableConfigurationProperties enthält. Daher ist die @ConfiguratonProperties-Unterstützung in jeder Spring Boot-Anwendung implizit aktiviert.

Um eine Konfigurationsklasse in unserem Projekt zu verwenden, müssen wir sie als reguläre Spring Bean registrieren.

Zunächst können wir eine solche Klasse mit @Component annotieren. Alternativ können wir eine @Bean Factory-Methode verwenden.

In bestimmten Situationen ziehen wir es jedoch vor, eine @ConfigurationProperties Klasse als einfaches POJO @ConfigurationProperties . Dies ist, wenn @EnableConfigurationProperties praktisch ist. Wir können alle Konfigurations-Beans direkt in dieser Anmerkung angeben.

Dies ist eine bequeme Möglichkeit, mit @ConfigurationProperties kommentierte Beans schnell zu registrieren.

Verwenden von @EnableConfigurationProperties

Lassen Sie uns nun sehen, wie Sie @EnableConfigurationProperties in der Praxis verwenden.

Zuerst müssen wir unsere Beispielkonfigurationsklasse definieren:

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

Beachten Sie, dass wir die additionalProperties nur mit @ConfigurationProperties . Es ist immer noch ein einfaches POJO!

Schließlich registrieren wir unsere Konfigurations-Bean mit @EnableConfigurationProperties:

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

Das ist alles! Wir können jetzt additionalProperties wie jede andere Spring Bean verwenden.

Fazit

In dieser Kurzanleitung haben wir eine bequeme Möglichkeit vorgestellt, eine mit @ConfigurationProperties kommentierte Klasse im Frühjahr schnell zu registrieren.

Wie üblich sind alle in diesem Artikel verwendeten Beispiele auf GitHub verfügbar.

Lernen Sie, Ihre API
mit Spring zu erstellen?

E-Book herunterladen