Spring注解 `@Value`实战之各种数据类型注入（Array、List、Map等）

最新推荐文章于 2025-04-25 15:33:34 发布

yuelangyc

最新推荐文章于 2025-04-25 15:33:34 发布

阅读量7.7k

点赞数 23

分类专栏： Spring JAVA 文章标签： spring java 后端

本文链接：https://blog.csdn.net/yuelangyc/article/details/139089945

版权

Spring 同时被 2 个专栏收录

8 篇文章

订阅专栏

JAVA

1 篇文章

订阅专栏

在Spring框架中，@Value注解是一个强大的工具，它允许我们直接将配置值注入到Bean的属性中，无需编写繁琐的setter方法。Spring支持多种数据格式的注入，包括但不限于字符串、数字、布尔值、数组、列表、Map等。下面我们将通过实战案例来演示如何使用@Value注解实现各种类型数据格式的注入。

1. 字符串注入

这是最基本的注入类型，通常用于注入配置文件中的普通文本值。

@Component
public class StringInjectionExample {

    @Value("${app.name}")
    private String appName;

    // getter and setter methods...
}

在application.properties或application.yml中：

# application.properties
app.name=My Spring App

2. 数字注入

Spring可以自动将字符串值转换为数字类型。

@Component
public class NumberInjectionExample {

    @Value("${app.maxUsers:100}") // 使用默认值100
    private int maxUsers;

    // getter and setter methods...
}

在application.properties中：

# application.properties
app.maxUsers=200

3. 布尔值注入

Spring同样支持布尔值的注入。

@Component
public class BooleanInjectionExample {

    @Value("${app.featureEnabled:true}") // 使用默认值true
    private boolean featureEnabled;

    // getter and setter methods...
}

在application.properties中：

# application.properties
app.featureEnabled=false

4. 数组注入

使用逗号分隔的字符串来注入数组。

@Component
public class ArrayInjectionExample {

    @Value("${app.roles:ROLE_USER,ROLE_ADMIN}") // 使用默认值
    private String[] roles;

    // getter and setter methods...
}

在application.properties中：

# application.properties
app.roles=ROLE_GUEST,ROLE_USER

5. 列表注入

使用Spring的#{...}语法配合SpEL（Spring Expression Language）注入列表。

@Component
public class ListInjectionExample {

    @Value("#{'${app.listItems}'.split(',')}")
    private List<String> listItems;

    // getter and setter methods...
}

在application.properties中：

# application.properties
app.listItems=item1,item2,item3

6. Map注入

通过配置文件中特定格式的字符串注入Map。

@Component
public class MapInjectionExample {

    @Value("#{${app.mapItems}}")
    private Map<String, String> mapItems;

    // getter and setter methods...
}

在application.properties中（注意Map的键值对格式）：

# application.properties
app.mapItems={key1:value1,key2:value2}

或者，使用YAML格式（如果你使用的是application.yml）：

app:
  mapItems:
    key1: value1
    key2: value2

注意，对于Map的注入，你可能需要使用@ConfigurationProperties注解或者自定义的PropertySource来更方便地处理。

7. 自定义类型注入

虽然@Value主要用于注入基本类型和集合，但你也可以通过SpEL来注入自定义类型的Bean。但通常，对于自定义类型的注入，我们更倾向于使用@Autowired注解或者@Resource注解。

8. 默认值

在上述示例中，你可以看到:后面的值是默认值。如果配置文件中没有对应的属性，Spring将使用这些默认值。

9. 注意事项

确保你的配置文件（如application.properties或application.yml）位于正确的位置，并且Spring Boot能够加载到它。
对于复杂的配置，如Map或自定义类型，可能需要考虑使用@ConfigurationProperties或其他配置绑定机制。
@Value注解可以应用于字段、setter方法或构造函数参数。

通过这些实战案例，你应该已经掌握了如何在Spring中使用@Value注解来实现各种类型数据格式的注入。

Spring 通过注解 @Value 实现各种类型数据格式注入的实战（续）

在前面的部分中，我们介绍了如何使用 @Value 注解来注入字符串、数字、布尔值、数组、列表和 Map 等基本类型的数据。接下来，我们将探讨一些高级的使用场景，包括注入 SpEL 表达式、系统属性、环境变量以及自定义配置类的属性。

1. 注入 SpEL 表达式

Spring Expression Language (SpEL) 是一种强大的表达式语言，支持在运行时查询和操作对象图。你可以使用 @Value 注解来注入 SpEL 表达式的结果。

@Component
public class SpelInjectionExample {

    @Value("#{ T(java.lang.Math).random() * 100.0 }")
    private double randomNumber;

    // getter and setter methods...
}

在这个例子中，我们注入了一个随机生成的浮点数。

2. 注入系统属性

Spring 可以方便地注入系统属性。你可以使用 systemProperties 前缀来引用系统属性。

@Component
public class SystemPropertyInjectionExample {

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

    // getter and setter methods...
}

但请注意，直接引用系统属性时通常不需要 systemProperties 前缀，除非你想在配置文件中覆盖它。

3. 注入环境变量

类似地，Spring 也可以注入环境变量。你可以使用 systemEnvironment 前缀来引用环境变量。

@Component
public class EnvironmentVariableInjectionExample {

    @Value("${systemEnvironment.PATH}")
    private String path;

    // getter and setter methods...
}

但同样地，直接引用环境变量时通常不需要 systemEnvironment 前缀。

4. 注入自定义配置类的属性

当你有一个包含多个配置属性的类，并且你想注入其中的某个属性时，你通常需要使用 @ConfigurationProperties 注解。但如果你只是想注入该类中的某个属性，而不是整个类，你仍然可以使用 @Value。

首先，定义你的配置类：

@ConfigurationProperties(prefix = "custom")
public class CustomProperties {

    private String property1;
    private int property2;

    // getters and setters...
}

然后，在你的其他类中注入这个配置类中的某个属性：

@Component
public class CustomPropertyInjectionExample {

    @Value("${custom.property1}")
    private String customProperty1;

    // getter and setter methods...
}

但请注意，这样做可能会导致配置属性的重复定义和可能的冲突。因此，在大多数情况下，如果你有一个包含多个属性的配置类，最好使用 @ConfigurationProperties 注解来注入整个类。

5. 使用 `@PropertySource` 加载自定义配置文件

如果你有一些配置属性不在 application.properties 或 application.yml 文件中，而是在其他位置（如自定义的 .properties 文件），你可以使用 @PropertySource 注解来加载这些属性。

@Configuration
@PropertySource("classpath:custom.properties")
public class CustomConfig {

    @Value("${custom.property}")
    private String customProperty;

    // ...
}

在这个例子中，我们使用了 @PropertySource 注解来加载 classpath 下的 custom.properties 文件，并使用 @Value 注解来注入其中的属性。

总结

@Value 注解在 Spring 中是一个非常有用的工具，它允许你轻松地注入各种类型的数据。通过结合 SpEL 表达式、系统属性、环境变量和自定义配置类，你可以实现更复杂的配置需求。然而，在处理包含多个属性的配置类时，最好使用 @ConfigurationProperties 注解来避免潜在的配置冲突和重复。