Spring 注解实现原理

Spring 注解实现原理

转自https://www.iteye.com/blog/zxf-noimp-1071765

Spring注解@Resource和@Autowired区别对比:

  1. @Autowired @Autowired为Spring提供的注解,需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。
  2. @Resource
    @Resource默认按照ByName自动注入,由J2EE提供,需要导入包javax.annotation.Resource。@Resource有两个重要的属性:name和type,而Spring将@Resource注解的name属性解析为bean的名字,而type属性则解析为bean的类型。所以,如果使用name属性,则使用byName的自动注入策略,而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性,这时将通过反射机制使用byName自动注入策略。

注:最好是将@Resource放在setter方法上,因为这样更符合面向对象的思想,通过set、get去操作属性,而不是直接去操作属性。

spring注解原理:
本例实现了在set方法上和在字段属性上注解的处理解析:
1.首先自定义注解:

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// 在运行时执行
@Retention(RetentionPolicy.RUNTIME)
// 注解适用地方(字段和方法)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface ZxfResource {
	//注解属性name
	public String name() default "";
}

2.使用注解的服务类

public class UserServiceImpl {

	public UserDaoImpl userDao;
	public User1DaoImpl user1Dao;

	// 字段上的注解,可以配置name属性
	@ZxfResource
	public User2DaoImpl user2Dao;

	// set方法上的注解,带有name属性
	@ZxfResource(name = "userDao")
	public void setUserDao(UserDaoImpl userDao) {
		this.userDao = userDao;
	}

	// set方法上的注解,没有配置name属性
	@ZxfResource
	public void setUser1Dao(User1DaoImpl user1Dao) {
		this.user1Dao = user1Dao;
	}

	public void show() {
		userDao.show();
		user1Dao.show1();
		user2Dao.show2();
		System.out.println("这里是Service方法........");
	}

	@Override
	public String toString() {
		return "UserServiceImpl{" +
				"userDao=" + userDao +
				", user1Dao=" + user1Dao +
				", user2Dao=" + user2Dao +
				'}';
	}
}

3.要注入到UserServiceImpl的DAO

public class UserDaoImpl {
	
	String name ;
	
	public void show(){
		System.out.println("这里是dao方法........");
	}
}
// User1DaoImpl User2DaoImpl代码相同输出语句不同

4.要解析的xml文件代码

<?xml version="1.0" encoding="UTF-8"?>
<beans>
    <bean id = "userDao" class="UserDaoImpl" />
    <bean id = "user1Dao" class="User1DaoImpl" />
    <bean id = "user2Dao" class="User2DaoImpl" />
    <bean id = "userService" class = "UserServiceImpl" />
</beans>

5.临时存储class信息的类

public class BeanDefine {
	public String id;
	public String className;
	public BeanDefine(String id, String className) {
		this.id = id;
		this.className = className;
	}
	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}
	public String getClassName() {
		return className;
	}
	public void setClassName(String className) {
		this.className = className;
	}

}

6.注解解析类

import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.log4j.Logger;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

public class ClassPathXMLApplicationContext {

	Logger log = Logger.getLogger(ClassPathXMLApplicationContext.class);

	List<BeanDefine> beanList = new ArrayList<BeanDefine>();
	Map<String, Object> sigletions = new HashMap<String, Object>();

	public ClassPathXMLApplicationContext(String fileName) {
		//读取配置文件中管理的bean
		this.readXML(fileName);
		//实例化xml中定义的bean
		this.instancesBean();
		//注解处理器 为带注解的bean注入实例
		this.annotationInject();
	}

	/**
	 * 读取Bean配置文件
	 * @param fileName
	 * @return
	 */
	@SuppressWarnings("unchecked")
	public void readXML(String fileName) {
		Document document = null;
		SAXReader saxReader = new SAXReader();
		try {
			ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
			document = saxReader.read(classLoader.getResourceAsStream(fileName));
			Element beans = document.getRootElement();
			for (Iterator<Element> beansList = beans.elementIterator(); beansList.hasNext();) {
				Element element = beansList.next();
				BeanDefine bean = new BeanDefine(
						element.attributeValue("id"),
						element.attributeValue("class"));
				beanList.add(bean);
				//将xml文件中的类信息以BeanDefine的形式存储在beanList中
			}
		} catch (DocumentException e) {
			log.info("读取配置文件出错....");
		}
	}
	
