詳解Spring Boot 使用Java代碼創(chuàng)建Bean并注冊到Spring中
從 Spring3.0 開始,增加了一種新的途經來配置Bean Definition,這就是通過 Java Code 配置 Bean Definition。
與Xml和Annotation兩種配置方式不同點在于:
前兩種Xml和Annotation的配置方式為預定義方式,即開發(fā)人員通過 XML 文件或者 Annotation 預定義配置 bean 的各種屬性后,啟動 spring 容器,Spring 容器會首先解析這些配置屬性,生成對應都?Bean Definition,裝入到 DefaultListableBeanFactory 對象的屬性容器中去。與此同時,Spring 框架也會定義一些內部使用的 Bean 定義,如 bean 名為”org.springframework.context.annotation.internalConfigurationAnnotationProcessor”的 ConfigurationClassPostProcessor 定義。
而后此刻不會做任何 Bean Definition 的定義解析動作,Spring 框架會根據(jù)前兩種配置,過濾出 BeanDefinitionRegistryPostProcessor 類型的 Bean 定義,并通過 Spring 框架生成其對應的 Bean 對象(如 ConfigurationClassPostProcessor 實例)。結合 Spring 上下文源碼可知這個對象是一個 processor 類型工具類,Spring 容器會在實例化開發(fā)人員所定義的 Bean 前先調用該 processor 的 postProcessBeanDefinitionRegistry(…) 方法。此處實現(xiàn)基于 Java Code 配置Bean Definition的處理。
基于 Java Code 解析 Bean 的順序圖(查看大圖)

