工作中常用到的 Spring 依赖管理技术盘点

今天主要和大家分享一些在工作中可能会用到的Spring依赖注入，依赖查找方面的技术点整理，非常实用。

Spring依赖查找专题

单一类型查找

常见用法如下所示：

1. Object getBean(String name) throws BeansException;  
2. <T> T getBean(Class<T> requiredType) throws BeansException;  
3. <T> T getBean(String name, Class<T> requiredType) throws BeansException 

ObjectProvider

随着Spring版本的升高，也开始出现了延迟查找的功能。当我们实际需要用到某个bean的时候才将其从容器中进行初始化并且提取出来。

1. <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType);  
2. <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType); 

Spring会返回一个ObjectProvider，当查询的时候才会触发bean的创建。

延迟查找的好处在于，如果一个bean需要注入到spring容器中，但是不希望太过早地去进行初始化，那么可以思考使用ObjectProvider的方式来进行初始化。

集合类型查找

Bean的名称查询

1. String[] getBeanNamesForType(@Nullable Class<?> type);   
2. String[] getBeanNamesForType(@Nullable Class<?> type, boolean includeNonSingletons, boolean allowEagerInit); 

获取同类型Bean实例列表

1. getBeansOfType(Class) 

按照注解去查询 

1. String[] getBeanNamesForAnnotation(Class<? extends Annotation> annotationType);  
2. Map<String, Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType) throws BeansException;  
3. <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType) throws NoSuchBeanDefinitionException; 

使用依赖查找时候的一些小心得：

对于判断一个bean是否存在，可以采用判断其beandefinition是否存在，一般这样不会触发其中bean的初始化操作，例如：getBeanNamesForType。反观getBeansOfType可能回触发bean的初始化

层次性的bean查找

可能大多数人在实际使用Spring容器的时候对于层次性的bean做计算并没有太多的实战尝试，这里我举个例子：

例如说A容器中包含了Bean A，如果B容器继承了A容器，那么按道理来说也应该能够获得Bean A资源，这种设计可以减少Bean的额外存储。

如果你理解了我上边所说的这个案例之后，再来看看下边的这张图可能就会有更加深入的理解了。

关于层次性的bean获取，我这里给出一个小的demo供大家学习：

1. package org.idea.spring.look.up.factory;  
2. import org.springframework.beans.factory.BeanFactory;  
3. import org.springframework.beans.factory.HierarchicalBeanFactory;  
4. import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;  
5. import org.springframework.context.ApplicationContext;  
6. import org.springframework.context.annotation.AnnotationConfigApplicationContext;  
7. /**  
8.  * 层次性的依赖查找 {@link org.springframework.beans.factory.HierarchicalBeanFactory}  
9.  *  
10.  * @Author idea  
11.  * @Date created in 10:55 下午 2021/4/10  
12.  */  
13. public class SpringHierarchicalLookUpDemo {  
14.     public static void main(String[] args) {  
15.         AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();  
16.         applicationContext.register(SpringHierarchicalLookUpDemo.class);  
17.         applicationContext.refresh();  
18.         ParentIocContainer parentIocContainer = new ParentIocContainer();  
19.         ApplicationContext parentApplicationContext = parentIocContainer.getAndStartApplicationContext();  
20.         // ConfigurableListableBeanFactory -> ConfigurableBeanFactory -> HierarchicalBeanFactory  
21.         ConfigurableListableBeanFactory configurableListableBeanFactory = applicationContext.getBeanFactory();  
22.         System.out.println("此时的父类BeanFactory为：" + configurableListableBeanFactory.getParentBeanFactory());  
23.         configurableListableBeanFactory.setParentBeanFactory(parentApplicationContext);  
24.         System.out.println("此时的父类BeanFactory为：" + configurableListableBeanFactory.getParentBeanFactory());  
25.         ParentIocContainer.ParentBean parentBean = (ParentIocContainer.ParentBean) configurableListableBeanFactory.getBean("parentBean");  
26.         System.out.println(parentBean);  
27.         isContainedBean(configurableListableBeanFactory, "parentBean");  
28.         displayContainsBean(configurableListableBeanFactory, "parentBean");  
29.     }  
30.     /**  
31.      * 这里是子类可以获取自己和父类层次内部的bean，如果是使用containsLocalBean方法的话就只能判断当前所在层次的容器上下文  
32.      *  
33.      * @param beanFactory  
34.      * @param beanName  
35.      */  
36.     public static void isContainedBean(HierarchicalBeanFactory beanFactory, String beanName) {  
37.         System.out.println("getBean is " + beanFactory.getBean(beanName));  
38.         System.out.printf("contained is [%s] ,beanFactory is [%s],beanName is [%s]\n", beanFactory.containsLocalBean(beanName), beanFactory, beanName);  
39.     }  
40.     /**  
41.      * 查找关于父类容器内部的bean  
42.      *  
43.      * @param beanFactory  
44.      * @param beanName  
45.      */  
46.     private static void displayContainsBean(HierarchicalBeanFactory beanFactory, String beanName) {  
47.         System.out.printf("contained is [%s] ,beanFactory is [%s],beanName is [%s]\n", isContainedBeanInHoldApplication(beanFactory, beanName), beanFactory, beanName);  
48.     }  
49.     /**  
50.      * 使用递归判断 -- 自上到下判断父类容器是否含有bean  
51.      *  
52.      * @param hierarchicalBeanFactory  
53.      * @param beanName  
54.      * @return  
55.      */  
56.     public static boolean isContainedBeanInHoldApplication(HierarchicalBeanFactory hierarchicalBeanFactory, String beanName) {  
57.         BeanFactory parentBeanFactory = hierarchicalBeanFactory.getParentBeanFactory();  
58.         if (parentBeanFactory instanceof HierarchicalBeanFactory) {  
59.             HierarchicalBeanFactory parentHierarchicalBeanFactory = HierarchicalBeanFactory.class.cast(parentBeanFactory);  
60.             if (isContainedBeanInHoldApplication(parentHierarchicalBeanFactory, beanName)) {  
61.                 return true;  
62.             }  
63.         }  
64.         return hierarchicalBeanFactory.containsBean(beanName);  
65.     }  
66. } 

