快捷導(dǎo)航

Java利用反射如何查找使用指定注解的類詳解

更新時間：2017年09月30日 10:13:25 作者：Tomoya

這篇文章主要給大家介紹了關(guān)于Java利用反射如何查找使用指定注解的類的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧。

前言

最近有些空，想自己寫個跟spring里的注解一樣的注解來用，然后希望能找到使用了自己寫了注解的類，下面來介紹一下實現(xiàn)方法

聲明，下面代碼是沒看過spring源碼寫的，基本上都是網(wǎng)上找的博客，整理的

定義注解

Controller.java

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Controller {

}

RequestMapping.java

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestMapping {

 String value();

}

使用注解

@Controller
public class IndexController {

 @RequestMapping("/")
 public void index() {
 System.out.println("index method")
 }

 @RequestMapping("/about")
 public void about(String args) {
 System.out.println("about method")
 }

}

掃描包下所有類

下面這段代碼摘自網(wǎng)絡(luò)博客上的

/**
 * 從包package中獲取所有的Class
 *
 * @param packageName
 * @return
 */
public static List<Class<?>> getClasses(String packageName) {

 // 第一個class類的集合
 List<Class<?>> classes = new ArrayList<Class<?>>();
 // 是否循環(huán)迭代
 boolean recursive = true;
 // 獲取包的名字 并進行替換
 String packageDirName = packageName.replace('.', '/');
 // 定義一個枚舉的集合 并進行循環(huán)來處理這個目錄下的things
 Enumeration<URL> dirs;
 try {
 dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
 // 循環(huán)迭代下去
 while (dirs.hasMoreElements()) {
  // 獲取下一個元素
  URL url = dirs.nextElement();
  // 得到協(xié)議的名稱
  String protocol = url.getProtocol();
  // 如果是以文件的形式保存在服務(wù)器上
  if ("file".equals(protocol)) {
  // 獲取包的物理路徑
  String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
  // 以文件的方式掃描整個包下的文件 并添加到集合中
  findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes);
  } else if ("jar".equals(protocol)) {
  // 如果是jar包文件
  // 定義一個JarFile
  JarFile jar;
  try {
   // 獲取jar
   jar = ((JarURLConnection) url.openConnection()).getJarFile();
   // 從此jar包 得到一個枚舉類
   Enumeration<JarEntry> entries = jar.entries();
   // 同樣的進行循環(huán)迭代
   while (entries.hasMoreElements()) {
   // 獲取jar里的一個實體 可以是目錄 和一些jar包里的其他文件 如META-INF等文件
   JarEntry entry = entries.nextElement();
   String name = entry.getName();
   // 如果是以/開頭的
   if (name.charAt(0) == '/') {
    // 獲取后面的字符串
    name = name.substring(1);
   }
   // 如果前半部分和定義的包名相同
   if (name.startsWith(packageDirName)) {
    int idx = name.lastIndexOf('/');
    // 如果以"/"結(jié)尾 是一個包
    if (idx != -1) {
    // 獲取包名 把"/"替換成"."
    packageName = name.substring(0, idx).replace('/', '.');
    }
    // 如果可以迭代下去 并且是一個包
    if ((idx != -1) || recursive) {
    // 如果是一個.class文件 而且不是目錄
    if (name.endsWith(".class") && !entry.isDirectory()) {
     // 去掉后面的".class" 獲取真正的類名
     String className = name.substring(packageName.length() + 1, name.length() - 6);
     try {
     // 添加到classes
     classes.add(Class.forName(packageName + '.' + className));
     } catch (ClassNotFoundException e) {
     e.printStackTrace();
     }
    }
    }
   }
   }
  } catch (IOException e) {
   e.printStackTrace();
  }
  }
 }
 } catch (IOException e) {
 e.printStackTrace();
 }

 return classes;
}

傳入一個包名，就會自動掃描下面所有的類

找出用了注解的類

//找也用了Controller注解的類
private List<Class<?>> controllers;

public List<Class<?>> getControllers() {
 if (controllers == null) {
 controllers = new ArrayList<>();
 List<Class<?>> clsList = getAllClass();
 if (clsList != null && clsList.size() > 0) {
  for (Class<?> cls : clsList) {
  if (cls.getAnnotation(Controller.class) != null) {
   Map<Class<?>, Object> map = new HashMap<>();
   controllers.add(cls);
  }
  }
 }
 }
 return controllers;
}

查找使用RequestMapping注解的方法，并查出注入的參數(shù)

for (Class<?> cls : getControllers()) {
 Method[] methods = cls.getMethods();
 for (Method method : methods) {
 RequestMapping annotation = method.getAnnotation(RequestMapping.class);
 if (annotation != null) {
  String value = annotation.value();//找到RequestMapping的注入value值
  if (value.equals("/about")) {//判斷是不是/about，是的話，就調(diào)用about(args)方法
  method.invoke(cls.newInstance(), "args"); //第二個參數(shù)是方法里的參數(shù)
  }
 }
 }
}

這樣一來，java項目里用純servlet寫的項目，就可以做自己的注解映射路由了，方便極了

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

您可能感興趣的文章: