Spring @Value 注释
Spring @Value注释用于为变量和方法参数分配默认值。我们可以使用@Value注释读取 spring 环境变量以及系统变量。Spring @Value注释还支持 SpEL。让我们看一些使用@Value注释的示例。
Spring @Value - 默认值
我们可以使用@Value注释为类属性分配默认值。
@Value("Default DBConfiguration")
private String defaultName;
@Value注释参数只能是字符串,但 spring 会尝试将其转换为指定类型。下面的代码将正常工作,并将布尔值和整数值分配给变量。
@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
我们还可以使用带有@Value注释的 Spring Expression Language 。因此,我们也可以使用 SpEL 读取 java home 系统属性。
@Value("#{systemProperties['java.home']}")
private String javaHome;
Spring @Value方法
如果在方法上发现@Value注释,则 Spring 上下文将在所有 Spring 配置和 bean 加载时调用它。如果该方法有多个参数,则每个参数值都从方法注释中映射。如果我们想要为不同的参数设置不同的值,那么我们可以直接将@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 核心依赖项。
<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);
// Never do below in production environment :D
System.out.println("Password = " + String.valueOf(password));
}
}
现在我们必须创建一个配置类并为 DBConnection 类提供一个@Bean方法。
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();
// close the spring context
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 存储库下载示例代码。