基于 Java Code 的配置方式,其執(zhí)行原理不同于前兩種。它是在 Spring 框架已經解析了基于 XML 和 Annotation 配置后,通過加入 BeanDefinitionRegistryPostProcessor 類型的 processor 來處理配置信息,讓開發(fā)人員通過 Java 編程方式定義一個 Java 對象。其優(yōu)點在于可以將配置信息集中在一定數(shù)量的 Java 對象中,同時通過 Java 編程方式,比基于 Annotation 方式具有更高的靈活性。并且該配置方式給開發(fā)人員提供了一種非常好的范例來增加用戶自定義的解析工具類。其主要缺點在于與 Java 代碼結合緊密,配置信息的改變需要重新編譯 Java 代碼,另外這是一種新引入的解析方式,需要一定的學習成本。
另外提及一點的就是,Spring框架有3個主要的Hook類,分別是:
org.springframework.context.ApplicationContextAware
它的setApplicationContext 方法將在Spring啟動之前第一個被調用。我們用來同時啟動Jdon框架。
org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor
它的postProcessBeanDefinitionRegistry 和 postProcessBeanFactory 方法是第二和第三被調用,它們在Bean初始化創(chuàng)建之前啟動,如果Spring的bean需要的其他第三方中的組件,我們在這里將其注入給Spring。
org.springframework.context.ApplicationListener
用于在初始化完成后做一些事情,當Spring所有XML或元注解的Bean都啟動被創(chuàng)建成功了,這時會調用它的唯一方法onApplicationEvent。
下面我們來完成一個,自己通過java代碼創(chuàng)建bean,并注冊為Spring管理。
本例中,我們創(chuàng)建一個接口,然后創(chuàng)建該接口的2個實現(xiàn)類,分別命名不同的名字,然后在需要注入的地方使用@Qualifier 指定注入對應的實例。
1、接口Shanhy.java
package org.springboot.sample.config;
public interface Shanhy {
void display();
}
2、實現(xiàn)類ShanhyA.java
package org.springboot.sample.config;
public class ShanhyA implements Shanhy {
@Override
public void display() {
System.out.println("AAAAAAAAAAAA");
}
}
3、實現(xiàn)類ShanhyB.java
package org.springboot.sample.config;
public class ShanhyB implements Shanhy {
@Override
public void display() {
System.out.println("BBBBBBBBBBBB");
}
}
4、定義接口BeanDefinitionRegistryPostProcessor的實現(xiàn)
package org.springboot.sample.config;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.AnnotatedGenericBeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.context.annotation.AnnotationBeanNameGenerator;
import org.springframework.context.annotation.AnnotationConfigUtils;
import org.springframework.context.annotation.AnnotationScopeMetadataResolver;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ScopeMetadata;
import org.springframework.context.annotation.ScopeMetadataResolver;
/**
* 實現(xiàn)自己實例化bean并注冊為Spring管理
*
* @author 單紅宇(365384722)
* @create 2016年1月21日
*/
@Configuration
public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
private static final Logger logger = LoggerFactory.getLogger(MyBeanDefinitionRegistryPostProcessor.class);
private ScopeMetadataResolver scopeMetadataResolver = new AnnotationScopeMetadataResolver();
private BeanNameGenerator beanNameGenerator = new AnnotationBeanNameGenerator();
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
logger.info("Invoke Metho postProcessBeanFactory");
// 這里可以設置屬性,例如
BeanDefinition bd = beanFactory.getBeanDefinition("dataSourceA");
MutablePropertyValues mpv = bd.getPropertyValues();
mpv.addPropertyValue("driverClassName", "com.mysql.jdbc.Driver");
mpv.addPropertyValue("url", "jdbc:mysql://localhost:3306/test");
mpv.addPropertyValue("username", "root");
mpv.addPropertyValue("password", "123456");
}
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
logger.info("Invoke Metho postProcessBeanDefinitionRegistry");
registerBean(registry, "shanhyA", ShanhyA.class);
registerBean(registry, "shanhyB", ShanhyB.class);
registerBean(registry, "dataSourceA", org.apache.tomcat.jdbc.pool.DataSource.class);
}
private void registerBean(BeanDefinitionRegistry registry, String name, Class<?> beanClass){
AnnotatedGenericBeanDefinition abd = new AnnotatedGenericBeanDefinition(beanClass);
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd);
abd.setScope(scopeMetadata.getScopeName());
// 可以自動生成name
String beanName = (name != null ? name : this.beanNameGenerator.generateBeanName(abd, registry));
AnnotationConfigUtils.processCommonDefinitionAnnotations(abd);
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(abd, beanName);
BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, registry);
}
}
5、使用測試
和平常一樣可以直接注入我們的對象,對于同樣接口的我們需要指定name
/**
* 測試參數(shù)注入
*
* @author 單紅宇(365384722)
* @create 2016年1月13日
*/
@Configuration
public class MyConfiguration {
@Bean
public FilterRegistrationBean filterRegistrationBean(@Qualifier("shanhyB") Shanhy shanhy) {
FilterRegistrationBean filterRegistration = new FilterRegistrationBean();
shanhy.display();
// 省略代碼
return filterRegistration;
}
}
使用@Resource 或者 @Autowired并指定@Qualifier 也可以
@RestController
@RequestMapping("/hello")
public class HelloController {
@Resource(name="shanhyA")
private Shanhy shanhyA;
@Autowired
@Qualifier("shanhyB")
private Shanhy shanhyB;
// 省略代碼
}
這里有點經驗要說一下,在 @Configuration 中,不能使用注入屬性的方式注入,只能通過參數(shù)的方式注入,其原因就是@Configuration的類一開始變被加載,此時你想進行屬性注入,需要注入的bean對象都還不存在呢。
下一篇文章,我們將使用這種方法動態(tài)創(chuàng)建基于MyBatis的多數(shù)據(jù)源。
下面的代碼片段也可以注冊Bean,比較簡單:
@Configuration
@Import(Registrar.class)
public class TestConfig {
}
class Registrar implements ImportBeanDefinitionRegistrar {
private static final String BEAN_NAME = "myTestBean";
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
if (!registry.containsBeanDefinition(BEAN_NAME)) {
GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
beanDefinition.setBeanClass(ExamplePostProcessor.class);
beanDefinition.setSynthetic(true);
registry.registerBeanDefinition(BEAN_NAME, beanDefinition);
}
}
}
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關文章
徹底理解Spring注解@Autowired實現(xiàn)原理
這篇文章主要為大家詳細的介紹了Spring注解@Autowired實現(xiàn)的原理,縝密的邏輯分析,實踐應用示例操作說明,讓大家徹底的理解Spring注解@Autowired背后實現(xiàn)原理2022-03-03

