通过接口获取所有实现类以及通过注解获取实现类的思路

近日，工作上被安排修改项目，别人写的一套内外网同步系统，修改成一套上报下发系统，处理很复杂，在原先那人的基础上修改了不少源代码，比较痛苦的是修改他的源代码，必须要看懂全部代码，改的才能顺利进行下去，其实这是违反面向对象的一项重要原则——开闭原则，像这样的代码，换个人写，时间成本会很高，而如果做好了面向对象的设计的话，在修改的时候，只需实现预留好的接口就可以实现，所以最近一直在构思如何重构整个项目，而且这个系统不像常见的业务系统那样：很多业务都已经确定了，完全没有抽象的必要。考虑到需要一些灵活性，比如未来某个程序猿，需要扩展我预留的接口，我需要调用其实现类，这就导致我要知道他的实现类名称，以获得其beanId，通过Spring IoC再进行获取调用，但是beanId如何获取呢？通过xml或者配置文件感觉又太麻烦，干脆使用一个注解，通过注解获取类的名字，自动转换成相应的beanId，强转后调用接口方法即可完成，当然这样的话有一些弊端，比如自定义的beanId如何处理，暂时还未想好。想法有了，还需要找一些资料弥补知识，下面直接贴上代码：

package com.tjhq.synch2.test;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;

public class ClassUtil {
	
	/**
	* @Description: 根据一个接口返回该接口的所有类
	* @param c 接口
	* @return List<Class>    实现接口的所有类
	 */
	@SuppressWarnings("unchecked")
	public static List<Class> getAllClassByInterface(Class c){
		List returnClassList = new ArrayList<Class>();
		//判断是不是接口,不是接口不作处理
		if(c.isInterface()){
			String packageName = c.getPackage().getName();	//获得当前包名
			try {
				List<Class> allClass = getClasses(packageName);//获得当前包以及子包下的所有类
				
				//判断是否是一个接口
				for(int i = 0; i < allClass.size(); i++){
					if(c.isAssignableFrom(allClass.get(i))){
						if(!c.equals(allClass.get(i))){
							returnClassList.add(allClass.get(i));
						}
					}
				}
			} catch (Exception e) {
				// TODO: handle exception
			}
		}
		return returnClassList;
	}
	
	/**
	 * 
	* @Description: 根据包名获得该包以及子包下的所有类不查找jar包中的
	* @param pageName 包名
	* @return List<Class>    包下所有类
	 */
	private static List<Class> getClasses(String packageName) throws ClassNotFoundException,IOException{
		ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
		String path = packageName.replace(".", "/");
		Enumeration<URL> resources = classLoader.getResources(path);
		List<File> dirs = new ArrayList<File>();
		while(resources.hasMoreElements()){
			URL resource = resources.nextElement();
			String newPath = resource.getFile().replace("%20", " ");
			dirs.add(new File(newPath));
		}
		ArrayList<Class> classes = new ArrayList<Class>();
		for(File directory:dirs){
			classes.addAll(findClass(directory, packageName));
		}
		return classes;
	}
	
	private static  List<Class> findClass(File directory, String packageName) 
		throws ClassNotFoundException{
		List<Class> classes = new ArrayList<Class>();
		if(!directory.exists()){
			return classes;
		}
		File[] files = directory.listFiles();
		for(File file:files){
			if(file.isDirectory()){
				assert !file.getName().contains(".");
				classes.addAll(findClass(file, packageName+"."+file.getName()));
			}else if(file.getName().endsWith(".class")){
				classes.add(Class.forName(packageName+"."+file.getName().substring(0,file.getName().length()-6)));
			}
		}
		return classes;
	}
	
	@SuppressWarnings("unchecked")
	public static List<Class> getAllClassByAnnotation(Class annotationClass){
		List returnClassList = new ArrayList<Class>();
		//判断是不是注解
		if(annotationClass.isAnnotation()){
			String packageName = annotationClass.getPackage().getName();	//获得当前包名
			try {
				List<Class> allClass = getClasses(packageName);//获得当前包以及子包下的所有类
				
				for(int i = 0; i < allClass.size(); i++){
					if(allClass.get(i).isAnnotationPresent(annotationClass)){
						returnClassList.add(allClass.get(i));
					}
				}
			} catch (Exception e) {
				// TODO: handle exception
			}
		}
		return returnClassList;
	}
}

前3个方法是通过接口找实现类的方法，网上随便就搜到了，我这里把物理路径中的空格20%又转换成了空格，否则找不到路径，报错；最后一个方法是照猫画虎，通过注解找其所有实现类的方法。传入注解的Class对象，即可完成；

package com.tjhq.synch2.test;

import java.util.List;

public class TestClassUtil {

	/**
	 * @param args
	 * @throws IllegalAccessException 
	 * @throws InstantiationException 
	 */
	@SuppressWarnings("unchecked")
	public static void main(String[] args) throws InstantiationException, IllegalAccessException {
//		List<Class> list = ClassUtil.getAllClassByInterface(SignInterface.class);
//		for(Class c : list){
//			String name = c.getAnnotation(SignAnnotation.class).getClass().
//			System.out.println(name);
//			SignInterface sign = (SignInterface)c.newInstance();
//			System.out.println(sign.returnStr());
//		}
		List<Class> list = ClassUtil.getAllClassByAnnotation(SignAnnotation.class);
		for(Class c : list){
			//SignInterface sign = (SignInterface)c.newInstance();
			System.out.println(c.getSimpleName());
			SignAnnotation annot = (SignAnnotation) c.getAnnotation(SignAnnotation.class);
			System.out.println(annot.TypeName());
			//System.out.println(sign.returnStr());
		}
		
		
	}

}

下面贴上注解的代码：

package com.tjhq.synch2.test;

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface SignAnnotation {
	public TYPE TypeName() default TYPE.DEFAULTTYPE;
	public enum TYPE{HANDLER,DATATYPE,DEFAULTTYPE};
}

因为需要使用反射，所以Retention的值必须设置为RUNTIME,否则可能会取不到Class对象（没试），接口的代码不贴了，就一个空接口，标记而已！