对应的父类容器案例：

1. package org.idea.spring.look.up.factory;  
2. import org.springframework.context.ApplicationContext;  
3. import org.springframework.context.annotation.AnnotationConfigApplicationContext;  
4. /**  
5.  * 父类ioc容器 这里面的ioc容器只包含有ParentBean这个类  
6.  *  
7.  * @Author idea  
8.  * @Date created in 8:46 上午 2021/4/11  
9.  */  
10. public class ParentIocContainer {  
11.     public static AnnotationConfigApplicationContext applicationContext = null;  
12.     class ParentBean {  
13.         int id;  
14.         public ParentBean(){  
15.             System.out.println("this is no arg init");  
16.         }  
17.         @Override  
18.         public String toString() {  
19.             return "ParentBean{" +  
20.                     "id=" + id +  
21.                     '}';  
22.         }  
23.     }  
24.     public ApplicationContext getAndStartApplicationContext(){  
25.        applicationContext = new AnnotationConfigApplicationContext();  
26.        applicationContext.register(ParentIocContainer.class);  
27.        //需要支持无参构造函数  
28.        applicationContext.registerBean("parentBean",ParentBean.class); 
29.        applicationContext.refresh();  
30.        return applicationContext;  
31.     }  
32.     public static void main(String[] args) {  
33.         ParentIocContainer parentIocContainer = new ParentIocContainer();  
34.         ApplicationContext applicationContext = parentIocContainer.getAndStartApplicationContext();  
35.         String[] str = applicationContext.getBeanNamesForType(ParentBean.class);  
36.         for (String beanName : str) {  
37.             System.out.println(beanName);  
38.         }  
39.     } 
40. } 

从这段代码中可以看出，HierarchicalBeanFactory是一种常见的层次类BeanFactory，并且当我们需要判断一个bean是否存在某个容器上下文中的时候，不妨可以试试使用BeanFacoty自带的这个方法：

1. org.springframework.beans.factory.HierarchicalBeanFactory#containsLocalBean  
2. /**  
3.  * Return whether the local bean factory contains a bean of the given name,  
4.  * ignoring beans defined in ancestor contexts.  
5.  * <p>This is an alternative to {@code containsBean}, ignoring a bean  
6.  * of the given name from an ancestor bean factory.  
7.  * @param name the name of the bean to query  
8.  * @return whether a bean with the given name is defined in the local factory  
9.  * @see BeanFactory#containsBean 
10.  */  
11. boolean containsLocalBean(String name); 

Spring依赖注入专题

依赖注入的几种模式

手动注入模式：

•  写XML的方式注入
•  通过注解的方式注入
•  通过API的方式去注入

自动注入的模式：

使用Autowiring的模式进行注入

常见的注入案例：

xml方式注入

