Eigenschaften mit Spring und Spring Boot

1. Übersicht

Dieses Tutorial zeigt, wie Sie Eigenschaften in Spring über die Java-Konfiguration und @PropertySource einrichten und verwenden .

Wir werden auch sehen, wie Eigenschaften in Spring Boot funktionieren.

2. Registrieren Sie eine Eigenschaftendatei über Anmerkungen

In Spring 3.1 wird außerdem die neue Annotation @PropertySource als praktischer Mechanismus zum Hinzufügen von Eigenschaftsquellen zur Umgebung eingeführt.

Wir können diese Annotation in Verbindung mit der Annotation @Configuration verwenden :

@Configuration @PropertySource("classpath:foo.properties") public class PropertiesWithJavaConfig { //... }

Eine weitere sehr nützliche Methode zum Registrieren einer neuen Eigenschaftendatei ist die Verwendung eines Platzhalters, mit dem wir zur Laufzeit dynamisch die richtige Datei auswählen können :

@PropertySource({ "classpath:persistence-${envTarget:mysql}.properties" }) ...

2.1. Mehrere Eigenschaftsorte definieren

Die Annotation @PropertySource kann gemäß den Java 8-Konventionen wiederholt werden. Wenn wir Java 8 oder höher verwenden, können wir diese Anmerkung verwenden, um mehrere Eigenschaftspositionen zu definieren:

@PropertySource("classpath:foo.properties") @PropertySource("classpath:bar.properties") public class PropertiesWithJavaConfig { //... }

Natürlich können wir auch die Annotation @PropertySources verwenden und ein Array von @PropertySource angeben . Dies funktioniert in jeder unterstützten Java-Version, nicht nur in Java 8 oder höher:

@PropertySources({ @PropertySource("classpath:foo.properties"), @PropertySource("classpath:bar.properties") }) public class PropertiesWithJavaConfig { //... }

In beiden Fällen ist zu beachten, dass im Falle einer Kollision mit dem Eigenschaftsnamen der zuletzt gelesene Quellcode Vorrang hat.

3. Verwenden / Injizieren von Eigenschaften

Das Einfügen einer Eigenschaft mit der Annotation @Value ist unkompliziert:

@Value( "${jdbc.url}" ) private String jdbcUrl;

Wir können auch einen Standardwert für die Eigenschaft angeben:

@Value( "${jdbc.url:aDefaultUrl}" ) private String jdbcUrl;

Der neue PropertySourcesPlaceholderConfigurer, der in Spring 3.1 hinzugefügt wurde, löst $ {…} Platzhalter in Bean-Definitionseigenschaftswerten und @ Value- Annotationen auf .

Schließlich können wir den Wert einer Eigenschaft mithilfe der Umgebungs- API ermitteln :

@Autowired private Environment env; ... dataSource.setUrl(env.getProperty("jdbc.url"));

4. Eigenschaften mit Spring Boot

Bevor wir uns mit erweiterten Konfigurationsoptionen für Eigenschaften befassen, sollten wir uns einige Zeit mit der Unterstützung neuer Eigenschaften in Spring Boot befassen.

Im Allgemeinen erfordert diese neue Unterstützung weniger Konfiguration im Vergleich zu Standard Spring , was natürlich eines der Hauptziele von Boot ist.

4.1. application.properties: Die Standardeigenschaftendatei

Boot wendet seine typische Konvention über den Konfigurationsansatz auf Eigenschaftendateien an. Dies bedeutet, dass wir einfach eine application.properties- Datei in unser Verzeichnis src / main / resources legen können , die automatisch erkannt wird . Wir können dann alle geladenen Eigenschaften wie gewohnt daraus injizieren.

Wenn Sie diese Standarddatei verwenden, müssen Sie weder eine PropertySource explizit registrieren noch einen Pfad zu einer Eigenschaftendatei angeben.

Bei Bedarf können wir auch eine andere Datei zur Laufzeit mithilfe einer Umgebungseigenschaft konfigurieren:

java -jar app.jar --spring.config.location=classpath:/another-location.properties

Ab Spring Boot 2.3 können wir auch Platzhalterpositionen für Konfigurationsdateien angeben .

Zum Beispiel können wir die Eigenschaft spring.config.location auf config / * / setzen :

java -jar app.jar --spring.config.location=config/*/

Auf diese Weise sucht Spring Boot nach Konfigurationsdateien, die mit dem Verzeichnismuster config / * / außerhalb unserer JAR-Datei übereinstimmen . Dies ist praktisch, wenn wir mehrere Quellen für Konfigurationseigenschaften haben.

Seit Version 2.4.0 unterstützt Spring Boot die Verwendung von Eigenschaftendateien mit mehreren Dokumenten , ähnlich wie YAML es beabsichtigt hat:

baeldung.customProperty=defaultValue #--- baeldung.customProperty=overriddenValue

Beachten Sie, dass bei Eigenschaftendateien vor der Notation mit drei Strichen ein Kommentarzeichen ( # ) steht.

4.2. Umgebungsspezifische Eigenschaftendatei

Wenn wir unterschiedliche Umgebungen ansprechen müssen, gibt es in Boot einen integrierten Mechanismus dafür.

Wir können einfach eine application- environment.properties- Datei im Verzeichnis src / main / resources definieren und dann ein Spring-Profil mit demselben Umgebungsnamen festlegen.

Wenn wir beispielsweise eine Staging-Umgebung definieren, bedeutet dies, dass wir ein Staging- Profil und dann application-staging.properties definieren müssen .

Diese env-Datei wird geladen und hat Vorrang vor der Standardeigenschaftendatei. Beachten Sie, dass die Standarddatei weiterhin geladen wird. Bei einer Eigenschaftskollision hat nur die umgebungsspezifische Eigenschaftendatei Vorrang.

4.3. Testspezifische Eigenschaftendatei

Möglicherweise müssen wir auch andere Eigenschaftswerte verwenden, wenn unsere Anwendung getestet wird.

Spring Boot handles this for us by looking in our src/test/resources directory during a test run. Again, default properties will still be injectable as normal but will be overridden by these if there is a collision.

4.4. The @TestPropertySource Annotation

If we need more granular control over test properties, then we can use the @TestPropertySource annotation.

This allows us to set test properties for a specific test context, taking precedence over the default property sources:

@RunWith(SpringRunner.class) @TestPropertySource("/foo.properties") public class FilePropertyInjectionUnitTest { @Value("${foo}") private String foo; @Test public void whenFilePropertyProvided_thenProperlyInjected() { assertThat(foo).isEqualTo("bar"); } }

If we don't want to use a file, we can specify names and values directly:

@RunWith(SpringRunner.class) @TestPropertySource(properties = {"foo=bar"}) public class PropertyInjectionUnitTest { @Value("${foo}") private String foo; @Test public void whenPropertyProvided_thenProperlyInjected() { assertThat(foo).isEqualTo("bar"); } }

We can also achieve a similar effect using the properties argument of the @SpringBootTest annotation:

@RunWith(SpringRunner.class) @SpringBootTest( properties = {"foo=bar"}, classes = SpringBootPropertiesTestApplication.class) public class SpringBootPropertyInjectionIntegrationTest { @Value("${foo}") private String foo; @Test public void whenSpringBootPropertyProvided_thenProperlyInjected() { assertThat(foo).isEqualTo("bar"); } }

4.5. Hierarchical Properties

If we have properties that are grouped together, we can make use of the @ConfigurationProperties annotation, which will map these property hierarchies into Java objects graphs.

Let's take some properties used to configure a database connection:

database.url=jdbc:postgresql:/localhost:5432/instance database.username=foo database.password=bar

And then let's use the annotation to map them to a database object:

@ConfigurationProperties(prefix = "database") public class Database { String url; String username; String password; // standard getters and setters }

Spring Boot applies it's convention over configuration approach again, automatically mapping between property names and their corresponding fields. All that we need to supply is the property prefix.

If you want to dig deeper into configuration properties, have a look at our in-depth article.

4.6. Alternative: YAML Files

Spring also supports YAML files.

All the same naming rules apply for test-specific, environment-specific, and default property files. The only difference is the file extension and a dependency on the SnakeYAML library being on our classpath.

YAML is particularly good for hierarchical property storage; the following property file:

database.url=jdbc:postgresql:/localhost:5432/instance database.username=foo database.password=bar secret: foo

is synonymous with the following YAML file:

database: url: jdbc:postgresql:/localhost:5432/instance username: foo password: bar secret: foo

It's also worth mentioning that YAML files do not support the @PropertySource annotation, so if we need to use this annotation, it would constrain us to using a properties file.

Another remarkable point is that in version 2.4.0 Spring Boot changed the way in which properties are loaded from multi-document YAML files. Previously, the order in which they were added was based on the profile activation order. With the new version, however, the framework follows the same ordering rules that we indicated earlier for .properties files; properties declared lower in the file will simply override those higher up.

Additionally, in this version profiles can no longer be activated from profile-specific documents, making the outcome clearer and more predictable.

4.7. Importing Additional Configuration Files

Prior to version 2.4.0, Spring Boot allowed including additional configuration files using the spring.config.location and spring.config.additional-location properties, but they had certain limitations. For instance, they had to be defined before starting the application (as environment or system properties, or using command-line arguments) as they were used early in the process.

In the mentioned version, we can use the spring.config.import property within the application.properties or application.yml file to easily include additional files. This property supports some interesting features:

  • adding several files or directories
  • the files can be loaded either from the classpath or from an external directory
  • indicating if the startup process should fail if a file is not found, or if it's an optional file
  • importing extensionless files

Let's see a valid example:

spring.config.import=classpath:additional-application.properties, classpath:additional-application[.yml], optional:file:./external.properties, classpath:additional-application-properties/

Note: here we formatted this property using line breaks just for clarity.

Spring will treat imports as a new document inserted immediately below the import declaration.

4.8. Properties From Command Line Arguments

Besides using files, we can pass properties directly on the command line:

java -jar app.jar --property="value"

We can also do this via system properties, which are provided before the -jar command rather than after it:

java -Dproperty.name="value" -jar app.jar

4.9. Properties From Environment Variables

Spring Boot will also detect environment variables, treating them as properties:

export name=value java -jar app.jar 

4.10. Randomization of Property Values

If we don't want determinist property values, we can use RandomValuePropertySource to randomize the values of properties:

random.number=${random.int} random.long=${random.long} random.uuid=${random.uuid}

4.11. Additional Types of Property Sources

Spring Boot supports a multitude of property sources, implementing a well-thought-out ordering to allow sensible overriding. It's worth consulting the official documentation, which goes further than the scope of this article.

5. Configuration Using Raw Beans — the PropertySourcesPlaceholderConfigurer

Besides the convenient methods of getting properties into Spring, we can also define and regiter the property configuration bean manually.

Working with the PropertySourcesPlaceholderConfigurer gives us full control over the configuration, with the downside of being more verbose and most of the time, unnecessary.

Let's see how we can define this bean using Java configuration:

@Bean public static PropertySourcesPlaceholderConfigurer properties(){ PropertySourcesPlaceholderConfigurer pspc = new PropertySourcesPlaceholderConfigurer(); Resource[] resources = new ClassPathResource[ ] { new ClassPathResource( "foo.properties" ) }; pspc.setLocations( resources ); pspc.setIgnoreUnresolvablePlaceholders( true ); return pspc; }

6. Properties in Parent-Child Contexts

This question comes up again and again: What happens when our web application has a parent and a child context? The parent context may have some common core functionality and beans, and then one (or multiple) child contexts, maybe containing servlet-specific beans.

In that case, what's the best way to define properties files and include them in these contexts? And how to best retrieve these properties from Spring?

We'll give a simple breakdown.

If the file is defined in the Parent context:

  • @Value works in Child context: YES
  • @Value works in Parent context: YES
  • environment.getProperty in Child context: YES
  • environment.getProperty in Parent context: YES

If the file is defined in the Child context:

  • @Value works in Child context: YES
  • @Value works in Parent context: NO
  • environment.getProperty in Child context: YES
  • environment.getProperty in Parent context: NO

7. Conclusion

This article showed several examples of working with properties and properties files in Spring.

Wie immer ist der gesamte Code, der den Artikel unterstützt, auf GitHub verfügbar.