工作中常用到的 Spring 依賴管理技術盤點
今天主要和大家分享一些在工作中可能會用到的Spring依賴注入,依賴查找方面的技術點整理,非常實用。
Spring依賴查找專題
單一類型查找
常見用法如下所示:
- Object getBean(String name) throws BeansException;
- <T> T getBean(Class<T> requiredType) throws BeansException;
- <T> T getBean(String name, Class<T> requiredType) throws BeansException
ObjectProvider
隨著Spring版本的升高,也開始出現了延遲查找的功能。當我們實際需要用到某個bean的時候才將其從容器中進行初始化并且提取出來。
- <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType);
- <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType);
Spring會返回一個ObjectProvider,當查詢的時候才會觸發bean的創建。
延遲查找的好處在于,如果一個bean需要注入到spring容器中,但是不希望太過早地去進行初始化,那么可以思考使用ObjectProvider的方式來進行初始化。
集合類型查找
Bean的名稱查詢
- String[] getBeanNamesForType(@Nullable Class<?> type);
- String[] getBeanNamesForType(@Nullable Class<?> type, boolean includeNonSingletons, boolean allowEagerInit);
獲取同類型Bean實例列表
- getBeansOfType(Class)
按照注解去查詢
- String[] getBeanNamesForAnnotation(Class<? extends Annotation> annotationType);
- Map<String, Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType) throws BeansException;
- <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供大家學習:
- package org.idea.spring.look.up.factory;
- import org.springframework.beans.factory.BeanFactory;
- import org.springframework.beans.factory.HierarchicalBeanFactory;
- import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
- import org.springframework.context.ApplicationContext;
- import org.springframework.context.annotation.AnnotationConfigApplicationContext;
- /**
- * 層次性的依賴查找 {@link org.springframework.beans.factory.HierarchicalBeanFactory}
- *
- * @Author idea
- * @Date created in 10:55 下午 2021/4/10
- */
- public class SpringHierarchicalLookUpDemo {
- public static void main(String[] args) {
- AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
- applicationContext.register(SpringHierarchicalLookUpDemo.class);
- applicationContext.refresh();
- ParentIocContainer parentIocContainer = new ParentIocContainer();
- ApplicationContext parentApplicationContext = parentIocContainer.getAndStartApplicationContext();
- // ConfigurableListableBeanFactory -> ConfigurableBeanFactory -> HierarchicalBeanFactory
- ConfigurableListableBeanFactory configurableListableBeanFactory = applicationContext.getBeanFactory();
- System.out.println("此時的父類BeanFactory為:" + configurableListableBeanFactory.getParentBeanFactory());
- configurableListableBeanFactory.setParentBeanFactory(parentApplicationContext);
- System.out.println("此時的父類BeanFactory為:" + configurableListableBeanFactory.getParentBeanFactory());
- ParentIocContainer.ParentBean parentBean = (ParentIocContainer.ParentBean) configurableListableBeanFactory.getBean("parentBean");
- System.out.println(parentBean);
- isContainedBean(configurableListableBeanFactory, "parentBean");
- displayContainsBean(configurableListableBeanFactory, "parentBean");
- }
- /**
- * 這里是子類可以獲取自己和父類層次內部的bean,如果是使用containsLocalBean方法的話就只能判斷當前所在層次的容器上下文
- *
- * @param beanFactory
- * @param beanName
- */
- public static void isContainedBean(HierarchicalBeanFactory beanFactory, String beanName) {
- System.out.println("getBean is " + beanFactory.getBean(beanName));
- System.out.printf("contained is [%s] ,beanFactory is [%s],beanName is [%s]\n", beanFactory.containsLocalBean(beanName), beanFactory, beanName);
- }
- /**
- * 查找關于父類容器內部的bean
- *
- * @param beanFactory
- * @param beanName
- */
- private static void displayContainsBean(HierarchicalBeanFactory beanFactory, String beanName) {
- System.out.printf("contained is [%s] ,beanFactory is [%s],beanName is [%s]\n", isContainedBeanInHoldApplication(beanFactory, beanName), beanFactory, beanName);
- }
- /**
- * 使用遞歸判斷 -- 自上到下判斷父類容器是否含有bean
- *
- * @param hierarchicalBeanFactory
- * @param beanName
- * @return
- */
- public static boolean isContainedBeanInHoldApplication(HierarchicalBeanFactory hierarchicalBeanFactory, String beanName) {
- BeanFactory parentBeanFactory = hierarchicalBeanFactory.getParentBeanFactory();
- if (parentBeanFactory instanceof HierarchicalBeanFactory) {
- HierarchicalBeanFactory parentHierarchicalBeanFactory = HierarchicalBeanFactory.class.cast(parentBeanFactory);
- if (isContainedBeanInHoldApplication(parentHierarchicalBeanFactory, beanName)) {
- return true;
- }
- }
- return hierarchicalBeanFactory.containsBean(beanName);
- }
- }
對應的父類容器案例:
- package org.idea.spring.look.up.factory;
- import org.springframework.context.ApplicationContext;
- import org.springframework.context.annotation.AnnotationConfigApplicationContext;
- /**
- * 父類ioc容器 這里面的ioc容器只包含有ParentBean這個類
- *
- * @Author idea
- * @Date created in 8:46 上午 2021/4/11
- */
- public class ParentIocContainer {
- public static AnnotationConfigApplicationContext applicationContext = null;
- class ParentBean {
- int id;
- public ParentBean(){
- System.out.println("this is no arg init");
- }
- @Override
- public String toString() {
- return "ParentBean{" +
- "id=" + id +
- '}';
- }
- }
- public ApplicationContext getAndStartApplicationContext(){
- applicationContext = new AnnotationConfigApplicationContext();
- applicationContext.register(ParentIocContainer.class);
- //需要支持無參構造函數
- applicationContext.registerBean("parentBean",ParentBean.class);
- applicationContext.refresh();
- return applicationContext;
- }
- public static void main(String[] args) {
- ParentIocContainer parentIocContainer = new ParentIocContainer();
- ApplicationContext applicationContext = parentIocContainer.getAndStartApplicationContext();
- String[] str = applicationContext.getBeanNamesForType(ParentBean.class);
- for (String beanName : str) {
- System.out.println(beanName);
- }
- }
- }
從這段代碼中可以看出,HierarchicalBeanFactory是一種常見的層次類BeanFactory,并且當我們需要判斷一個bean是否存在某個容器上下文中的時候,不妨可以試試使用BeanFacoty自帶的這個方法:
- org.springframework.beans.factory.HierarchicalBeanFactory#containsLocalBean
- /**
- * Return whether the local bean factory contains a bean of the given name,
- * ignoring beans defined in ancestor contexts.
- * <p>This is an alternative to {@code containsBean}, ignoring a bean
- * of the given name from an ancestor bean factory.
- * @param name the name of the bean to query
- * @return whether a bean with the given name is defined in the local factory
- * @see BeanFactory#containsBean
- */
- boolean containsLocalBean(String name);
Spring依賴注入專題
依賴注入的幾種模式
手動注入模式:
- 寫XML的方式注入
- 通過注解的方式注入
- 通過API的方式去注入
自動注入的模式:
使用Autowiring的模式進行注入
常見的注入案例:
xml方式注入
例如通過xml配置文件對bean的屬性進行注入:
- <?xml version="1.0" encoding="UTF-8"?>
- <beans xmlns="http://www.springframework.org/schema/beans"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://www.springframework.org/schema/beans
- https://www.springframework.org/schema/beans/spring-beans.xsd">
- <bean id="malePerson" class="org.idea.spring.ioc.bean.Person" >
- <property name="id" value="1"></property>
- <property name="name" value="idea"></property>
- </bean>
- <bean class="org.idea.spring.dependency.inject.setter.PersonHolder">
- <property name="person" ref="malePerson"></property>
- </bean>
- </beans>
對應的Person對象
- @Data
- @AllArgsConstructor
- @NoArgsConstructor
- public class Person {
- Integer id;
- String name;
- }
注解的方式注入
例如加入一個@Bean的注解進行注入容器
- @Bean
- public PersonHolder personHolder(Person person){
- return new PersonHolder(person);
- }
Spring容器內部的api注入
核心是利用了BeanDefinitionBuilder進行一個beanDefinition的構建,然后將這個beanDefinition給注入到Spring容器當中,上下文在啟動之后會將之前準備好的BeanDefinition機械能初始化創建。
- import org.idea.spring.ioc.bean.Person;
- import org.springframework.beans.factory.config.BeanDefinition;
- import org.springframework.beans.factory.support.BeanDefinitionBuilder;
- import org.springframework.context.annotation.AnnotationConfigApplicationContext;
- import org.springframework.context.annotation.Bean;
- /**
- * 通過api的方式進行注入實現
- *
- * @Author idea
- * @Date created in 11:11 下午 2021/4/21
- */
- public class ApiDependencyInjectDemo {
- @Bean
- public Person myPerson(){
- return new Person(1,"idea");
- }
- public static void main(String[] args) {
- AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
- applicationContext.register(ApiDependencyInjectDemo.class);
- BeanDefinition personBeanDefinition = createUserBeanDefinition();
- applicationContext.registerBeanDefinition("personHolder",personBeanDefinition);
- applicationContext.refresh();
- PersonHolder personHolder = applicationContext.getBean(PersonHolder.class);
- System.out.println(personHolder.getPerson());
- applicationContext.close();
- }
- private static BeanDefinition createUserBeanDefinition() {
- BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(PersonHolder.class);
- //注意這里的add方法有多種類型,需要注意下細節點
- beanDefinitionBuilder.addPropertyReference("person","myPerson");
- return beanDefinitionBuilder.getBeanDefinition();
- }
- }
@Resource,@Autowire,@Qualifier模式注入
這兩類的注入在實際使用中頻率比較高:
- @Resource注解的注入會根據后邊的字段類型識別進行注入
- @Autowire則會根據bean的類型進行注入
這里有一段案例:
- public class AnnotationDependencyInjectDemo {
- @Autowired
- private PersonHolder personHolder2;
- @Resource
- private PersonHolder personHolder;
- public static void main(String[] args) {
- AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
- applicationContext.register(AnnotationDependencyInjectDemo.class);
- applicationContext.refresh();
- AnnotationDependencyInjectDemo annotationDependencyInjectDemo = applicationContext.getBean(AnnotationDependencyInjectDemo.class);
- System.out.println(annotationDependencyInjectDemo.personHolder);
- System.out.println(annotationDependencyInjectDemo.personHolder2);
- //這里面的兩個bean都是同一個,因為bean的作用域是一致相同的
- System.out.println(annotationDependencyInjectDemo.personHolder == annotationDependencyInjectDemo.personHolder2);
- applicationContext.close();
- }
- @Bean
- public PersonHolder personHolder(){
- return new PersonHolder(new Person(1,"idea"));
- }
- }
如果出現了一個接口對應多個實現類,但是代碼中使用的是@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對象例如這樣一段代碼:
- public class ApiDependencyInjectDemo {
- @Bean
- public Person myPerson(){
- return new Person(1,"idea");
- }
- public static void main(String[] args) {
- AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
- applicationContext.register(ApiDependencyInjectDemo.class);
- BeanDefinition personBeanDefinition = createUserBeanDefinition();
- applicationContext.registerBeanDefinition("personHolder",personBeanDefinition);
- applicationContext.refresh();
- PersonHolder personHolder = applicationContext.getBean(PersonHolder.class);
- System.out.println(personHolder.getPerson());
- applicationContext.close();
- }
- private static BeanDefinition createUserBeanDefinition() {
- //spring官方比較推薦的一種注入方式
- BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(PersonHolder.class);
- //注意這里的add方法有多種類型,需要注意下細節點
- beanDefinitionBuilder.addConstructorArgReference("myPerson");
- return beanDefinitionBuilder.getBeanDefinition();
- }
- }
框架內部初始化定義好的BeanDefinition對象
具體體現在Spring容器進行初始化的時候,內部的refresh函數中有個prepareBeanFactory。
點進去這個函數,對它的源代碼進行深入解讀之后你會發現,其實內部已經注冊了一系列的BeanDefinition對象。
在容器初始化之后是否還能注冊Bean?
其實是可以的,下邊我通過使用BeanDefiniation的案例來和你一起分析一下:
- package org.idea.spring.bean.source;
- import org.springframework.beans.factory.config.BeanDefinition;
- import org.springframework.beans.factory.support.BeanDefinitionBuilder;
- import org.springframework.context.annotation.AnnotationConfigApplicationContext;
- import org.idea.spring.bean.beandefinitionbuilder.User;
- /**
- * @Author idea
- * @Date created in 4:44 下午 2021/9/18
- */
- public class AddBeanAfterRefreshDemo {
- public static void main(String[] args) {
- AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();
- annotationConfigApplicationContext.register(AddBeanAfterRefreshDemo.class);
- annotationConfigApplicationContext.refresh();
- try {
- User user0 = annotationConfigApplicationContext.getBean(User.class);
- System.out.println("user0 is " + user0);
- } catch (Exception b) {
- b.printStackTrace();
- }
- System.out.println("啟動后手動注入bean對象");
- BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
- beanDefinitionBuilder.setScope("prototype");
- beanDefinitionBuilder
- .addPropertyValue("id", 2)
- .addPropertyValue("name", "idea");
- annotationConfigApplicationContext.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());
- //1)
- User user1 = (User) annotationConfigApplicationContext.getBean("user");
- BeanDefinition beanDefinition = annotationConfigApplicationContext.getBeanDefinition("user");
- System.out.println(beanDefinition.getScope());
- System.out.println(user1);
- annotationConfigApplicationContext.close();
- }
- }
注意,這里面如果將1)部分的代碼調整為:
- User user1 = (User) annotationConfigApplicationContext.getBean(User.class);
則不會實現容器啟動后注冊了對應的bean,但是依然查詢不到預期對象的效果。這是因為在Spring容器底層會有一個Map專門記錄不同的beanClass類型對應不同的beanName集合,從而導致第二次查詢的時候走了第一次查詢時候的緩存。代碼位于:
- org.springframework.beans.factory.support.DefaultListableBeanFactory
- /** Map of singleton and non-singleton bean names, keyed by dependency type. */
- private final Map<Class<?>, String[]> allBeanNamesByType = new ConcurrentHashMap<>(64);