例如通过xml配置文件对bean的属性进行注入：

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.        xsi:schemaLocation="http://www.springframework.org/schema/beans  
5.         https://www.springframework.org/schema/beans/spring-beans.xsd">  
6.     <bean id="malePerson" class="org.idea.spring.ioc.bean.Person" >  
7.     <property name="id" value="1"></property>  
8.     <property name="name" value="idea"></property>  
9. </bean>  
10.     <bean class="org.idea.spring.dependency.inject.setter.PersonHolder">  
11.         <property name="person" ref="malePerson"></property>  
12.     </bean>  
13. </beans> 

对应的Person对象

1. @Data  
2. @AllArgsConstructor  
3. @NoArgsConstructor  
4. public class Person {  
5.     Integer id;  
6.     String name; 
7. } 

注解的方式注入

例如加入一个@Bean的注解进行注入容器

1. @Bean  
2.   public PersonHolder personHolder(Person person){  
3.       return new PersonHolder(person);  
4.   } 

Spring容器内部的api注入

核心是利用了BeanDefinitionBuilder进行一个beanDefinition的构建，然后将这个beanDefinition给注入到Spring容器当中，上下文在启动之后会将之前准备好的BeanDefinition机械能初始化创建。

1. import org.idea.spring.ioc.bean.Person;  
2. import org.springframework.beans.factory.config.BeanDefinition;  
3. import org.springframework.beans.factory.support.BeanDefinitionBuilder;  
4. import org.springframework.context.annotation.AnnotationConfigApplicationContext;  
5. import org.springframework.context.annotation.Bean; 
6. /**  
7.  * 通过api的方式进行注入实现  
8.  *  
9.  * @Author idea  
10.  * @Date created in 11:11 下午 2021/4/21  
11.  */  
12. public class ApiDependencyInjectDemo {  
13.     @Bean  
14.     public Person myPerson(){  
15.         return new Person(1,"idea");  
16.     }  
17.     public static void main(String[] args) {  
18.         AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();  
19.         applicationContext.register(ApiDependencyInjectDemo.class);  
20.         BeanDefinition personBeanDefinition = createUserBeanDefinition();  
21.         applicationContext.registerBeanDefinition("personHolder",personBeanDefinition);  
22.         applicationContext.refresh();  
23.         PersonHolder personHolder = applicationContext.getBean(PersonHolder.class);  
24.         System.out.println(personHolder.getPerson());  
25.         applicationContext.close();  
26.     }  
27.     private static BeanDefinition createUserBeanDefinition() { 
28.         BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(PersonHolder.class);  
29.         //注意这里的add方法有多种类型，需要注意下细节点  
30.         beanDefinitionBuilder.addPropertyReference("person","myPerson");  
31.         return beanDefinitionBuilder.getBeanDefinition();  
32.     }  
33. } 

@Resource,@Autowire,@Qualifier模式注入

这两类的注入在实际使用中频率比较高：

•  @Resource注解的注入会根据后边的字段类型识别进行注入
•  @Autowire则会根据bean的类型进行注入

这里有一段案例：

1. public class AnnotationDependencyInjectDemo {  
2.     @Autowired  
3.     private PersonHolder personHolder2;  
4.     @Resource  
5.     private PersonHolder personHolder;  
6.     public static void main(String[] args) {  
7.         AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();  
8.         applicationContext.register(AnnotationDependencyInjectDemo.class);  
9.         applicationContext.refresh();  
10.         AnnotationDependencyInjectDemo annotationDependencyInjectDemo = applicationContext.getBean(AnnotationDependencyInjectDemo.class);  
11.         System.out.println(annotationDependencyInjectDemo.personHolder);  
12.         System.out.println(annotationDependencyInjectDemo.personHolder2);  
13.         //这里面的两个bean都是同一个，因为bean的作用域是一致相同的  
14.         System.out.println(annotationDependencyInjectDemo.personHolder == annotationDependencyInjectDemo.personHolder2);  
15.         applicationContext.close();  
16.     }  
17.     @Bean  
18.     public PersonHolder personHolder(){  
19.         return new PersonHolder(new Person(1,"idea"));  
20.     }  
21. } 

如果出现了一个接口对应多个实现类，但是代码中使用的是@Autowire的方式进行依赖注入，此时可以通过新增@Qualifier注解的方式来实现依赖注入的效果。

单纯从实际使用来说，我个人感觉@Resource = @Autowire + @Qualifier

依赖注入和依赖查找

在常见的业务开发当中，我们可能会使用到比较多的依赖注入注解，但是在一些基础组件的开发中，我个人感觉使用依赖查找往往更加具有灵活性。

Spring内部的Bean有哪几种

自定义的bean

例如业务系统中常见的XXXXDao,XXXXService

