Получение всех классов из пакета
-
05-07-2019 - |
Вопрос
Допустим, у меня есть пакет java commands
, который содержит классы, все они наследуются от ICommand
, могу ли я как-то получить все эти классы? Я блокирую что-то среди строк:
Package p = Package.getPackage("commands");
Class<ICommand>[] c = p.getAllPackagedClasses(); //not real
Возможно ли что-то подобное?
Решение
Вот базовый пример, предполагая, что классы не упакованы в JAR:
// Prepare.
String packageName = "com.example.commands";
List<Class<ICommand>> commands = new ArrayList<Class<ICommand>>();
URL root = Thread.currentThread().getContextClassLoader().getResource(packageName.replace(".", "/"));
// Filter .class files.
File[] files = new File(root.getFile()).listFiles(new FilenameFilter() {
public boolean accept(File dir, String name) {
return name.endsWith(".class");
}
});
// Find classes implementing ICommand.
for (File file : files) {
String className = file.getName().replaceAll(".class<*>quot;, "");
Class<?> cls = Class.forName(packageName + "." + className);
if (ICommand.class.isAssignableFrom(cls)) {
commands.add((Class<ICommand>) cls);
}
}
Другие советы
Ниже приведена реализация, использующая API-интерфейс JSR-199, т.е. классы из javax.tools. *
:
List<Class> commands = new ArrayList<Class>();
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
StandardJavaFileManager fileManager = compiler.getStandardFileManager(
null, null, null);
Location location = StandardLocation.CLASS_PATH;
String packageName = "commands";
Set<JavaFileObject.Kind> kinds = new HashSet<JavaFileObject.Kind>();
kinds.add(JavaFileObject.Kind.CLASS);
boolean recurse = false;
Iterable<JavaFileObject> list = fileManager.list(location, packageName,
kinds, recurse);
for (JavaFileObject javaFileObject : list) {
commands.add(javaFileObject.getClass());
}
Вот служебный метод, использующий Spring.
Подробную информацию о шаблоне можно найти в здесь
public static List<Class> listMatchingClasses(String matchPattern) throws IOException {
List<Class> classes = new LinkedList<Class>();
PathMatchingResourcePatternResolver scanner = new PathMatchingResourcePatternResolver();
Resource[] resources = scanner.getResources(matchPattern);
for (Resource resource : resources) {
Class<?> clazz = getClassFromResource(resource);
classes.add(clazz);
}
return classes;
}
public static Class getClassFromResource(Resource resource) {
try {
String resourceUri = resource.getURI().toString();
resourceUri = resourceUri.replace(esourceUri.indexOf(".class"), "").replace("/", ".");
// try printing the resourceUri before calling forName, to see if it is OK.
return Class.forName(resourceUri);
} catch (Exception ex) {
ex.printStackTrace();
}
return null;
}
Начните с публичного Classloader.getResources (имя строки). Спросите у загрузчика классов класс, соответствующий каждому имени в интересующем вас пакете. Повторите эти действия для всех релевантных загрузчиков классов.
Да, но это не самая простая вещь. Есть много проблем с этим. Не все классы легко найти. Некоторые классы могут быть в: Jar, как файл классов, по сети и т. Д.
Посмотрите эту тему. р>
Чтобы убедиться, что они относятся к типу ICommand, вам нужно будет использовать отражение для проверки класса наследования.
Это был бы очень полезный инструмент, который нам нужен, и JDK должен оказать некоторую поддержку. Р>
Но, вероятно, это лучше сделать во время сборки. Вы знаете, где находятся все ваши файлы классов, и вы можете проверить их статически и построить график. Во время выполнения вы можете запросить этот график, чтобы получить все подтипы. Это требует больше работы, но я считаю, что это действительно относится к процессу сборки.
Используя ClasspathSuite Йоханнеса Линка , я смог сделать это следующим образом: р>
import org.junit.extensions.cpsuite.ClassTester;
import org.junit.extensions.cpsuite.ClasspathClassesFinder;
public static List<Class<?>> getClasses(final Package pkg, final boolean includeChildPackages) {
return new ClasspathClassesFinder(new ClassTester() {
@Override public boolean searchInJars() { return true; }
@Override public boolean acceptInnerClass() { return false; }
@Override public boolean acceptClassName(String name) {
return name.startsWith(pkg.getName()) && (includeChildPackages || name.indexOf(".", pkg.getName().length()) != -1);
}
@Override public boolean acceptClass(Class<?> c) { return true; }
}, System.getProperty("java.class.path")).find();
}
ClasspathClassesFinder ищет файлы классов и jar-файлы в системном classpath.
В вашем конкретном случае вы можете изменить acceptClass следующим образом:
@Override public boolean acceptClass(Class<?> c) {
return ICommand.class.isAssignableFrom(c);
}
Следует отметить одну вещь: будьте осторожны с тем, что вы возвращаете в acceptClassName, так как следующая вещь, которую ClasspathClassesFinder делает, это загружает класс и вызывает acceptClass. Если acceptClassName всегда возвращает true, вы в конечном итоге загрузите каждый класс в classpath, и это может вызвать OutOfMemoryError.
Вы можете использовать OpenPojo и сделать это:
final List<PojoClass> pojoClasses = PojoClassFactory.getPojoClassesRecursively("my.package.path", null);
Затем вы можете просмотреть список и выполнить любую функцию, какую пожелаете.