通過介面獲取所有實現類以及通過註解獲取實現類的思路
阿新 • • 發佈:2019-01-08
近日,工作上被安排修改專案,別人寫的一套內外網同步系統,修改成一套上報下發系統,處理很複雜,在原先那人的基礎上修改了不少原始碼,比較痛苦的是修改他的原始碼,必須要看懂全部程式碼,改的才能順利進行下去,其實這是違反面向物件的一項重要原則——開閉原則,像這樣的程式碼,換個人寫,時間成本會很高,而如果做好了面向物件的設計的話,在修改的時候,只需實現預留好的介面就可以實現,所以最近一直在構思如何重構整個專案,而且這個系統不像常見的業務系統那樣:很多業務都已經確定了,完全沒有抽象的必要。考慮到需要一些靈活性,比如未來某個程式猿,需要擴充套件我預留的介面,我需要呼叫其實現類,這就導致我要知道他的實現類名稱,以獲得其beanId,通過Spring IoC再進行獲取呼叫,但是beanId如何獲取呢?通過xml或者配置檔案感覺又太麻煩,乾脆使用一個註解,通過註解獲取類的名字,自動轉換成相應的beanId,強轉後呼叫介面方法即可完成,當然這樣的話有一些弊端,比如自定義的beanId如何處理,暫時還未想好。想法有了,還需要找一些資料彌補知識,下面直接貼上程式碼:
前3個方法是通過介面找實現類的方法,網上隨便就搜到了,我這裡把物理路徑中的空格20%又轉換成了空格,否則找不到路徑,報錯;最後一個方法是照貓畫虎,通過註解找其所有實現類的方法。傳入註解的Class物件,即可完成;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; } }
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物件(沒試),介面的程式碼不貼了,就一個空介面,標記而已!