前言
上一篇文章講了如何自定義注解，注解的加載和使用，這篇講一下Spring的IOC過程，并通過自定義注解來實(shí)現(xiàn)IOC。
自定義注解
還是先看一下個(gè)最簡單的例子，源碼同樣放在了Github。
先定義自己的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyInject {
}
注入AutowiredAnnotationBeanPostProcessor，并設(shè)置自己定義的注解類
@Configuration
public class CustomizeAutowiredTest {
public static void main(String[] args) {
AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();
annotationConfigApplicationContext.register(CustomizeAutowiredTest.class);
annotationConfigApplicationContext.refresh();
BeanClass beanClass = annotationConfigApplicationContext.getBean(BeanClass.class);
beanClass.print();
}
@Component
public static class BeanClass {
@MyInject
private FieldClass fieldClass;
public void print() {
fieldClass.print();
}
}
@Component
public static class FieldClass {
public void print() {
System.out.println("hello world");
}
}
@Bean
public AutowiredAnnotationBeanPostProcessor getAutowiredAnnotationBeanPostProcessor() {
AutowiredAnnotationBeanPostProcessor autowiredAnnotationBeanPostProcessor = new AutowiredAnnotationBeanPostProcessor();
autowiredAnnotationBeanPostProcessor.setAutowiredAnnotationType(MyInject.class);
return autowiredAnnotationBeanPostProcessor;
}
}
運(yùn)行代碼就會(huì)發(fā)現(xiàn)被@MyInject修飾的fieldClass被注入進(jìn)去了。這個(gè)功能是借用了Spring內(nèi)置的AutowiredAnnotationBeanPostProcessor類來實(shí)現(xiàn)的。
Spring的IOC主要是通過@Resource，@Autowired和@Inject等注解來實(shí)現(xiàn)的，Spring會(huì)掃描Bean的類信息，讀取并設(shè)置帶有這些注解的屬性。查看Spring的源代碼，就會(huì)發(fā)現(xiàn)其中@Resource是由CommonAnnotationBeanPostProcessor解析并注入的。具體的邏輯是嵌入在代碼中的，沒法進(jìn)行定制。
而@Autowired，@Inject是由AutowiredAnnotationBeanPostProcessor解析并注入,觀察這個(gè)類就會(huì)發(fā)現(xiàn)，解析注解是放在autowiredAnnotationTypes里面的，所以初始化完成后，調(diào)用setAutowiredAnnotationType(MyInject.class) 設(shè)置自定義的注解。
public AutowiredAnnotationBeanPostProcessor() {
this.autowiredAnnotationTypes.add(Autowired.class);
this.autowiredAnnotationTypes.add(Value.class);
try {
this.autowiredAnnotationTypes.add((Class<? extends Annotation>)
ClassUtils.forName("javax.inject.Inject", AutowiredAnnotationBeanPostProcessor.class.getClassLoader()));
logger.info("JSR-330 'javax.inject.Inject' annotation found and supported for autowiring");
}
catch (ClassNotFoundException ex) {
// JSR-330 API not available - simply skip.
}
}
public void setAutowiredAnnotationType(Class<? extends Annotation> autowiredAnnotationType) {
Assert.notNull(autowiredAnnotationType, "'autowiredAnnotationType' must not be null");
this.autowiredAnnotationTypes.clear();
this.autowiredAnnotationTypes.add(autowiredAnnotationType);
}
同時(shí)，這個(gè)類實(shí)現(xiàn)了InstantiationAwareBeanPostProcessor接口，Spring會(huì)在初始化Bean的時(shí)候查找實(shí)現(xiàn)InstantiationAwareBeanPostProcessor的Bean，并調(diào)用接口定義的方法,具體實(shí)現(xiàn)的邏輯在AbstractAutowireCapableBeanFactory的populateBean方法中。
AutowiredAnnotationBeanPostProcessor實(shí)現(xiàn)了這個(gè)接口的postProcessPropertyValues方法。這個(gè)方法里，掃描了帶有注解的字段和方法，并注入到Bean。
public PropertyValues postProcessPropertyValues(
PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeansException {
InjectionMetadata metadata = findAutowiringMetadata(beanName, bean.getClass());
try {
metadata.inject(bean, beanName, pvs);
}
catch (Throwable ex) {
throw new BeanCreationException(beanName, "Injection of autowired dependencies failed", ex);
}
return pvs;
}
掃描的方法如下
private InjectionMetadata buildAutowiringMetadata(Class<?> clazz) {
LinkedList<InjectionMetadata.InjectedElement> elements = new LinkedList<InjectionMetadata.InjectedElement>();
Class<?> targetClass = clazz;
do {
LinkedList<InjectionMetadata.InjectedElement> currElements = new LinkedList<InjectionMetadata.InjectedElement>();
for (Field field : targetClass.getDeclaredFields()) {
Annotation annotation = findAutowiredAnnotation(field);
if (annotation != null) {
if (Modifier.isStatic(field.getModifiers())) {
if (logger.isWarnEnabled()) {
logger.warn("Autowired annotation is not supported on static fields: " + field);
}
continue;
}
boolean required = determineRequiredStatus(annotation);
currElements.add(new AutowiredFieldElement(field, required));
}
}
for (Method method : targetClass.getDeclaredMethods()) {
Method bridgedMethod = BridgeMethodResolver.findBridgedMethod(method);
Annotation annotation = BridgeMethodResolver.isVisibilityBridgeMethodPair(method, bridgedMethod) ?
findAutowiredAnnotation(bridgedMethod) : findAutowiredAnnotation(method);
if (annotation != null && method.equals(ClassUtils.getMostSpecificMethod(method, clazz))) {
if (Modifier.isStatic(method.getModifiers())) {
if (logger.isWarnEnabled()) {
logger.warn("Autowired annotation is not supported on static methods: " + method);
}
continue;
}
if (method.getParameterTypes().length == 0) {
if (logger.isWarnEnabled()) {
logger.warn("Autowired annotation should be used on methods with actual parameters: " + method);
}
}
boolean required = determineRequiredStatus(annotation);
PropertyDescriptor pd = BeanUtils.findPropertyForMethod(method);
currElements.add(new AutowiredMethodElement(method, required, pd));
}
}
elements.addAll(0, currElements);
targetClass = targetClass.getSuperclass();
}
while (targetClass != null && targetClass != Object.class);
return new InjectionMetadata(clazz, elements);
}
注入的方法在AutowiredMethodElement和AutowiredFieldElement的inject()方法中。
自定義注解注入
AutowiredAnnotationBeanPostProcessor是利用特定的接口來實(shí)現(xiàn)依賴注入的。所以自定義的注解注入，也可以通過實(shí)現(xiàn)相應(yīng)的接口來嵌入到Bean的初始化過程中。
- BeanPostProcessor會(huì)嵌入到Bean的初始化前后
- InstantiationAwareBeanPostProcessor繼承自BeanPostProcessor,增加了實(shí)例化前后等方法
第二個(gè)例子就是實(shí)現(xiàn)BeanPostProcessor接口，嵌入到Bean的初始化過程中，來完成自定義注入的，完整的例子同樣放在Github，第二個(gè)例子實(shí)現(xiàn)了兩種注入模式，第一種是單個(gè)字段的注入，用@MyInject注解字段。第二種是使用@FullInject注解，會(huì)掃描整理類的所有字段，進(jìn)行注入。這里主要說明一下@FullInject的實(shí)現(xiàn)方法。
- 定義FullInject
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FullInject {
}
- JavaBean
public static class FullInjectSuperBeanClass {
private FieldClass superFieldClass;
public void superPrint() {
superFieldClass.print();
}
}
@Component
@FullInject
public static class FullInjectBeanClass extends FullInjectSuperBeanClass {
private FieldClass fieldClass;
public void print() {
fieldClass.print();
}
}
- BeanPostProcessor的實(shí)現(xiàn)類
@Component
public static class MyInjectBeanPostProcessor implements BeanPostProcessor, ApplicationContextAware {
private ApplicationContext applicationContext;
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
if (hasAnnotation(bean.getClass().getAnnotations(), FullInject.class.getName())) {
Class beanClass = bean.getClass();
do {
Field[] fields = beanClass.getDeclaredFields();
for (Field field : fields) {
setField(bean, field);
}
} while ((beanClass = beanClass.getSuperclass()) != null);
} else {
processMyInject(bean);
}
return bean;
}
private void processMyInject(Object bean) {
Class beanClass = bean.getClass();
do {
Field[] fields = beanClass.getDeclaredFields();
for (Field field : fields) {
if (!hasAnnotation(field.getAnnotations(), MyInject.class.getName())) {
continue;
}
setField(bean, field);
}
} while ((beanClass = beanClass.getSuperclass()) != null);
}
private void setField(Object bean, Field field) {
if (!field.isAccessible()) {
field.setAccessible(true);
}
try {
field.set(bean, applicationContext.getBean(field.getType()));
} catch (Exception e) {
e.printStackTrace();
}
}
private boolean hasAnnotation(Annotation[] annotations, String annotationName) {
if (annotations == null) {
return false;
}
for (Annotation annotation : annotations) {
if (annotation.annotationType().getName().equals(annotationName)) {
return true;
}
}
return false;
}
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
return bean;
}
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
}
- main 方法
@Configuration
public class CustomizeInjectTest {
public static void main(String[] args) {
AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();
annotationConfigApplicationContext.register(CustomizeInjectTest.class);
annotationConfigApplicationContext.refresh();
FullInjectBeanClass fullInjectBeanClass = annotationConfigApplicationContext.getBean(FullInjectBeanClass.class);
fullInjectBeanClass.print();
fullInjectBeanClass.superPrint();
}
}
這里把處理邏輯放在了postProcessBeforeInitialization方法中，是在Bean實(shí)例化完成，初始化之前調(diào)用的。這里查找類帶有的注解信息，如果帶有@FullInject，就查找類的所有字段，并從applicationContext取出對(duì)應(yīng)的bean注入到這些字段中。
結(jié)語
Spring提供了很多接口來實(shí)現(xiàn)自定義功能，就像這兩篇用到的BeanFactoryPostProcessor和BeanPostProcessor，這兩個(gè)主要是嵌入到BeanFactory和Bean的構(gòu)造過程中，他們的子類還會(huì)有更多更精細(xì)的控制。
