Аннотация @Value в Spring

Весна Аннотация @Value используется для присвоения значений по умолчанию переменным и аргументам метода. Мы можем читать переменные среды Spring, а также системные переменные с использованием аннотации @Value. Аннотация Spring @Value также поддерживает SpEL. Давайте рассмотрим несколько примеров использования аннотации @Value.

Spring @Value – Значение по умолчанию

Мы можем присвоить значение по умолчанию свойству класса с использованием аннотации @Value.

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

@Value – это аргумент аннотации, который может быть только строкой, но Spring пытается преобразовать его в указанный тип. Ниже приведенный код будет работать нормально и присвоит значения типа boolean и integer переменной.

@Value("true")
private boolean defaultBoolean;

@Value("10")
private int defaultInt;

Spring @Value – Свойство среды Spring

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

Если ключ не найден в свойствах окружения Spring, то значение свойства будет ${APP_NAME_NOT_FOUND}. Мы можем присвоить значение по умолчанию, которое будет назначено, если ключ отсутствует в свойствах окружения Spring.

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

Spring @Value – Системные переменные окружения

Когда окружение Spring заполняется, оно считывает все переменные системной среды и сохраняет их как свойства. Таким образом, мы также можем назначить переменные системы, используя аннотацию @Value.

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

Spring @Value – SpEL

Мы также можем использовать язык выражений Spring с аннотацией @Value. Таким образом, мы также можем читать свойство системы java home с использованием SpEL.

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

Spring @Value с методами

Когда аннотация @Value найдена в методе, контекст Spring вызовет ее, когда все конфигурации и бины Spring загружаются. Если у метода несколько аргументов, то значение каждого аргумента сопоставляется с аннотацией метода. Если мы хотим разные значения для разных аргументов, то мы можем использовать аннотацию @Value напрямую с аргументом.

@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 Пример

Давайте создадим простое приложение Spring, где мы будем использовать аннотацию @Value для чтения свойств и присваивания их переменным класса. Создайте проект Maven и добавьте зависимости spring core.

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

Наша конечная структура проекта будет выглядеть как на изображении ниже, мы рассмотрим каждый из компонентов по очереди. Создайте класс компонента, где мы будем внедрять значения переменных через аннотацию @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);

		// Никогда не делайте это в рабочей среде :D
		System.out.println("Password = " + String.valueOf(password));
	}
}

Теперь нам нужно создать класс Configuration и предоставить метод @Bean для класса 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);

	}

}

Вот наш основной класс, в котором мы создаем контекст Spring на основе аннотаций.

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();
		
		// закрываем контекст Spring
		context.close();
	}

}

Когда вы запустите класс, он выдаст следующий вывод.

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

Обратите внимание, что метод printValues() класса Configuration вызывается до того, как наш контекст будет готов обслуживать запросы пользователя. Вот и все для примера использования аннотации Spring @Value, вы можете скачать пример кода из нашего репозитория на GitHub.

Проект с использованием аннотации @Value в Spring