Мне нужно прочитать классы, содержащиеся в пакете Java. Эти классы находятся в classpath. Мне нужно выполнить эту задачу непосредственно из программы Java. Вы знаете простой способ сделать?
List<Class> classes = readClassesFrom("my.package")
Мне нужно прочитать классы, содержащиеся в пакете Java. Эти классы находятся в classpath. Мне нужно выполнить эту задачу непосредственно из программы Java. Вы знаете простой способ сделать?
List<Class> classes = readClassesFrom("my.package")
Если у вас Spring в вашем пути к классам, то это сделает следующее.
Найти все классы в пакете, которые аннотируются с помощью XmlRootElement:
private List<Class> findMyTypes(String basePackage) throws IOException, ClassNotFoundException
{
ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();
MetadataReaderFactory metadataReaderFactory = new CachingMetadataReaderFactory(resourcePatternResolver);
List<Class> candidates = new ArrayList<Class>();
String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
resolveBasePackage(basePackage) + "/" + "**/*.class";
Resource[] resources = resourcePatternResolver.getResources(packageSearchPath);
for (Resource resource : resources) {
if (resource.isReadable()) {
MetadataReader metadataReader = metadataReaderFactory.getMetadataReader(resource);
if (isCandidate(metadataReader)) {
candidates.add(Class.forName(metadataReader.getClassMetadata().getClassName()));
}
}
}
return candidates;
}
private String resolveBasePackage(String basePackage) {
return ClassUtils.convertClassNameToResourcePath(SystemPropertyUtils.resolvePlaceholders(basePackage));
}
private boolean isCandidate(MetadataReader metadataReader) throws ClassNotFoundException
{
try {
Class c = Class.forName(metadataReader.getClassMetadata().getClassName());
if (c.getAnnotation(XmlRootElement.class) != null) {
return true;
}
}
catch(Throwable e){
}
return false;
}
Вы можете использовать Проект Размышлений, описанный здесь
Это довольно полная и простая в использовании.
Краткое описание с сайта:
Отражения сканируют ваш путь к классам, индексируют метаданные, позволяют запросить его во время выполнения и может сохранять и собирать эту информацию для многих модулей в рамках вашего проекта.
Пример:
Reflections reflections = new Reflections(
new ConfigurationBuilder()
.setUrls(ClasspathHelper.forJavaClassPath())
);
Set<Class<?>> types = reflections.getTypesAnnotatedWith(Scannable.class);
Я использую этот, он работает с файлами или архивами jar
public static ArrayList<String>getClassNamesFromPackage(String packageName) throws IOException{
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
URL packageURL;
ArrayList<String> names = new ArrayList<String>();;
packageName = packageName.replace(".", "/");
packageURL = classLoader.getResource(packageName);
if(packageURL.getProtocol().equals("jar")){
String jarFileName;
JarFile jf ;
Enumeration<JarEntry> jarEntries;
String entryName;
// build jar file name, then loop through zipped entries
jarFileName = URLDecoder.decode(packageURL.getFile(), "UTF-8");
jarFileName = jarFileName.substring(5,jarFileName.indexOf("!"));
System.out.println(">"+jarFileName);
jf = new JarFile(jarFileName);
jarEntries = jf.entries();
while(jarEntries.hasMoreElements()){
entryName = jarEntries.nextElement().getName();
if(entryName.startsWith(packageName) && entryName.length()>packageName.length()+5){
entryName = entryName.substring(packageName.length(),entryName.lastIndexOf('.'));
names.add(entryName);
}
}
// loop through files in classpath
}else{
URI uri = new URI(packageURL.toString());
File folder = new File(uri.getPath());
// won't work with path which contains blank (%20)
// File folder = new File(packageURL.getFile());
File[] contenuti = folder.listFiles();
String entryName;
for(File actual: contenuti){
entryName = actual.getName();
entryName = entryName.substring(0, entryName.lastIndexOf('.'));
names.add(entryName);
}
}
return names;
}
Spring реализовал отличную функцию поиска класса в PathMatchingResourcePatternResolver
. Если вы используете префикс classpath*
: вы можете найти все ресурсы, включая классы в заданной иерархии, и даже фильтровать их, если хотите. Затем вы можете использовать дочерние элементы AbstractTypeHierarchyTraversingFilter
, AnnotationTypeFilter
и AssignableTypeFilter
, чтобы отфильтровать эти ресурсы либо на аннотациях уровня классов, либо на интерфейсах, которые они реализовать.
Java 1.6.0_24:
public static File[] getPackageContent(String packageName) throws IOException{
ArrayList<File> list = new ArrayList<File>();
Enumeration<URL> urls = Thread.currentThread().getContextClassLoader()
.getResources(packageName);
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
File dir = new File(url.getFile());
for (File f : dir.listFiles()) {
list.add(f);
}
}
return list.toArray(new File[]{});
}
Scannotation и Reflections использовать класс путь сканирования:
Reflections reflections = new Reflections("my.package");
Set<Class<? extends Object>> classes = reflections.getSubTypesOf(Object.class);
Другим подходом является использование Java Pluggable API обработки аннотации для записи процессора аннотаций, который будет собирать все аннотированные классы во время компиляции и строить индексный файл для использования во время работы. Этот механизм реализован в библиотеке ClassIndex:
Iterable<Class> classes = ClassIndex.getPackageClasses("my.package");
Эта функциональность по-прежнему с подозрением отсутствует в API отражения Java, насколько я знаю. Вы можете получить объект пакета, просто сделав это:
Package packageObj = Package.getPackage("my.package");
Но, как вы, вероятно, заметили, это не позволит вам перечислять классы в этом пакете. На данный момент вы должны придерживаться более ориентированного на файловую систему подхода.
Я нашел некоторые примеры реализаций в this post
Я не уверен на 100%, что эти методы будут работать, когда ваши классы будут похоронены в JAR файлах, но я надеюсь, что один из них сделает это за вас.
Я согласен с @skaffman... если у вас есть другой способ этого, я бы рекомендовал это сделать.
В настоящее время наиболее надежным механизмом для перечисления всех классов в данном пакете является ClassGraph, поскольку он обрабатывает максимально широкий массив механизмов спецификации пути к классам, включая новую систему модулей JPMS. (Я автор.)
List<String> classNames;
try (ScanResult scanResult = new ClassGraph().whitelistPackages("my.package")
.enableClassInfo().scan()) {
classNames = scanResult.getAllClasses().getNames();
}
Bill Burke написал (хороший статью о сканировании классов], а затем написал Scannotation.
Hibernate уже написано:
CDI может решить эту проблему, но не знаю - еще не исследовал полностью
.
@Inject Instance< MyClass> x;
...
x.iterator()
Также для аннотаций:
abstract class MyAnnotationQualifier
extends AnnotationLiteral<Entity> implements Entity {}
eXtcos выглядит многообещающим. Представьте, что вы хотите найти все классы, которые:
С eXtcos это так же просто, как
ClasspathScanner scanner = new ClasspathScanner();
final Set<Class> classStore = new ArraySet<Class>();
Set<Class> classes = scanner.getClasses(new ClassQuery() {
protected void query() {
select().
from("common").
andStore(thoseExtending(Component.class).into(classStore)).
returning(allAnnotatedWith(MyComponent.class));
}
});
Я реализовал его, и он работает в большинстве случаев. Поскольку он длинный, я помещал его в здесь.
Идея состоит в том, чтобы найти местоположение исходного файла класса, доступного в большинстве случаев (известным исключением являются файлы классов JVM - насколько я проверял). Если код находится в каталоге, сканируйте все файлы и только файлы класса spot. Если код находится в JAR файле, отсканируйте все записи.
Этот метод может использоваться только тогда, когда:
У вас есть класс, который находится в том же пакете, который вы хотите открыть, этот класс называется SeedClass. Например, если вы хотите перечислить все классы в "java.io", класс seed может быть java.io.File
.
Ваши классы находятся в каталоге или в JAR файле, в котором есть информация о исходном файле (не файл исходного кода, а только исходный файл). Насколько я пробовал, он работает почти на 100%, за исключением класса JVM (эти классы поставляются с JVM).
Ваша программа должна иметь разрешение на доступ к ProtectionDomain из этих классов. Если ваша программа загружается локально, проблем не должно быть.
Я тестировал программу только для моего обычного использования, поэтому у нее все еще может быть проблема.
Надеюсь, это поможет.
Вот еще один вариант, небольшая модификация другого ответа выше/ниже:
Reflections reflections = new Reflections("com.example.project.package",
new SubTypesScanner(false));
Set<Class<? extends Object>> allClasses =
reflections.getSubTypesOf(Object.class);
Назад, когда апплеты были обычным местом, у вас может быть URL-адрес в пути к классам. Когда классному загрузчику нужен класс, он будет искать все местоположения в пути к классам, включая http-ресурсы. Поскольку вы можете иметь такие вещи, как URL-адреса и каталоги в пути к классам, нет простого способа получить окончательный список классов.
Однако вы можете приблизиться. Некоторые из библиотек Spring делают это сейчас. Вы можете получить всю банку на пути к классам и открыть их, как файлы. Затем вы можете взять этот список файлов и создать структуру данных, содержащую ваши классы.
Проект ldapbeans предоставляет класс Scanner, которые делают это.
Использовать зависимость maven:
groupId: net.sf.extcos
artifactId: extcos
version: 0.4b
то используйте этот код:
ComponentScanner scanner = new ComponentScanner();
Set classes = scanner.getClasses(new ComponentQuery() {
@Override
protected void query() {
select().from("com.leyton").returning(allExtending(DynamicForm.class));
}
});
Если вы уже используете Guava, вы можете использовать ClassPath. Ознакомьтесь с документами здесь: https://google.github.io/guava/releases/17.0/api/docs/com/google/common/reflect/ClassPath.html.
Brent - причина, по которой ассоциация является одним из способов, связана с тем, что любой класс на любом компоненте вашего CLASSPATH может объявить себя в любом пакете (за исключением java/javax). Таким образом, просто нет отображения ВСЕХ классов в данном "пакете", потому что никто не знает и не может знать. Вы можете обновить файл jar завтра и удалить или добавить классы. Это похоже на попытку получить список всех людей по имени Джон/Джон/Йохан во всех странах мира - никто из нас не является всеведущим, поэтому никто из нас никогда не будет иметь правильного ответа.