如何给 Spring Bean 属性注入处理后的配置项

问题描述

Spring Boot 中有一个配置类，读取配置文件中的配置项，例如：

@Configuration
@ConfigurationProperties
@Getter
@Setter
public class FruitConfig {
    List<String> fruits;
}

application.yml 中的配置项为：

fruits:
  - apple
  - banana
  - pear
  - grape
  - orange

有一个 Service 实现类需要用到这个配置项，但是需要将这个配置项处理一下，例如需要过滤掉 orange 。

实现方法

方法一：@Autowired 注解注入

@Service
public class FruitServiceImpl {
    @Autowired
    private FruitConfig fruitConfig;

    public List<String> getFruits() {
        return fruitConfig.getFruits().stream().filter(e -> !e.equals("orange")).collect(Collectors.toList());
    }
    
    ...
}

用这种方法解决这个问题有个缺点，在 FruitServiceImpl 类中所有用到 fruits 的地方都要调用处理方法，如果处理方法比较复杂或者 List 元素比较多，就可能影响性能。最好是在 FruitServiceImpl 类中定义一个 List<String> fruits 成员变量，在初始化的时候就将配置项处理好注入给该成员变量，使用下面两种方法都可以实现。

方法二：构造方法注入

@Service
public class FruitServiceImpl {
    private List<String> fruits;

    public FruitServiceImpl(FruitConfig fruitConfig) {
        this.fruits = fruitConfig.getFruits().stream().filter(e -> !e.equals("orange")).collect(Collectors.toList());
    }

    public List<String> getFruits() {
        return fruits;
    }
}

创建 1 个有参数 FruitConfig 的构造方法，Spring 容器初始化 FruitServiceImpl 的时候，会调用这个构造方法，发现它需要 FruitConfig 类型的参数，就在容器中查找是否存在 FruitConfig 类型的 Bean，如果存在就使用这个 Bean。

如果只有这 1 个构造方法，不需要在此方法上加 @Autowired 注解。如果有多个构造方法，就需在想让 Spring 容器调用的构造方法上加 @Autowired 注解，例如：

@Service
public class FruitServiceImpl {
    private List<String> fruits;

    public FruitServiceImpl() {

    }

    @Autowired
    public FruitServiceImpl(FruitConfig fruitConfig) {
        this.fruits = fruitConfig.getFruits().stream().filter(e -> !e.equals("orange")).collect(Collectors.toList());
    }

    public List<String> getFruits() {
        return fruits;
    }
}

方法三：setter 方法注入

@Service
public class FruitServiceImpl {
    private List<String> fruits;

    @Autowired
    public void setFruits(FruitConfig fruitConfig) {
        this.fruits = fruitConfig.getFruits().stream().filter(e -> !e.equals("orange")).collect(Collectors.toList());
    }

    public List<String> getFruits() {
        return fruits;
    }
}

使用 setter 方法注入时，必须在 setter 方法上加 @Autowired 注解。

结语

综上所述，Spring 有 3 种属性注入的方法，Spring 官方推荐的是构造方法注入和 setter 方法注入，因为如果用 @Autowired注解注入，自己想通过 new 构造方法创建这个类的实例时，就无法给成员变量赋值。实际开发中一般用的比较多的是 @Autowired 注解注入，但像本文描述的这种情况使用构造方法注入或 setter 方法注入更适合。所以 3 种注入方法都要掌握，根据实际情况选择合适的注入方法。

参考资料

• https://docs.spring.io/spring-framework/reference/core/beans/annotation-config/autowired.html