	/**
	 * 实例化Bean
	 */
	public void instancesBean() {
		for (BeanDefine bean : beanList) {
			try {
				sigletions.put(bean.getId(), Class.forName(bean.getClassName()).newInstance());
				// 循环beanList中的元素根据其信息实例化对象
			} catch (Exception e) {
				log.info("实例化Bean出错...");
			}
		}
	}
	
	/**
	 * 注解处理器
	 * 如果注解ZxfResource配置了name属性,则根据name所指定的名称获取要注入的实例引用,如果注解ZxfResource
	 * 没有配置name属性,则根据属性所属类型来扫描配置文件获取要注入的实例引用
	 * 
	 */
	public void annotationInject(){
		for(String beanName:sigletions.keySet()){
			//循环sigletions集合中的实例扫描其注解 依赖注入
			Object bean = sigletions.get(beanName);
			if(bean!=null){
				this.propertyAnnotation(bean);
				this.fieldAnnotation(bean);
			}
		}
	}
	
	/**
	 * 处理在set方法加入的注解
	 * @param bean 处理的bean
	 */
	public void propertyAnnotation(Object bean){
		try {
			//获取其属性的描述
			PropertyDescriptor[] ps = Introspector.getBeanInfo(bean.getClass()).getPropertyDescriptors();
			for(PropertyDescriptor proderdesc : ps){
				//获取所有set方法
				Method setter = proderdesc.getWriteMethod();
				//判断set方法是否定义了注解
				if(setter!=null && setter.isAnnotationPresent(ZxfResource.class)){
					//获取当前注解,并判断name属性是否为空
					ZxfResource resource = setter.getAnnotation(ZxfResource.class);
					String name ="";
					Object value = null;
					if(resource.name()!=null&&!"".equals(resource.name())){
						//获取注解的name属性的内容
						name = resource.name();
						value = sigletions.get(name);
					}else{ //如果当前注解没有指定name属性,则根据类型进行匹配
						for(String key : sigletions.keySet()){
							//判断当前属性所属的类型是否在配置文件中存在
							if(proderdesc.getPropertyType().isAssignableFrom(sigletions.get(key).getClass())){
								//获取类型匹配的实例对象
								value = sigletions.get(key);
								break;
							}
						}
					}
					//允许访问private方法
					setter.setAccessible(true);
					//把引用对象注入属性
					setter.invoke(bean, value); 
				}
			}
		} catch (Exception e) {
			log.info("set方法注解解析异常..........");
		}
	}
	
	/**
	 * 处理在字段上的注解
	 * @param bean 处理的bean
	 */
	public void fieldAnnotation(Object bean){
		try {
			//获取其全部的字段描述
			Field[] fields = bean.getClass().getFields();
			for(Field f : fields){
				if(f!=null && f.isAnnotationPresent(ZxfResource.class)){
					ZxfResource resource = f.getAnnotation(ZxfResource.class);
					String name ="";
					Object value = null;
					if(resource.name()!=null&&!"".equals(resource.name())){
						name = resource.name();
						value = sigletions.get(name);
					}else{
						for(String key : sigletions.keySet()){
							//判断当前属性所属的类型是否在配置文件中存在
							if(f.getType().isAssignableFrom(sigletions.get(key).getClass())){
								//获取类型匹配的实例对象
								value = sigletions.get(key);
								break;
							}
						}
					}
					//允许访问private字段
					f.setAccessible(true);
					//把引用对象注入属性
					f.set(bean, value);
				}
			}
		} catch (Exception e) {
			log.info("字段注解解析异常..........");
		}
	}
	
	/**
	 * 获取Map中的对应的bean实例
	 * @param beanId
	 * @return
	 */
	public Object getBean(String beanId) {
		return sigletions.get(beanId);
	}


	public static void main(String[] args) {
		ClassPathXMLApplicationContext path = new ClassPathXMLApplicationContext(
				"configAnnotation.xml");
		UserServiceImpl userService =(UserServiceImpl)path.getBean("userService");
		userService.show();
	}
}

项目的完整目录:
在这里插入图片描述
运行过程:
新建ClassPathXMLApplicationContext类的示例path对象传入参数xml文件路径的字符串
调用path的getBean(“userService”)方法从Map集合sigletions中取得UserServiceImpl对象

往上看什么时候向sigletions中加入值
首先在ClassPathXMLApplicationContext的对象创建时其构造方法执行
,其构造方法中调用了三个方法分别为

		//读取配置文件中管理的bean
		this.readXML(fileName);
		//实例化xml中定义的bean
		this.instancesBean();
		//注解处理器 为带注解的bean注入实例
		this.annotationInject();

