java:基于spring的PathMatchingResourcePatternResolver实现基于包名(package)的类扫描

本文介绍了如何在Spring环境中使用SpringResourceScanner类,通过PathMatchingResourcePatternResolver进行资源扫描,实现查找特定包下的所有类。示例展示了如何在测试类中调用该功能以获取指定包内的类列表。
摘要由CSDN通过智能技术生成

spring-core提供了资源扫描实现,可以获取到java程序运行时的所有类和其他资源,所以在spring环境下,也可以使用它来自己实现查找类的功能

导入依赖

    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>5.3.12</version>
      <scope>compile</scope>
    </dependency>

实现代码:SpringResourceScanner.java

import java.io.IOException;
import java.net.URL;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;

/**
 * 基于Spring {@link PathMatchingResourcePatternResolver}实现资源扫描
 * @author guyadong
 *
 */
public class SpringResourceScanner {
	private static final String CLASS_SUFFIX = ".class";
	private static final PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
	private Set<URL> getResources(String rootDirPath, String suffix) throws IOException {
		if(null==rootDirPath) {
			throw new NullPointerException("rootDirPath must not be null");
		}
		String path = rootDirPath;
		String locationPattern = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + path;
		if(null != suffix) {
			locationPattern+="/**/*"+suffix;
		}
		Resource[] resources = resolver.getResources(locationPattern);
		return Stream.of(resources).map(input->{
			try {
				return input.getURL();
			} catch (IOException e) {
				throw new RuntimeException(e);
			}
		}).collect(Collectors.toSet());
	}
	/**
	 * 扫描指定包名下的所有类
	 * @param packagename
	 * @param filter
	 * @throws IOException
	 */
	public Set<Class<?>> getClasses(String packagename) throws IOException {
		if(null == packagename) {
			throw new NullPointerException("packagename must not be null");
		}
		final String path = packagename.replace('.', '/');
		Set<URL> rootDirs = getResources(path,null);
		Set<URL> urls = getResources(path, CLASS_SUFFIX);
		final Set<String> rootPrefixes = rootDirs.stream().map(input->input.toString().replace(path, "")).collect(Collectors.toSet());
		return urls.stream().map(new CLassBuilder(rootPrefixes)).collect(Collectors.toSet());
	}

	protected static class CLassBuilder implements Function<URL, Class<?>>{
		private final Iterable<String> rootPrefixes;
		public CLassBuilder(Iterable<String> rootPrefixes) {
			this.rootPrefixes = rootPrefixes;
		}
		@Override
		public Class<?> apply(URL input) {
			String url = input.toString();
			for(String prefix:rootPrefixes) {
				if(url.startsWith(prefix)) {
					try {
						String p = url.substring(prefix.length(),url.length()-CLASS_SUFFIX.length());
						String className = p.replace('/', '.');
						return Class.forName( className,false,getDefaultClassLoader());
					} catch (Throwable e) {
						System.out.printf("%s:%s\n",e.getClass().getSimpleName(), e.getMessage());
						return null;
					}
				}
			};
			throw new IllegalArgumentException("INVALID URL "+input);
		}
		
	}
	public static ClassLoader getDefaultClassLoader() {
		ClassLoader cl = null;
		try {
			cl = Thread.currentThread().getContextClassLoader();
		}
		catch (Throwable ex) {
			// Cannot access thread context ClassLoader - falling back...
		}
		if (cl == null) {
			// No thread context class loader -> use class loader of this class.
			cl = SpringResourceScanner.class.getClassLoader();
			if (cl == null) {
				// getClassLoader() returning null indicates the bootstrap ClassLoader
				try {
					cl = ClassLoader.getSystemClassLoader();
				}
				catch (Throwable ex) {
					// Cannot access system ClassLoader - oh well, maybe the caller can live with null...
				}
			}
		}
		return cl;
	}
}

调用示例:SpringResourceScannerTest.java

import static org.junit.Assert.*;

import java.util.Set;

import static net.gdface.utils.SimpleLog.log;

import org.junit.Test;

public class SpringResourceScannerTest {
	public static final SpringResourceScanner SPRING_RESOURCE_SCANNER = new SpringResourceScanner();
	@Test
	public void test3SpringGetClasses() {
		try {
			Set<Class<?>> urls = SPRING_RESOURCE_SCANNER.getClasses("net.facelib.cell");
			for(Class<?> url:urls) {
				log("class:{}",url);
			}
			log("class count:{}",urls.size());
		} catch (Exception e) {
			e.printStackTrace();
			fail();
		}
	}
	@Test
	public void test4SpringGetClasses() {
		try {
			Set<Class<?>> urls = SPRING_RESOURCE_SCANNER.getClasses("org.springframework.core");
			for(Class<?> url:urls) {
				log("class:{}",url);
			}
			log("class count:{}",urls.size());
		} catch (Throwable e) {
			e.printStackTrace();
			fail();
		}
	}
}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

10km

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值