Spring Boot注入配置文件中的集合：List、Map指南

2024-01-27 04:01:31

在 Spring Boot 中注入配置文件中的集合：简化您的应用程序配置

在现代软件开发中，配置管理对于维护应用程序的健康和可维护性至关重要。Spring Boot，一个流行的 Java 框架，通过对配置文件的支持简化了这一任务。在某些情况下，您可能需要在 Spring Boot 项目中使用集合（例如列表或映射）类型的配置项。本文将深入探讨如何实现 Spring Boot 配置文件中的集合注入。

依赖注入和 Spring Boot

Spring Boot 依赖于依赖注入，这是一种在运行时将对象及其依赖项连接起来的关键机制。通过使用注解，您可以将配置信息注入 Java 类。在 Spring Boot 中，@Autowired 注解是最常用的依赖注入注解。

注入 List 集合

假设您在 application.yml 配置文件中定义了一个 List 集合：

my-list:
- value1
- value2
- value3

要将此 List 集合注入到 Java 类中，请执行以下步骤：

创建 Java 类（例如 MyConfig）以存储 List 集合。

@Configuration
public class MyConfig {

    @Value("${my-list}")
    private List<String> myList;

    public List<String> getMyList() {
        return myList;
    }
}

在需要使用该集合的 Java 类中，使用 @Autowired 注解注入 MyConfig 对象。

@RestController
public class MyController {

    @Autowired
    private MyConfig myConfig;

    @GetMapping("/list")
    public List<String> getList() {
        return myConfig.getMyList();
    }
}

现在，您可以在 MyController 类中使用 myList 字段访问配置文件中的 List 集合。

注入 Map 集合

对于 Map 集合，您可以使用类似的方法进行注入。例如，在 application.yml 配置文件中定义一个 Map 集合：

my-map:
  key1: value1
  key2: value2
  key3: value3

在 Java 类中，您可以使用以下步骤注入该 Map 集合：

创建 Java 类（例如 MyConfigMap）以存储 Map 集合。

@Configuration
public class MyConfigMap {

    @Value("${my-map}")
    private Map<String, String> myMap;

    public Map<String, String> getMyMap() {
        return myMap;
    }
}

在需要使用该集合的 Java 类中，使用 @Autowired 注解注入 MyConfigMap 对象。

@RestController
public class MyController {

    @Autowired
    private MyConfigMap myConfigMap;

    @GetMapping("/map")
    public Map<String, String> getMap() {
        return myConfigMap.getMyMap();
    }
}