第一个方法readXML(fileName)读取xml(将读取到的类名和CLass信息存储在List beanList中)

	public void readXML(String fileName) {
		Document document = null;
		SAXReader saxReader = new SAXReader();
		try {
			ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
			document = saxReader.read(classLoader.getResourceAsStream(fileName));
			Element beans = document.getRootElement();
			for (Iterator<Element> beansList = beans.elementIterator(); beansList.hasNext();) {
				Element element = beansList.next();
				BeanDefine bean = new BeanDefine(
						element.attributeValue("id"),
						element.attributeValue("class"));
				beanList.add(bean);
				//将xml文件中的类信息以BeanDefine的形式存储在beanList中
			}
		} catch (DocumentException e) {
			log.info("读取配置文件出错....");
		}
	}

第二个方法instancesBean()(通过反射循环实例化xml中定义的bean(已存储到beanList中),)

public void instancesBean() {
		for (BeanDefine bean : beanList) {
			try {
				sigletions.put(bean.getId(), Class.forName(bean.getClassName()).newInstance());
				// 循环beanList中的元素根据其信息实例化对象
			} catch (Exception e) {
				log.info("实例化Bean出错...");
			}
		}
	}

第三个方法annotationInject()(为带注解的bean注入实例)
这个方法又调用了两个方法分别处理在set方法加入的注解和在字段上的注解

	public void annotationInject(){
		for(String beanName:sigletions.keySet()){
			//循环sigletions集合中的实例扫描其注解 依赖注入
			Object bean = sigletions.get(beanName);
			if(bean!=null){
				this.propertyAnnotation(bean);
				this.fieldAnnotation(bean);
			}
		}
	}

set方法上的

public void propertyAnnotation(Object bean){
		try {
			//获取其属性的描述
			PropertyDescriptor[] ps = Introspector.getBeanInfo(bean.getClass()).getPropertyDescriptors();
			for(PropertyDescriptor proderdesc : ps){
				//获取所有set方法
				Method setter = proderdesc.getWriteMethod();
				//判断set方法是否定义了注解
				if(setter!=null && setter.isAnnotationPresent(ZxfResource.class)){
					//获取当前注解,并判断name属性是否为空
					ZxfResource resource = setter.getAnnotation(ZxfResource.class);
					String name ="";
					Object value = null;
					if(resource.name()!=null&&!"".equals(resource.name())){
						//获取注解的name属性的内容
						name = resource.name();
						value = sigletions.get(name);
					}else{ //如果当前注解没有指定name属性,则根据类型进行匹配
						for(String key : sigletions.keySet()){
							//判断当前属性所属的类型是否在配置文件中存在
							if(proderdesc.getPropertyType().isAssignableFrom(sigletions.get(key).getClass())){
								//获取类型匹配的实例对象
								value = sigletions.get(key);
								break;
							}
						}
					}
					//允许访问private方法
					setter.setAccessible(true);
					//注意这里通过反射调用set方法 把引用对象注入属性
					setter.invoke(bean, value); 
				}
			}
		} catch (Exception e) {
			log.info("set方法注解解析异常..........");
		}
	}

字段上的

public void fieldAnnotation(Object bean){
		try {
			//获取其全部的字段描述
			Field[] fields = bean.getClass().getFields();
			for(Field f : fields){
				if(f!=null && f.isAnnotationPresent(ZxfResource.class)){
					ZxfResource resource = f.getAnnotation(ZxfResource.class);
				//获取字段上的注解
					String name ="";
					Object value = null;
					if(resource.name()!=null&&!"".equals(resource.name())){
						name = resource.name();
						value = sigletions.get(name);
						//获取注解中的参数
					}else{
						for(String key : sigletions.keySet()){
							//判断当前属性所属的类型是否在配置文件中存在
							if(f.getType().isAssignableFrom(sigletions.get(key).getClass())){
								//获取类型匹配的实例对象
								value = sigletions.get(key);
								break;
							}
						}
					}
					//允许访问private字段
					f.setAccessible(true);
					//通过反射field.set方法把引用对象注入属性
					f.set(bean, value);
				}
			}
		} catch (Exception e) {
			log.info("字段注解解析异常..........");
		}
	}

运行ClassPathXMLApplicationContext的main方法结果:
在这里插入图片描述
原作者源码已不可下载(除非有Iteye账号)不过被我放到了github上:
源码Github地址
此外要运行需导入demo4j的jar包以解析xml文件请自行导入我提供的资源
demo4jJAR包
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值