首页 > 代码库 > Java注解

Java注解

https://www.atatech.org/articles/52027

 

浅析Java注解

     问题缘起是在看别人代码时偶然看到@interface的应用,看的一知半解。我自己对注解这一块并不是很熟悉,一直以来都停留在用的层面,今天借着问题对注解这块稍微深入一下,收集整理了一些自认为有价值的内容,以供用时翻阅。

    关于java注解的概念介绍,找到了一篇介绍详尽的文档:技术分享
转自:http://www.cnblogs.com/peida/archive/2013/04/26/3038503.html

     标准注解我们平时经常会用到,但通过@interface定义的自定义注解用的比较少,相对来说使用比较多得是@Autowired、@Value、@Resource这类Spring注解,这类注解都是RUNTIME运行时注解,标准注解中除了@Override外也都是运行时注解,@Override是SOURCE注解,当@RetentionPolicy不指定时默认是CLASS注解,CLASS注解相对使用比较少,比较:http://stackoverflow.com/questions/5971234/retentionpolicy-class-vs-runtime
    以下通过模拟@Resource的实现案例简单回顾下注解的使用。

    首先自定运行时注解@ZxfResource,指定其适用于字段属性和方法

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

	//注解的name属性
	public String name() default "";
}

    定义用户类UserDaoImpl

public class UserDaoImpl {
	
	String name ;
	
	public void show(){
		System.out.println("这里是dao方法........");
	}
}

定义用户服务类UserServiceImpl
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方法........");
	}
}

     编写Spring bean的xml文件

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

     Springbean 可以通过简单的id和包路径定义,因此可以定义springbean定义类

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;
	}

}

     模拟Spring加载bean的过程

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);
		//实例化bean
		this.instancesBean();
		//注解处理器
		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);
			}
		} catch (DocumentException e) {
			log.info("读取配置文件出错....");
		}
	}
	
	/**
	 * 实例化Bean
	 */
	public void instancesBean() {
		for (BeanDefine bean : beanList) {
			try {
				sigletions.put(bean.getId(), Class.forName(bean.getClassName()).newInstance());
			} catch (Exception e) {
				log.info("实例化Bean出错...");
			}
		}
	}
	
	/**
	 * 注解处理器
	 * 如果注解ZxfResource配置了name属性,则根据name所指定的名称获取要注入的实例引用,如果注解ZxfResource
	 * 没有配置name属性,则根据属性所属类型来扫描配置文件获取要注入的实例引用
	 * 
	 */
	public void annotationInject(){
		for(String beanName:sigletions.keySet()){
			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 = http://www.mamicode.com/null;
					if(resource.name()!=null&&!"".equals(resource.name())){
						//获取注解的name属性的内容
						name = resource.name();
						value = http://www.mamicode.com/sigletions.get(name);
					}else{ //如果当前注解没有指定name属性,则根据类型进行匹配
						for(String key : sigletions.keySet()){
							//判断当前属性所属的类型是否在配置文件中存在
							if(proderdesc.getPropertyType().isAssignableFrom(sigletions.get(key).getClass())){
								//获取类型匹配的实例对象
								value = http://www.mamicode.com/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 = http://www.mamicode.com/null;
					if(resource.name()!=null&&!"".equals(resource.name())){
						name = resource.name();
						value = http://www.mamicode.com/sigletions.get(name);
					}else{
						for(String key : sigletions.keySet()){
							//判断当前属性所属的类型是否在配置文件中存在
							if(f.getType().isAssignableFrom(sigletions.get(key).getClass())){
								//获取类型匹配的实例对象
								value = http://www.mamicode.com/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("springbeans-test.xml");
		UserServiceImpl userService =(UserServiceImpl)path.getBean("userService");
		userService.show();
	}
}
调试即可清晰认识@Resource注解在Spring bean加载过程中的使用过程。

 以上模拟@Resource注解使用转自:http://zxf-noimp.iteye.com/blog/1071765

关注

 

Java注解