Lente @Value-annotatie

Spring @Value-annotatie wordt gebruikt om standaardwaarden toe te wijzen aan variabelen en methode-argumenten. We kunnen zowel Spring-omgevingsvariabelen als systeemvariabelen lezen met behulp van de @Value-annotatie. De Spring @Value-annotatie ondersteunt ook SpEL. Laten we eens kijken naar enkele voorbeelden van het gebruik van de @Value-annotatie.

Spring @Value – Standaardwaarde

We kunnen een standaardwaarde toewijzen aan een klasse-eigenschap met behulp van de @Value-annotatie.

@Value("Default DBConfiguration")
private String defaultName;

@Value-annotatieargument kan alleen een string zijn, maar Spring probeert het naar het gespecificeerde type te converteren. Onderstaande code zal goed werken en de boolean- en gehele getalwaarden toewijzen aan de variabele.

@Value("true")
private boolean defaultBoolean;

@Value("10")
private int defaultInt;

Spring @Value – Spring Omgevingseigenschap

@Value("${APP_NAME_NOT_FOUND}")
private String defaultAppName;

Als de sleutel niet wordt gevonden in de springomgevingseigenschappen, wordt de eigenschapswaarde ${APP_NAME_NOT_FOUND}. We kunnen een standaardwaarde toewijzen die wordt gebruikt als de sleutel ontbreekt in de springomgevingseigenschappen.

@Value("${APP_NAME_NOT_FOUND:Default}")
private String defaultAppName;

Spring @Value – Systeemomgeving

Wanneer de Spring-omgeving is ingevuld, leest het alle systeemomgevingsvariabelen en slaat deze op als eigenschappen. Dus we kunnen ook systeemvariabelen toewijzen met behulp van de @Value-annotatie.

@Value("${java.home}")
private String javaHome;
	
@Value("${HOME}")
private String homeDir;

Spring @Value – SpEL

We kunnen ook Spring Expression Language gebruiken met de @Value-annotatie. Zo kunnen we ook java home systeemeigenschap lezen met behulp van SpEL.

@Value("#{systemProperties['java.home']}")
private String javaHome;

Spring @Value met methoden

Wanneer de annotatie @Value wordt gevonden op een methode, zal de Spring-context deze oproepen wanneer alle Spring-configuraties en beans worden geladen. Als de methode meerdere argumenten heeft, wordt elke argumentwaarde toegewezen vanuit de methode-annotatie. Als we verschillende waarden willen voor verschillende argumenten, kunnen we de annotatie @Value rechtstreeks met het argument gebruiken.

@Value("Test")
public void printValues(String s, String v){} //both 's' and 'v' values will be 'Test' 

@Value("Test")
public void printValues(String s, @Value("Data") String v){}
// s=Test, v=Data

Spring @Value Voorbeeld

Lat en we een eenvoudige Spring-toepassing maken waar we de annotatie @Value gebruiken om eigenschappen te lezen en deze toe te wijzen aan klassevariabelen. Maak een Maven-project en voeg de vereiste Spring Core-afhankelijkheden toe.

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-context</artifactId>
	<version>5.0.6.RELEASE</version>
</dependency>

Onze uiteindelijke projectstructuur ziet eruit als de onderstaande afbeelding, we zullen elk van de componenten één voor één bekijken. Maak een componentklasse waar we variabele waarden injecteren via de annotatie @Value.

package com.journaldev.spring;

import org.springframework.beans.factory.annotation.Value;

public class DBConnection {

	@Value("${DB_DRIVER_CLASS}")
	private String driverClass;
	@Value("${DB_URL}")
	private String dbURL;
	@Value("${DB_USERNAME}")
	private String userName;
	@Value("${DB_PASSWORD}")
	private char[] password;

	public DBConnection() {
	}

	public void printDBConfigs() {
		System.out.println("Driver Class = " + driverClass);
		System.out.println("DB URL = " + dbURL);
		System.out.println("User Name = " + userName);

		// Doe dit nooit in een productieomgeving :D
		System.out.println("Password = " + String.valueOf(password));
	}
}

Nu moeten we een configuratieklasse maken en een @Bean-methode leveren voor de klasse DBConnection.

package com.journaldev.spring;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:db.properties")
@PropertySource(value = "classpath:root.properties", ignoreResourceNotFound = true)
public class DBConfiguration {

	@Value("Default DBConfiguration")
	private String defaultName;

	@Value("true")
	private boolean defaultBoolean;

	@Value("10")
	private int defaultInt;

	@Value("${APP_NAME_NOT_FOUND:Default}")
	private String defaultAppName;

	// @Value("#{systemProperties['java.home']}")
	@Value("${java.home}")
	private String javaHome;

	@Value("${HOME}")
	private String homeDir;

	@Bean
	public DBConnection getDBConnection() {
		DBConnection dbConnection = new DBConnection();
		return dbConnection;
	}

	@Value("Test")
	public void printValues(String s, @Value("another variable") String v) {
		System.out.println("Input Argument 1 =" + s);
		System.out.println("Input Argument 2 =" + v);

		System.out.println("Home Directory = " + homeDir);
		System.out.println("Default Configuration Name = " + defaultName);
		System.out.println("Default App Name = " + defaultAppName);
		System.out.println("Java Home = " + javaHome);
		System.out.println("Boolean = " + defaultBoolean);
		System.out.println("Int = " + defaultInt);

	}

}

Hier is onze hoofdklasse waar we een annotatiegebaseerde Spring-context maken.

package com.journaldev.spring;

import java.sql.SQLException;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class SpringMainClass {

	public static void main(String[] args) throws SQLException {
		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
		context.scan("com.journaldev.spring");
		context.refresh();
		System.out.println("Refreshing the spring context");
		DBConnection dbConnection = context.getBean(DBConnection.class);

		dbConnection.printDBConfigs();
		
		// sluit de Spring-context
		context.close();
	}

}

Wanneer je de klasse uitvoert, zal het volgende uitvoer produceren.

Input Argument 1 =Test
Input Argument 2 =another variable
Home Directory = /Users/pankaj
Default Configuration Name = Default DBConfiguration
Default App Name = Default
Java Home = /Library/Java/JavaVirtualMachines/jdk-10.0.1.jdk/Contents/Home
Boolean = true
Int = 10
Refreshing the spring context
Driver Class = com.mysql.jdbc.Driver
DB URL = jdbc:mysql://localhost:3306/Test
User Name = journaldev
Password = journaldev

Merk op dat de configuratieklasse printValues() wordt aangeroepen voordat onze context klaar is om gebruikersverzoeken te bedienen. Dat is alles voor het Spring @Value annotatievoorbeeld, je kunt de voorbeeldcode downloaden van onze GitHub Repository.

Spring @Value Annotation Project