Java中的包扫描（工具）

在现在好多应用场景中，我们需要得到某个包名下面所有的类， 包括我们自己在src里写的java类和一些第三方提供的jar包里的类，那么怎么来实现呢？

今天带大家来完成这件事。

先分享代码：

1.这个类是一个抽象类，对类的处理交给用户，所以就有了dealClass的抽象方法。

 package com.mec.packscanner.core;

 import java.io.File;
 import java.io.FileFilter;
 import java.io.IOException;
 import java.net.JarURLConnection;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.util.Enumeration;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;

 public abstract class PackageScanner {
     public PackageScanner() {}

     public abstract void dealClass(Class<?> klass);

     //扫描一般的包。
     private void scanPackage(String packageName,File currentfile) {
         File[] filelist = currentfile.listFiles(new FileFilter() {
             //FileFilter是文件过滤器,源代码只写了一个accapt的抽象方法。
             @Override
             public boolean accept(File pathName) {
                 if(pathName.isDirectory()) {    //判断是否是目录
                     return true;
                 }
                 return pathName.getName().endsWith(".class");
             }
         });

         for(File file:filelist) {
             if(file.isDirectory()) {
                 scanPackage(packageName + "." + file.getName(),file);
             }else {
                 String fileName = file.getName().replace(".class", "");
                 String className = packageName + "." + fileName;
                 try {
                     Class<?> klass = Class.forName(className);//取出所有的类
                     if(klass.isAnnotation() //不扫描注解类、枚举类、接口和八大基本类型。
                             ||klass.isEnum()
                             ||klass.isInterface()
                             ||klass.isPrimitive()) {
                         continue;
                     }
                     dealClass(klass);
                 } catch (ClassNotFoundException e) {
                     e.printStackTrace();
                 }
             }
         }
     }

     //扫描jar包方法。
     private void scanPackage(URL url) throws IOException {
         JarURLConnection urlConnection = (JarURLConnection) url.openConnection();
         JarFile jarfile = urlConnection.getJarFile();
         Enumeration<JarEntry> jarEntries = jarfile.entries();
         while(jarEntries.hasMoreElements()) {
             JarEntry jarEntry = jarEntries.nextElement();
             String jarName = jarEntry.getName();
             if(!jarName.endsWith(".class")) {
                 continue;
             }
             String className = jarName.replace(".class", "").replaceAll("/", ".");

             try {
                 Class<?> klass = Class.forName(className);
                 if (klass.isAnnotation()
                         || klass.isInterface()
                         || klass.isEnum()
                         || klass.isPrimitive()) {
                     continue;
                 }
                 dealClass(klass);
             } catch (ClassNotFoundException e) {
                 e.printStackTrace();
             }
         }
     }

     //用类名扫描
     public void packageScan(Class<?> klass) {
         packageScan(klass.getPackage().getName());
     }

     //用包名进行扫描
     public void packageScan(String packageName) {
         String packOpperPath = packageName.replace(".","/");

         //线程上下文类加载器得到当前的classpath的绝对路径.（动态加载资源）
         ClassLoader classloader = Thread.currentThread().getContextClassLoader();
         try {
             //(Thread.currentThread().getContextClassLoader().getResource(""))
             //(来得到当前的classpath的绝对路径的URI表示法。)
             Enumeration<URL> resources = classloader.getResources(packOpperPath);
             while(resources.hasMoreElements()) {
                 //先获得本类的所在位置
                 URL url = resources.nextElement();

                 //url.getProtocol()是获取URL的HTTP协议。
                 if(url.getProtocol().equals("jar")) {
                 //判断是不是jar包
                     scanPackage(url);
                 }else {
                     //此方法不会自动将链接中的非法字符转义。
                     //而在File转化成URI的时候，会将链接中的特殊字符如#或!等字符进行编码。
                     File file = new File(url.toURI());
                     if(!file.exists()) {
                         continue;
                     }
                     scanPackage(packageName,file);
                 }
             }
         } catch (IOException e) {
             e.printStackTrace();
         } catch (URISyntaxException e) {
             e.printStackTrace();
         }
     }
 }

这个是抽象类，对于扫描，我们只提供扫描的工具，而定义抽象方法是往外接，通过使用者的使用来决定用类名还是包名。

对于jar包的扫描，可以进JarURLConnection类和JarFile类的源码中可以理解。

2.定义测试类，它是扫描jar包的：

 package com.mec.packscanner.test;

 import com.mec.packscanner.core.PackageScanner;

 public class Test {

     public static void main(String[] args) {
         new PackageScanner() {

             @Override
             public void dealClass(Class<?> klass) {
                 System.out.println(klass.getName());

             }
         }.packageScan("com.mec.xml_view.core");;
     }

 }

结果：

从结果我们可以看出把jar包中的每一个class都输出了，匿名内部类都被扫描出来了。

我们来看看普通包的结果吧：

 package com.mec.packscanner.test;

 import com.mec.packscanner.core.PackageScanner;

 public class Test {

     public static void main(String[] args) {
         new PackageScanner() {

             @Override
             public void dealClass(Class<?> klass) {
                 System.out.println(klass.getName());

             }
         }.packageScan("com.mec.server_client.core");;
     }

 }

对普通的包也是，这个例子除了接口，其他的都被扫描出来了。

若有漏洞，请指正！感谢您的阅读。