Ist es möglich, alle Klassen oder Schnittstellen in einem bestimmten Paket zu finden? (Ein kurzer Blick auf zB Package
scheint es nein zu sein.)
Ist es möglich, alle Klassen oder Schnittstellen in einem bestimmten Paket zu finden? (Ein kurzer Blick auf zB Package
scheint es nein zu sein.)
Antworten:
Aufgrund der Dynamik von Klassenladern ist dies nicht möglich. Klassenlader müssen der VM nicht mitteilen, welche Klassen sie bereitstellen kann, sondern sie erhalten lediglich Anforderungen für Klassen und müssen eine Klasse zurückgeben oder eine Ausnahme auslösen.
Wenn Sie jedoch Ihre eigenen Klassenlader schreiben oder die Klassenpfade und ihre Gläser untersuchen, können Sie diese Informationen finden. Dies erfolgt jedoch über Dateisystemoperationen und nicht über Reflektion. Möglicherweise gibt es sogar Bibliotheken, die Ihnen dabei helfen können.
Wenn Klassen generiert oder remote bereitgestellt werden, können Sie diese Klassen nicht erkennen.
Die normale Methode besteht stattdessen darin, die Klassen, auf die Sie Zugriff benötigen, irgendwo in einer Datei zu registrieren oder sie in einer anderen Klasse zu referenzieren. Oder verwenden Sie einfach die Konvention, wenn es um die Benennung geht.
Nachtrag: In der Reflections Library können Sie Klassen im aktuellen Klassenpfad nachschlagen. Es kann verwendet werden, um alle Klassen in einem Paket zu erhalten:
Reflections reflections = new Reflections("my.project.prefix");
Set<Class<? extends Object>> allClasses =
reflections.getSubTypesOf(Object.class);
Sie sollten sich wahrscheinlich die Open Source Reflections-Bibliothek ansehen . Damit können Sie ganz einfach erreichen, was Sie wollen.
Richten Sie zunächst den Reflexionsindex ein (es ist etwas chaotisch, da die Suche nach allen Klassen standardmäßig deaktiviert ist):
List<ClassLoader> classLoadersList = new LinkedList<ClassLoader>();
classLoadersList.add(ClasspathHelper.contextClassLoader());
classLoadersList.add(ClasspathHelper.staticClassLoader());
Reflections reflections = new Reflections(new ConfigurationBuilder()
.setScanners(new SubTypesScanner(false /* don't exclude Object.class */), new ResourcesScanner())
.setUrls(ClasspathHelper.forClassLoader(classLoadersList.toArray(new ClassLoader[0])))
.filterInputsBy(new FilterBuilder().include(FilterBuilder.prefix("org.your.package"))));
Anschließend können Sie alle Objekte in einem bestimmten Paket abfragen:
Set<Class<?>> classes = reflections.getSubTypesOf(Object.class);
.addUrls(ClasspathHelper.forJavaClassPath())
anstelle des oben genannten hat sie für mich gelöst. Weniger Code auch!
Google Guava 14 enthält eine neue Klasse ClassPath
mit drei Methoden zum Scannen nach Klassen der obersten Ebene:
getTopLevelClasses()
getTopLevelClasses(String packageName)
getTopLevelClassesRecursive(String packageName)
Weitere Informationen finden Sie in den ClassPath
Javadocs .
ClassPath
ist mit markiert @Beta
, so ist möglicherweise keine gute Idee für einige ...
Sie können diese Methode 1 verwenden, die das verwendet ClassLoader
.
/**
* Scans all classes accessible from the context class loader which belong to the given package and subpackages.
*
* @param packageName The base package
* @return The classes
* @throws ClassNotFoundException
* @throws IOException
*/
private static Class[] getClasses(String packageName)
throws ClassNotFoundException, IOException {
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
assert classLoader != null;
String path = packageName.replace('.', '/');
Enumeration<URL> resources = classLoader.getResources(path);
List<File> dirs = new ArrayList<File>();
while (resources.hasMoreElements()) {
URL resource = resources.nextElement();
dirs.add(new File(resource.getFile()));
}
ArrayList<Class> classes = new ArrayList<Class>();
for (File directory : dirs) {
classes.addAll(findClasses(directory, packageName));
}
return classes.toArray(new Class[classes.size()]);
}
/**
* Recursive method used to find all classes in a given directory and subdirs.
*
* @param directory The base directory
* @param packageName The package name for classes found inside the base directory
* @return The classes
* @throws ClassNotFoundException
*/
private static List<Class> findClasses(File directory, String packageName) throws ClassNotFoundException {
List<Class> classes = new ArrayList<Class>();
if (!directory.exists()) {
return classes;
}
File[] files = directory.listFiles();
for (File file : files) {
if (file.isDirectory()) {
assert !file.getName().contains(".");
classes.addAll(findClasses(file, packageName + "." + file.getName()));
} else if (file.getName().endsWith(".class")) {
classes.add(Class.forName(packageName + '.' + file.getName().substring(0, file.getName().length() - 6)));
}
}
return classes;
}
__________
1 Diese Methode wurde ursprünglich von http://snippets.dzone.com/posts/show/4831 übernommen , das vom Internetarchiv archiviert wurde, wie jetzt verlinkt. Das Snippet ist auch unter https://dzone.com/articles/get-all-classes-within-package verfügbar .
%20
, aber der new File()
Konstruktor hat dies als Literal-Prozentzeichen zwei Null behandelt. Ich habe es behoben, indem ich die dirs.add(...)
Zeile wie folgt geändert habe: dirs.add(new File(resource.toURI()));
Dies bedeutete auch, dass ich URISyntaxException
die Throws-Klausel vongetClasses
Dieses Beispiel gilt für Spring 4, aber Sie können den Klassenpfad-Scanner auch in früheren Versionen finden.
// create scanner and disable default filters (that is the 'false' argument)
final ClassPathScanningCandidateComponentProvider provider = new ClassPathScanningCandidateComponentProvider(false);
// add include filters which matches all the classes (or use your own)
provider.addIncludeFilter(new RegexPatternTypeFilter(Pattern.compile(".*")));
// get matching classes defined in the package
final Set<BeanDefinition> classes = provider.findCandidateComponents("my.package.name");
// this is how you can load the class type from BeanDefinition instance
for (BeanDefinition bean: classes) {
Class<?> clazz = Class.forName(bean.getBeanClassName());
// ... do your magic with the class ...
}
Hinweis: In Version 14 ist die API weiterhin als @Beta markiert. Achten Sie daher im Produktionscode darauf.
final ClassLoader loader = Thread.currentThread().getContextClassLoader();
for (final ClassPath.ClassInfo info : ClassPath.from(loader).getTopLevelClasses()) {
if (info.getName().startsWith("my.package.")) {
final Class<?> clazz = info.load();
// do something with your clazz
}
}
ClassPath
Klasse in Guava auch gekennzeichnet mit @Beta
: "APIs, die auf Klassen- oder Methodenebene mit der Annotation @Beta gekennzeichnet sind, können sich ändern. Sie können in jeder Hauptversion auf irgendeine Weise geändert oder sogar entfernt werden. Wenn Ihr Code Ist eine Bibliothek selbst (dh sie wird auf dem CLASSPATH von Benutzern außerhalb Ihrer eigenen Kontrolle verwendet), sollten Sie keine Beta-APIs verwenden, es sei denn, Sie verpacken sie neu ... " code.google.com/p/guava-libraries/#Important_Warnings
getAllClasses()
kann die Methode verwendet werden.
Hallo. Ich hatte immer einige Probleme mit den oben genannten Lösungen (und auf anderen Websites).
Ich als Entwickler programmiere ein Addon für eine API. Die API verhindert die Verwendung externer Bibliotheken oder Tools von Drittanbietern. Das Setup besteht auch aus einer Mischung aus Code in JAR- oder ZIP-Dateien und Klassendateien, die sich direkt in einigen Verzeichnissen befinden. Mein Code musste also in der Lage sein, um jedes Setup herum zu arbeiten. Nach vielen Recherchen habe ich eine Methode gefunden, die in mindestens 95% aller möglichen Setups funktioniert.
Der folgende Code ist im Grunde die Overkill-Methode, die immer funktioniert.
Dieser Code durchsucht ein bestimmtes Paket nach allen darin enthaltenen Klassen. Es funktioniert nur für alle Klassen in der aktuellen ClassLoader
.
/**
* Private helper method
*
* @param directory
* The directory to start with
* @param pckgname
* The package name to search for. Will be needed for getting the
* Class object.
* @param classes
* if a file isn't loaded but still is in the directory
* @throws ClassNotFoundException
*/
private static void checkDirectory(File directory, String pckgname,
ArrayList<Class<?>> classes) throws ClassNotFoundException {
File tmpDirectory;
if (directory.exists() && directory.isDirectory()) {
final String[] files = directory.list();
for (final String file : files) {
if (file.endsWith(".class")) {
try {
classes.add(Class.forName(pckgname + '.'
+ file.substring(0, file.length() - 6)));
} catch (final NoClassDefFoundError e) {
// do nothing. this class hasn't been found by the
// loader, and we don't care.
}
} else if ((tmpDirectory = new File(directory, file))
.isDirectory()) {
checkDirectory(tmpDirectory, pckgname + "." + file, classes);
}
}
}
}
/**
* Private helper method.
*
* @param connection
* the connection to the jar
* @param pckgname
* the package name to search for
* @param classes
* the current ArrayList of all classes. This method will simply
* add new classes.
* @throws ClassNotFoundException
* if a file isn't loaded but still is in the jar file
* @throws IOException
* if it can't correctly read from the jar file.
*/
private static void checkJarFile(JarURLConnection connection,
String pckgname, ArrayList<Class<?>> classes)
throws ClassNotFoundException, IOException {
final JarFile jarFile = connection.getJarFile();
final Enumeration<JarEntry> entries = jarFile.entries();
String name;
for (JarEntry jarEntry = null; entries.hasMoreElements()
&& ((jarEntry = entries.nextElement()) != null);) {
name = jarEntry.getName();
if (name.contains(".class")) {
name = name.substring(0, name.length() - 6).replace('/', '.');
if (name.contains(pckgname)) {
classes.add(Class.forName(name));
}
}
}
}
/**
* Attempts to list all the classes in the specified package as determined
* by the context class loader
*
* @param pckgname
* the package name to search
* @return a list of classes that exist within that package
* @throws ClassNotFoundException
* if something went wrong
*/
public static ArrayList<Class<?>> getClassesForPackage(String pckgname)
throws ClassNotFoundException {
final ArrayList<Class<?>> classes = new ArrayList<Class<?>>();
try {
final ClassLoader cld = Thread.currentThread()
.getContextClassLoader();
if (cld == null)
throw new ClassNotFoundException("Can't get class loader.");
final Enumeration<URL> resources = cld.getResources(pckgname
.replace('.', '/'));
URLConnection connection;
for (URL url = null; resources.hasMoreElements()
&& ((url = resources.nextElement()) != null);) {
try {
connection = url.openConnection();
if (connection instanceof JarURLConnection) {
checkJarFile((JarURLConnection) connection, pckgname,
classes);
} else if (connection instanceof FileURLConnection) {
try {
checkDirectory(
new File(URLDecoder.decode(url.getPath(),
"UTF-8")), pckgname, classes);
} catch (final UnsupportedEncodingException ex) {
throw new ClassNotFoundException(
pckgname
+ " does not appear to be a valid package (Unsupported encoding)",
ex);
}
} else
throw new ClassNotFoundException(pckgname + " ("
+ url.getPath()
+ ") does not appear to be a valid package");
} catch (final IOException ioex) {
throw new ClassNotFoundException(
"IOException was thrown when trying to get all resources for "
+ pckgname, ioex);
}
}
} catch (final NullPointerException ex) {
throw new ClassNotFoundException(
pckgname
+ " does not appear to be a valid package (Null pointer exception)",
ex);
} catch (final IOException ioex) {
throw new ClassNotFoundException(
"IOException was thrown when trying to get all resources for "
+ pckgname, ioex);
}
return classes;
}
Diese drei Methoden bieten Ihnen die Möglichkeit, alle Klassen in einem bestimmten Paket zu finden.
Sie verwenden es so:
getClassesForPackage("package.your.classes.are.in");
Die Methode erhält zuerst den aktuellen Wert ClassLoader
. Es ruft dann alle Ressourcen ab, die das Paket enthalten, und iteriert diese URL
s. Es erstellt dann eine URLConnection
und bestimmt, welche Art von URl wir haben. Es kann entweder ein Verzeichnis ( FileURLConnection
) oder ein Verzeichnis in einer JAR- oder ZIP-Datei ( JarURLConnection
) sein. Je nachdem, welche Art von Verbindung wir haben, werden zwei verschiedene Methoden aufgerufen.
Lassen Sie uns zuerst sehen, was passiert, wenn es ein ist FileURLConnection
.
Zunächst wird geprüft, ob die übergebene Datei vorhanden ist und ein Verzeichnis ist. In diesem Fall wird geprüft, ob es sich um eine Klassendatei handelt. In Class
diesem Fall wird ein Objekt erstellt und in das Feld eingefügt ArrayList
. Wenn es sich nicht um eine Klassendatei handelt, sondern um ein Verzeichnis, iterieren wir einfach hinein und machen dasselbe. Alle anderen Fälle / Dateien werden ignoriert.
Wenn dies URLConnection
eine ist, wird JarURLConnection
die andere private Hilfsmethode aufgerufen. Diese Methode durchläuft alle Einträge im zip / jar-Archiv. Wenn ein Eintrag eine Klassendatei ist und sich innerhalb des Pakets befindet, wird ein Class
Objekt erstellt und im gespeichert ArrayList
.
Nachdem alle Ressourcen analysiert wurden, gibt es (die Hauptmethode) den ArrayList
Inhalt aller Klassen im angegebenen Paket zurück, über die der aktuelle ClassLoader
Bescheid weiß.
Wenn der Prozess zu irgendeinem Zeitpunkt fehlschlägt, ClassNotFoundException
wird a mit detaillierten Informationen über die genaue Ursache ausgelöst.
sun.net.www.protocol.file.FileURLConnection
, der zur Kompilierungszeit eine Warnung generiert ("Warnung: sun.net.www.protocol.file.FileURLConnection ist eine proprietäre Sun-API und wird möglicherweise in einer zukünftigen Version entfernt"). Gibt es eine Alternative zur Verwendung dieser Klasse oder kann die Warnung mithilfe von Anmerkungen unterdrückt werden?
if ( ... instanceof JarURLConnecton) { ... } else { // Asume that the Connection is valid and points to a File }
Es ist das, was ich in meinem Code getan habe, um mit JPA kommentierte Klassen zu durchsuchen
Ohne zusätzliche Bibliotheken zu verwenden:
package test;
import java.io.DataInputStream;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
public class Test {
public static void main(String[] args) throws Exception{
List<Class> classes = getClasses(Test.class.getClassLoader(),"test");
for(Class c:classes){
System.out.println("Class: "+c);
}
}
public static List<Class> getClasses(ClassLoader cl,String pack) throws Exception{
String dottedPackage = pack.replaceAll("[/]", ".");
List<Class> classes = new ArrayList<Class>();
URL upackage = cl.getResource(pack);
DataInputStream dis = new DataInputStream((InputStream) upackage.getContent());
String line = null;
while ((line = dis.readLine()) != null) {
if(line.endsWith(".class")) {
classes.add(Class.forName(dottedPackage+"."+line.substring(0,line.lastIndexOf('.'))));
}
}
return classes;
}
}
upackage
ist null
... :(
String pack = getPackage().getName();
, müssen Sie hinzufügenpack = pack.replaceAll("[.]", "/");
Im Allgemeinen erlauben Klassenlader nicht das Durchsuchen aller Klassen im Klassenpfad. Normalerweise ist der einzige verwendete Klassenladeprogramm UrlClassLoader, aus dem wir die Liste der Verzeichnisse und JAR-Dateien (siehe getURLs ) abrufen und einzeln öffnen können, um die verfügbaren Klassen aufzulisten . Dieser Ansatz, der als Klassenpfad-Scannen bezeichnet wird, ist in Scannotation and Reflections implementiert .
Reflections reflections = new Reflections("my.package");
Set<Class<? extends Object>> classes = reflections.getSubTypesOf(Object.class);
Ein anderer Ansatz besteht darin, die Java Pluggable Annotation Processing API zu verwenden, um einen Annotationsprozessor zu schreiben, der alle kommentierten Klassen zur Kompilierungszeit sammelt und die Indexdatei für die Laufzeit erstellt. Dieser Mechanismus ist in der ClassIndex- Bibliothek implementiert :
// package-info.java
@IndexSubclasses
package my.package;
// your code
Iterable<Class> classes = ClassIndex.getPackageClasses("my.package");
Beachten Sie, dass kein zusätzliches Setup erforderlich ist, da das Scannen vollständig automatisiert ist, da der Java-Compiler automatisch alle im Klassenpfad gefundenen Prozessoren erkennt.
Der robusteste Mechanismus zum Auflisten aller Klassen in einem bestimmten Paket ist derzeit ClassGraph , da er ein möglichst breites Spektrum von Klassenpfadspezifikationsmechanismen verarbeitet , einschließlich des neuen JPMS-Modulsystems. (Ich bin der Autor.)
List<String> classNames = new ArrayList<>();
try (ScanResult scanResult = new ClassGraph().whitelistPackages("my.package")
.enableClassInfo().scan()) {
classNames.addAll(scanResult.getAllClasses().getNames());
}
Hier ist, wie ich es mache. Ich scanne alle Unterordner (Unterpakete) und versuche nicht, anonyme Klassen zu laden:
/**
* Attempts to list all the classes in the specified package as determined
* by the context class loader, recursively, avoiding anonymous classes
*
* @param pckgname
* the package name to search
* @return a list of classes that exist within that package
* @throws ClassNotFoundException
* if something went wrong
*/
private static List<Class> getClassesForPackage(String pckgname) throws ClassNotFoundException {
// This will hold a list of directories matching the pckgname. There may be more than one if a package is split over multiple jars/paths
ArrayList<File> directories = new ArrayList<File>();
String packageToPath = pckgname.replace('.', '/');
try {
ClassLoader cld = Thread.currentThread().getContextClassLoader();
if (cld == null) {
throw new ClassNotFoundException("Can't get class loader.");
}
// Ask for all resources for the packageToPath
Enumeration<URL> resources = cld.getResources(packageToPath);
while (resources.hasMoreElements()) {
directories.add(new File(URLDecoder.decode(resources.nextElement().getPath(), "UTF-8")));
}
} catch (NullPointerException x) {
throw new ClassNotFoundException(pckgname + " does not appear to be a valid package (Null pointer exception)");
} catch (UnsupportedEncodingException encex) {
throw new ClassNotFoundException(pckgname + " does not appear to be a valid package (Unsupported encoding)");
} catch (IOException ioex) {
throw new ClassNotFoundException("IOException was thrown when trying to get all resources for " + pckgname);
}
ArrayList<Class> classes = new ArrayList<Class>();
// For every directoryFile identified capture all the .class files
while (!directories.isEmpty()){
File directoryFile = directories.remove(0);
if (directoryFile.exists()) {
// Get the list of the files contained in the package
File[] files = directoryFile.listFiles();
for (File file : files) {
// we are only interested in .class files
if ((file.getName().endsWith(".class")) && (!file.getName().contains("$"))) {
// removes the .class extension
int index = directoryFile.getPath().indexOf(packageToPath);
String packagePrefix = directoryFile.getPath().substring(index).replace('/', '.');;
try {
String className = packagePrefix + '.' + file.getName().substring(0, file.getName().length() - 6);
classes.add(Class.forName(className));
} catch (NoClassDefFoundError e)
{
// do nothing. this class hasn't been found by the loader, and we don't care.
}
} else if (file.isDirectory()){ // If we got to a subdirectory
directories.add(new File(file.getPath()));
}
}
} else {
throw new ClassNotFoundException(pckgname + " (" + directoryFile.getPath() + ") does not appear to be a valid package");
}
}
return classes;
}
Ich habe ein einfaches Github-Projekt zusammengestellt, das dieses Problem löst:
https://github.com/ddopson/java-class-enumerator
Es sollte sowohl für dateibasierte Klassenpfade als auch für JAR-Dateien funktionieren.
Wenn Sie nach dem Auschecken des Projekts 'make' ausführen, wird Folgendes ausgedruckt:
Cleaning...
rm -rf build/
Building...
javac -d build/classes src/pro/ddopson/ClassEnumerator.java src/test/ClassIShouldFindOne.java src/test/ClassIShouldFindTwo.java src/test/subpkg/ClassIShouldFindThree.java src/test/TestClassEnumeration.java
Making JAR Files...
jar cf build/ClassEnumerator_test.jar -C build/classes/ .
jar cf build/ClassEnumerator.jar -C build/classes/ pro
Running Filesystem Classpath Test...
java -classpath build/classes test.TestClassEnumeration
ClassDiscovery: Package: 'test' becomes Resource: 'file:/Users/Dopson/work/other/java-class-enumeration/build/classes/test'
ClassDiscovery: Reading Directory '/Users/Dopson/work/other/java-class-enumeration/build/classes/test'
ClassDiscovery: FileName 'ClassIShouldFindOne.class' => class 'test.ClassIShouldFindOne'
ClassDiscovery: FileName 'ClassIShouldFindTwo.class' => class 'test.ClassIShouldFindTwo'
ClassDiscovery: FileName 'subpkg' => class 'null'
ClassDiscovery: Reading Directory '/Users/Dopson/work/other/java-class-enumeration/build/classes/test/subpkg'
ClassDiscovery: FileName 'ClassIShouldFindThree.class' => class 'test.subpkg.ClassIShouldFindThree'
ClassDiscovery: FileName 'TestClassEnumeration.class' => class 'test.TestClassEnumeration'
Running JAR Classpath Test...
java -classpath build/ClassEnumerator_test.jar test.TestClassEnumeration
ClassDiscovery: Package: 'test' becomes Resource: 'jar:file:/Users/Dopson/work/other/java-class-enumeration/build/ClassEnumerator_test.jar!/test'
ClassDiscovery: Reading JAR file: '/Users/Dopson/work/other/java-class-enumeration/build/ClassEnumerator_test.jar'
ClassDiscovery: JarEntry 'META-INF/' => class 'null'
ClassDiscovery: JarEntry 'META-INF/MANIFEST.MF' => class 'null'
ClassDiscovery: JarEntry 'pro/' => class 'null'
ClassDiscovery: JarEntry 'pro/ddopson/' => class 'null'
ClassDiscovery: JarEntry 'pro/ddopson/ClassEnumerator.class' => class 'null'
ClassDiscovery: JarEntry 'test/' => class 'null'
ClassDiscovery: JarEntry 'test/ClassIShouldFindOne.class' => class 'test.ClassIShouldFindOne'
ClassDiscovery: JarEntry 'test/ClassIShouldFindTwo.class' => class 'test.ClassIShouldFindTwo'
ClassDiscovery: JarEntry 'test/subpkg/' => class 'null'
ClassDiscovery: JarEntry 'test/subpkg/ClassIShouldFindThree.class' => class 'test.subpkg.ClassIShouldFindThree'
ClassDiscovery: JarEntry 'test/TestClassEnumeration.class' => class 'test.TestClassEnumeration'
Tests Passed.
Siehe auch meine andere Antwort
Ja, mit wenigen APIs, die Sie können, hier ist, wie ich es gerne mache, mit diesem Problem konfrontiert, das ich im Ruhezustand verwendete und Klassen finden musste, die mit einer bestimmten Anmerkung versehen waren.
Machen Sie diese zu einer benutzerdefinierten Anmerkung, mit der Sie markieren, welche Klassen Sie abholen möchten.
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface EntityToBeScanned {
}
Dann markiere deine Klasse damit wie
@EntityToBeScanned
public MyClass{
}
Erstellen Sie diese Dienstprogrammklasse mit der folgenden Methode
public class ClassScanner {
public static Set<Class<?>> allFoundClassesAnnotatedWithEntityToBeScanned(){
Reflections reflections = new Reflections(".*");
Set<Class<?>> annotated = reflections.getTypesAnnotatedWith(EntityToBeScanned.class);
return annotated;
}
}
Rufen Sie die Methode allFoundClassesAnnotatedWithEntityToBeScanned () auf, um einen Satz gefundener Klassen abzurufen .
Sie benötigen die unten angegebenen Bibliotheken
<!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>21.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.javassist/javassist -->
<dependency>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.22.0-CR1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.reflections/reflections -->
<dependency>
<groupId>org.reflections</groupId>
<artifactId>reflections</artifactId>
<version>0.9.10</version>
</dependency>
Sie müssen jeden Klassenladeprogrammeintrag im Klassenpfad nachschlagen:
String pkg = "org/apache/commons/lang";
ClassLoader cl = ClassLoader.getSystemClassLoader();
URL[] urls = ((URLClassLoader) cl).getURLs();
for (URL url : urls) {
System.out.println(url.getFile());
File jar = new File(url.getFile());
// ....
}
Wenn der Eintrag ein Verzeichnis ist, suchen Sie einfach im rechten Unterverzeichnis nach:
if (jar.isDirectory()) {
File subdir = new File(jar, pkg);
if (!subdir.exists())
continue;
File[] files = subdir.listFiles();
for (File file : files) {
if (!file.isFile())
continue;
if (file.getName().endsWith(".class"))
System.out.println("Found class: "
+ file.getName().substring(0,
file.getName().length() - 6));
}
}
Wenn der Eintrag die Datei und die JAR-Datei ist, überprüfen Sie die ZIP-Einträge:
else {
// try to open as ZIP
try {
ZipFile zip = new ZipFile(jar);
for (Enumeration<? extends ZipEntry> entries = zip
.entries(); entries.hasMoreElements();) {
ZipEntry entry = entries.nextElement();
String name = entry.getName();
if (!name.startsWith(pkg))
continue;
name = name.substring(pkg.length() + 1);
if (name.indexOf('/') < 0 && name.endsWith(".class"))
System.out.println("Found class: "
+ name.substring(0, name.length() - 6));
}
} catch (ZipException e) {
System.out.println("Not a ZIP: " + e.getMessage());
} catch (IOException e) {
System.err.println(e.getMessage());
}
}
Sobald Sie alle Klassennamen im Paket haben, können Sie versuchen, sie mit Reflection zu laden und zu analysieren, ob es sich um Klassen oder Schnittstellen usw. handelt.
Ich habe versucht, die Reflections-Bibliothek zu verwenden, hatte jedoch einige Probleme bei der Verwendung, und es gab zu viele Jars, die ich einschließen sollte, um einfach die Klassen in einem Paket zu erhalten.
Ich werde eine Lösung veröffentlichen, die ich in dieser doppelten Frage gefunden habe: Wie erhalte ich alle Klassennamen in einem Paket?
Die Antwort wurde von sp00m geschrieben ; Ich habe einige Korrekturen hinzugefügt, damit es funktioniert:
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.Enumeration;
import java.util.LinkedList;
import java.util.List;
public final class ClassFinder {
private final static char DOT = '.';
private final static char SLASH = '/';
private final static String CLASS_SUFFIX = ".class";
private final static String BAD_PACKAGE_ERROR = "Unable to get resources from path '%s'. Are you sure the given '%s' package exists?";
public final static List<Class<?>> find(final String scannedPackage) {
final ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
final String scannedPath = scannedPackage.replace(DOT, SLASH);
final Enumeration<URL> resources;
try {
resources = classLoader.getResources(scannedPath);
} catch (IOException e) {
throw new IllegalArgumentException(String.format(BAD_PACKAGE_ERROR, scannedPath, scannedPackage), e);
}
final List<Class<?>> classes = new LinkedList<Class<?>>();
while (resources.hasMoreElements()) {
final File file = new File(resources.nextElement().getFile());
classes.addAll(find(file, scannedPackage));
}
return classes;
}
private final static List<Class<?>> find(final File file, final String scannedPackage) {
final List<Class<?>> classes = new LinkedList<Class<?>>();
if (file.isDirectory()) {
for (File nestedFile : file.listFiles()) {
classes.addAll(find(nestedFile, scannedPackage));
}
//File names with the $1, $2 holds the anonymous inner classes, we are not interested on them.
} else if (file.getName().endsWith(CLASS_SUFFIX) && !file.getName().contains("$")) {
final int beginIndex = 0;
final int endIndex = file.getName().length() - CLASS_SUFFIX.length();
final String className = file.getName().substring(beginIndex, endIndex);
try {
final String resource = scannedPackage + DOT + className;
classes.add(Class.forName(resource));
} catch (ClassNotFoundException ignore) {
}
}
return classes;
}
}
Um es zu verwenden, rufen Sie einfach die in diesem Beispiel erwähnte find-Methode als sp00n auf: Ich habe bei Bedarf die Erstellung von Instanzen der Klassen hinzugefügt.
List<Class<?>> classes = ClassFinder.find("com.package");
ExcelReporting excelReporting;
for (Class<?> aClass : classes) {
Constructor constructor = aClass.getConstructor();
//Create an object of the class type
constructor.newInstance();
//...
}
Ich habe gerade eine util-Klasse geschrieben, die Testmethoden enthält. Sie können eine Überprüfung durchführen lassen ~
IteratePackageUtil.java:
package eric.j2se.reflect;
import java.util.Set;
import org.reflections.Reflections;
import org.reflections.scanners.ResourcesScanner;
import org.reflections.scanners.SubTypesScanner;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import org.reflections.util.FilterBuilder;
/**
* an util to iterate class in a package,
*
* @author eric
* @date Dec 10, 2013 12:36:46 AM
*/
public class IteratePackageUtil {
/**
* <p>
* Get set of all class in a specified package recursively. this only support lib
* </p>
* <p>
* class of sub package will be included, inner class will be included,
* </p>
* <p>
* could load class that use the same classloader of current class, can't load system packages,
* </p>
*
* @param pkg
* path of a package
* @return
*/
public static Set<Class<? extends Object>> getClazzSet(String pkg) {
// prepare reflection, include direct subclass of Object.class
Reflections reflections = new Reflections(new ConfigurationBuilder().setScanners(new SubTypesScanner(false), new ResourcesScanner())
.setUrls(ClasspathHelper.forClassLoader(ClasspathHelper.classLoaders(new ClassLoader[0])))
.filterInputsBy(new FilterBuilder().includePackage(pkg)));
return reflections.getSubTypesOf(Object.class);
}
public static void test() {
String pkg = "org.apache.tomcat.util";
Set<Class<? extends Object>> clazzSet = getClazzSet(pkg);
for (Class<? extends Object> clazz : clazzSet) {
System.out.println(clazz.getName());
}
}
public static void main(String[] args) {
test();
}
}
Die Lösung von Aleksander Blomskøld hat bei parametrisierten Tests @RunWith(Parameterized.class)
mit Maven bei mir nicht funktioniert . Die Tests wurden korrekt benannt und auch dort gefunden, aber nicht ausgeführt:
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running some.properly.named.test.run.with.maven.SomeTest
Tests run: 0, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.123 sec
Ein ähnliches Problem wurde berichtet hier .
In meinem Fall @Parameters
Instanzen jeder Klasse in einem Paket erstellt. Die Tests haben gut funktioniert, wenn sie lokal in der IDE ausgeführt wurden. Beim Ausführen von Maven wurden jedoch keine Klassen mit Aleksander Blomskølds Lösung gefunden.
Ich habe es mit dem folgenden Ausschnitt zum Laufen gebracht, der von David Pärssons Kommentar zu Aleksander Blomskølds Antwort inspiriert wurde:
Reflections reflections = new Reflections(new ConfigurationBuilder()
.setScanners(new SubTypesScanner(false /* don't exclude Object.class */), new ResourcesScanner())
.addUrls(ClasspathHelper.forJavaClassPath())
.filterInputsBy(new FilterBuilder()
.include(FilterBuilder.prefix(basePackage))));
Set<Class<?>> subTypesOf = reflections.getSubTypesOf(Object.class);
Was ist damit:
public static List<Class<?>> getClassesForPackage(final String pkgName) throws IOException, URISyntaxException {
final String pkgPath = pkgName.replace('.', '/');
final URI pkg = Objects.requireNonNull(ClassLoader.getSystemClassLoader().getResource(pkgPath)).toURI();
final ArrayList<Class<?>> allClasses = new ArrayList<Class<?>>();
Path root;
if (pkg.toString().startsWith("jar:")) {
try {
root = FileSystems.getFileSystem(pkg).getPath(pkgPath);
} catch (final FileSystemNotFoundException e) {
root = FileSystems.newFileSystem(pkg, Collections.emptyMap()).getPath(pkgPath);
}
} else {
root = Paths.get(pkg);
}
final String extension = ".class";
try (final Stream<Path> allPaths = Files.walk(root)) {
allPaths.filter(Files::isRegularFile).forEach(file -> {
try {
final String path = file.toString().replace('/', '.');
final String name = path.substring(path.indexOf(pkgName), path.length() - extension.length());
allClasses.add(Class.forName(name));
} catch (final ClassNotFoundException | StringIndexOutOfBoundsException ignored) {
}
});
}
return allClasses;
}
Sie können dann die Funktion überladen:
public static List<Class<?>> getClassesForPackage(final Package pkg) throws IOException, URISyntaxException {
return getClassesForPackage(pkg.getName());
}
Wenn Sie es testen müssen:
public static void main(final String[] argv) throws IOException, URISyntaxException {
for (final Class<?> cls : getClassesForPackage("my.package")) {
System.out.println(cls);
}
for (final Class<?> cls : getClassesForPackage(MyClass.class.getPackage())) {
System.out.println(cls);
}
}
Wenn Ihre IDE keinen Import-Helfer hat:
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.FileSystemNotFoundException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.stream.Stream;
Es klappt:
von Ihrer IDE
für eine JAR-Datei
ohne externe Abhängigkeiten
Fast alle Antworten verwenden Reflections
oder lesen Klassendateien aus dem Dateisystem. Wenn Sie versuchen, Klassen aus dem Dateisystem zu lesen, können Fehler auftreten, wenn Sie Ihre Anwendung als JAR oder eine andere verpacken. Möglicherweise möchten Sie zu diesem Zweck auch keine separate Bibliothek verwenden.
Hier ist ein anderer Ansatz, der reines Java ist und nicht vom Dateisystem abhängt.
import javax.tools.JavaFileObject;
import javax.tools.StandardJavaFileManager;
import javax.tools.StandardLocation;
import javax.tools.ToolProvider;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;
public class PackageUtil {
public static Collection<Class> getClasses(final String pack) throws Exception {
final StandardJavaFileManager fileManager = ToolProvider.getSystemJavaCompiler().getStandardFileManager(null, null, null);
return StreamSupport.stream(fileManager.list(StandardLocation.CLASS_PATH, pack, Collections.singleton(JavaFileObject.Kind.CLASS), false).spliterator(), false)
.map(javaFileObject -> {
try {
final String[] split = javaFileObject.getName()
.replace(".class", "")
.replace(")", "")
.split(Pattern.quote(File.separator));
final String fullClassName = pack + "." + split[split.length - 1];
return Class.forName(fullClassName);
} catch (ClassNotFoundException e) {
throw new RuntimeException(e);
}
})
.collect(Collectors.toCollection(ArrayList::new));
}
}
Java 8 ist kein Muss . Sie können for-Schleifen anstelle von Streams verwenden. Und Sie können es so testen
public static void main(String[] args) throws Exception {
final String pack = "java.nio.file"; // Or any other package
PackageUtil.getClasses(pack).stream().forEach(System.out::println);
}
ToolProvider.getSystemJavaCompiler()
werden. Dieser Code scannt keine verschachtelten Pakete.
Vorausgesetzt, Sie verwenden keine dynamischen Klassenlader, können Sie den Klassenpfad durchsuchen und für jeden Eintrag das Verzeichnis oder die JAR-Datei durchsuchen.
Erwähnenswert
Wenn Sie eine Liste aller Klassen unter einem Paket haben möchten, können Sie Reflection
folgendermaßen vorgehen:
List<Class> myTypes = new ArrayList<>();
Reflections reflections = new Reflections("com.package");
for (String s : reflections.getStore().get(SubTypesScanner.class).values()) {
myTypes.add(Class.forName(s));
}
Dadurch wird eine Liste von Klassen erstellt, die Sie später nach Belieben verwenden können.
Es ist sehr gut möglich, aber ohne zusätzliche Bibliotheken Reflections
ist es schwierig ...
Es ist schwierig, weil Sie nicht das vollständige Instrument haben, um den Klassennamen zu erhalten.
Und ich nehme den Code meiner ClassFinder
Klasse:
package play.util;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
/**
* Created by LINKOR on 26.05.2017 in 15:12.
* Date: 2017.05.26
*/
public class FileClassFinder {
private JarFile file;
private boolean trouble;
public FileClassFinder(String filePath) {
try {
file = new JarFile(filePath);
} catch (IOException e) {
trouble = true;
}
}
public List<String> findClasses(String pkg) {
ArrayList<String> classes = new ArrayList<>();
Enumeration<JarEntry> entries = file.entries();
while (entries.hasMoreElements()) {
JarEntry cls = entries.nextElement();
if (!cls.isDirectory()) {
String fileName = cls.getName();
String className = fileName.replaceAll("/", ".").replaceAll(File.pathSeparator, ".").substring(0, fileName.lastIndexOf('.'));
if (className.startsWith(pkg)) classes.add(className.substring(pkg.length() + 1));
}
}
return classes;
}
}
Basierend auf der Antwort von @ Staale und in dem Versuch, mich nicht auf Bibliotheken von Drittanbietern zu verlassen, würde ich den Dateisystemansatz implementieren, indem ich den physischen Speicherort des ersten Pakets mit folgenden Informationen untersuche :
import java.io.File;
import java.io.FileFilter;
import java.util.ArrayList;
...
Class<?>[] foundClasses = new Class<?>[0];
final ArrayList<Class<?>> foundClassesDyn = new ArrayList<Class<?>>();
new java.io.File(
klass.getResource(
"/" + curPackage.replace( "." , "/")
).getFile()
).listFiles(
new java.io.FileFilter() {
public boolean accept(java.io.File file) {
final String classExtension = ".class";
if ( file.isFile()
&& file.getName().endsWith(classExtension)
// avoid inner classes
&& ! file.getName().contains("$") )
{
try {
String className = file.getName();
className = className.substring(0, className.length() - classExtension.length());
foundClassesDyn.add( Class.forName( curPackage + "." + className ) );
} catch (ClassNotFoundException e) {
e.printStackTrace(System.out);
}
}
return false;
}
}
);
foundClasses = foundClassesDyn.toArray(foundClasses);
Wenn Sie lediglich eine Gruppe verwandter Klassen laden möchten, kann Spring Ihnen helfen.
Spring kann eine Liste oder Karte aller Klassen instanziieren, die eine bestimmte Schnittstelle in einer Codezeile implementieren. Die Liste oder Zuordnung enthält Instanzen aller Klassen, die diese Schnittstelle implementieren.
Als Alternative zum Laden der Liste der Klassen aus dem Dateisystem implementieren Sie stattdessen einfach dieselbe Schnittstelle in allen Klassen, die Sie laden möchten, unabhängig vom Paket, und verwenden Sie Spring, um Ihnen Instanzen aller Klassen bereitzustellen. Auf diese Weise können Sie alle gewünschten Klassen laden (und instanziieren), unabhängig davon, in welchem Paket sie sich befinden.
Wenn Sie jedoch alle in einem Paket haben möchten, lassen Sie einfach alle Klassen in diesem Paket eine bestimmte Schnittstelle implementieren.
einfaches Java: FindAllClassesUsingPlainJavaReflectionTest.java
@Slf4j
class FindAllClassesUsingPlainJavaReflectionTest {
private static final Function<Throwable, RuntimeException> asRuntimeException = throwable -> {
log.error(throwable.getLocalizedMessage());
return new RuntimeException(throwable);
};
private static final Function<String, Collection<Class<?>>> findAllPackageClasses = basePackageName -> {
Locale locale = Locale.getDefault();
Charset charset = StandardCharsets.UTF_8;
val fileManager = ToolProvider.getSystemJavaCompiler()
.getStandardFileManager(/* diagnosticListener */ null, locale, charset);
StandardLocation location = StandardLocation.CLASS_PATH;
JavaFileObject.Kind kind = JavaFileObject.Kind.CLASS;
Set<JavaFileObject.Kind> kinds = Collections.singleton(kind);
val javaFileObjects = Try.of(() -> fileManager.list(location, basePackageName, kinds, /* recurse */ true))
.getOrElseThrow(asRuntimeException);
String pathToPackageAndClass = basePackageName.replace(".", File.separator);
Function<String, String> mapToClassName = s -> {
String prefix = Arrays.stream(s.split(pathToPackageAndClass))
.findFirst()
.orElse("");
return s.replaceFirst(prefix, "")
.replaceAll(File.separator, ".");
};
return StreamSupport.stream(javaFileObjects.spliterator(), /* parallel */ true)
.filter(javaFileObject -> javaFileObject.getKind().equals(kind))
.map(FileObject::getName)
.map(fileObjectName -> fileObjectName.replace(".class", ""))
.map(mapToClassName)
.map(className -> Try.of(() -> Class.forName(className))
.getOrElseThrow(asRuntimeException))
.collect(Collectors.toList());
};
@Test
@DisplayName("should get classes recursively in given package")
void test() {
Collection<Class<?>> classes = findAllPackageClasses.apply(getClass().getPackage().getName());
assertThat(classes).hasSizeGreaterThan(4);
classes.stream().map(String::valueOf).forEach(log::info);
}
}
PS: Um Boilerplates für die Behandlung von Fehlern usw. zu vereinfachen, verwende ich hier vavr
und lombok
Bibliotheken
Andere Implementierungen finden Sie in meinem GitHub-Dolch für Dolchok / Java-Reflection-Find-Annotated-Classes-or-Methods
Ich konnte keine kurze Arbeit für etwas so Einfaches finden. Also hier ist es, ich habe es selbst gemacht, nachdem ich eine Weile herumgeschraubt habe:
Reflections reflections =
new Reflections(new ConfigurationBuilder()
.filterInputsBy(new FilterBuilder().includePackage(packagePath))
.setUrls(ClasspathHelper.forPackage(packagePath))
.setScanners(new SubTypesScanner(false)));
Set<String> typeList = reflections.getAllTypes();
Wenn Sie im Frühlingsland sind, können Sie verwenden PathMatchingResourcePatternResolver
;
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
Resource[] resources = resolver.getResources("classpath*:some/package/name/*.class");
Arrays.asList(resources).forEach(r->{
...
});