Spring容器中初始化构建好的Bean

例如Spring容器中的Enviorment对象

Spring容器内部的一些基础服务对象

例如Spring容器内部的BeanFactory对象，这类Bean通常是无法通过getBean接口去直接获取的。

Spring中的BeanDefinition对象

上边我们有提及过到Spring内部提供了相关的Api供开发者进行灵活的依赖注入。但是当我们深入到具体细节进行分析之后，其实是可以发现BeanDefinition对象也是有不同类型差异的。

用户自定义的BeanDeinition对象例如这样一段代码：

1. public class ApiDependencyInjectDemo {  
2.     @Bean  
3.     public Person myPerson(){  
4.         return new Person(1,"idea");  
5.     }  
6.     public static void main(String[] args) {  
7.         AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();  
8.         applicationContext.register(ApiDependencyInjectDemo.class);  
9.         BeanDefinition personBeanDefinition = createUserBeanDefinition();  
10.         applicationContext.registerBeanDefinition("personHolder",personBeanDefinition);  
11.         applicationContext.refresh();  
12.         PersonHolder personHolder = applicationContext.getBean(PersonHolder.class);  
13.         System.out.println(personHolder.getPerson());  
14.         applicationContext.close();  
15.     }  
16.     private static BeanDefinition createUserBeanDefinition() {  
17.         //spring官方比较推荐的一种注入方式  
18.         BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(PersonHolder.class);  
19.         //注意这里的add方法有多种类型，需要注意下细节点  
20.         beanDefinitionBuilder.addConstructorArgReference("myPerson");  
21.         return beanDefinitionBuilder.getBeanDefinition();  
22.     }  
23. } 

框架内部初始化定义好的BeanDefinition对象

具体体现在Spring容器进行初始化的时候，内部的refresh函数中有个prepareBeanFactory。

点进去这个函数，对它的源代码进行深入解读之后你会发现，其实内部已经注册了一系列的BeanDefinition对象。

在容器初始化之后是否还能注册Bean？

其实是可以的，下边我通过使用BeanDefiniation的案例来和你一起分析一下：

1. package org.idea.spring.bean.source;  
2. import org.springframework.beans.factory.config.BeanDefinition;  
3. import org.springframework.beans.factory.support.BeanDefinitionBuilder;  
4. import org.springframework.context.annotation.AnnotationConfigApplicationContext;  
5. import org.idea.spring.bean.beandefinitionbuilder.User;  
6. /**  
7.  * @Author idea  
8.  * @Date created in 4:44 下午 2021/9/18  
9.  */  
10. public class AddBeanAfterRefreshDemo {  
11.     public static void main(String[] args) {  
12.         AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();  
13.         annotationConfigApplicationContext.register(AddBeanAfterRefreshDemo.class);  
14.         annotationConfigApplicationContext.refresh();  
15.         try {  
16.             User user0 = annotationConfigApplicationContext.getBean(User.class);  
17.             System.out.println("user0 is " + user0);  
18.         } catch (Exception b) {  
19.             b.printStackTrace();  
20.         }  
21.         System.out.println("启动后手动注入bean对象");  
22.         BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);  
23.         beanDefinitionBuilder.setScope("prototype"); 
24.         beanDefinitionBuilder  
25.                 .addPropertyValue("id", 2)  
26.                 .addPropertyValue("name", "idea");  
27.         annotationConfigApplicationContext.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());  
28.         //1)  
29.         User user1 = (User) annotationConfigApplicationContext.getBean("user");  
30.         BeanDefinition beanDefinition = annotationConfigApplicationContext.getBeanDefinition("user");  
31.         System.out.println(beanDefinition.getScope());  
32.         System.out.println(user1);  
33.         annotationConfigApplicationContext.close();  
34.     } 
35. } 

注意，这里面如果将1)部分的代码调整为：

1. User user1 = (User) annotationConfigApplicationContext.getBean(User.class); 

则不会实现容器启动后注册了对应的bean，但是依然查询不到预期对象的效果。这是因为在Spring容器底层会有一个Map专门记录不同的beanClass类型对应不同的beanName集合，从而导致第二次查询的时候走了第一次查询时候的缓存。代码位于：

1. org.springframework.beans.factory.support.DefaultListableBeanFactory  
2. /** Map of singleton and non-singleton bean names, keyed by dependency type. */  
3.   private final Map<Class<?>, String[]> allBeanNamesByType = new ConcurrentHashMap<>(64); 

原文地址：https://mp.weixin.qq.com/s/pXJVKbTWv2fpDH_67JL3bg