如何正确使用 Spring 注入集合类型?

Posted JavaEdge.

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了如何正确使用 Spring 注入集合类型?相关的知识,希望对你有一定的参考价值。

集合类型的自动注入是Spring提供的另外一个强大功能。我们在方便的使用依赖注入的特性时,必须要思考对象从哪里注入、怎么创建、为什么是注入这一个对象的。虽然编写框架的目的是让开发人员无需关心太多底层细节,能专心业务逻辑的开发,但是作为开发人员不能真的无脑去使用框架。
务必学会注入集合等高级用法,让自己有所提升!

现在有一需求:存在多个用户Bean,找出来存储到一个List。

1 注入方式

1.1 收集方式

多个用户Bean的定义:

有了集合类型的自动注入后,即可收集零散的用户Bean:

这样即可完成集合类型注入:

但当持续增加一些student时,可能就不喜欢用上述的注入集合类型了,而是这样:

1.2 直接装配方式


分开玩,大家应该不会有啥问题,若两种方式共存了,会咋样?
运行程序后发现直接装配方式的未生效:

这是为啥呢?

2 源码解析

就得精通这两种注入风格在Spring分别如何实现的。

2.1 收集装配

DefaultListableBeanFactory#resolveMultipleBeans

private Object resolveMultipleBeans(DependencyDescriptor descriptor, @Nullable String beanName,
      @Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) {
   final Class<?> type = descriptor.getDependencyType();
   if (descriptor instanceof StreamDependencyDescriptor) {
      // 装配stream
      return stream;
   }
   else if (type.isArray()) {
      // 装配数组
      return result;
   }
   else if (Collection.class.isAssignableFrom(type) && type.isInterface()) {
      // 装配集合
      // 获取集合的元素类型
      Class<?> elementType = descriptor.getResolvableType().asCollection().resolveGeneric();
      if (elementType == null) {
         return null;
      }
      // 根据元素类型查找所有的bean
      Map<String, Object> matchingBeans = findAutowireCandidates(beanName, elementType,
            new MultiElementDescriptor(descriptor));
      if (matchingBeans.isEmpty()) {
         return null;
      }
      if (autowiredBeanNames != null) {
         autowiredBeanNames.addAll(matchingBeans.keySet());
      }
      // 转化查到的所有bean放置到集合并返回
      TypeConverter converter = (typeConverter != null ? typeConverter : getTypeConverter());
      Object result = converter.convertIfNecessary(matchingBeans.values(), type);
      // ...
      return result;
   }
   else if (Map.class == type) {
      // 解析map
      return matchingBeans;
   }
   else {
      return null;
   }
}

1 获取集合类型的elementType

目标类型定义为List students,所以元素类型为User:

2 根据元素类型找出所有Bean

有了elementType,即可据其找出所有Bean:

3 将匹配的所有的Bean按目标类型转化

上一步获取的所有的Bean都以java.util.LinkedHashMap.LinkedValues存储,和目标类型大不相同,所以最后按需转化。

本案例中,需转化为List:

2.2 直接装配方式

DefaultListableBeanFactory#findAutowireCandidates

不再赘述。

最后就是根据目标类型直接寻找匹配Bean名称为students的List<Student>装配给StudentController#students属性。

当同时满足这两种装配方式时,Spring会如何处理呢?

DefaultListableBeanFactory#doResolveDependency


显然这两种装配集合的方式不能同存,结合本案例:

  • 当使用收集装配时,能找到任一对应Bean,则返回
  • 若一个都没找到,才采用直接装配

所以后期以List方式直接添加的Student Bean都不生效!

3 修正

务必避免两种方式共存去装配集合!只选用一种方式即可。
比如只使用直接装配:
只使用收集方式:

如何做到让用户2优先输出呢?
控制spring bean加载顺序:

  1. Bean上使用@Order注解,如@Order(2)。数值越小表示优先级越高。默认优先级最低。
  2. @DependsOn 使用它,可使得依赖的Bean如果未被初始化会被优先初始化。
  3. 添加@Order(number)注解,number越小优先级越高,越靠前
  4. 声明Student这些Bean时将id=2的Student提到id=1之前

以上是关于如何正确使用 Spring 注入集合类型?的主要内容,如果未能解决你的问题,请参考以下文章

Spring如何装配各种集合类型的属性

Spring各类集合注入

Spring认证-Spring注入集合

Spring配置文件中注入复杂类型属性

spring 注入集合类型 ListSetMap

Day604.@Value注入问题&集合类型注入问题 -Spring编程常见错误