Witaj. Zawsze miałem problemy z powyższymi rozwiązaniami (i na innych stronach).
Jako programista programuję dodatek do interfejsu API. Interfejs API uniemożliwia korzystanie z zewnętrznych bibliotek lub narzędzi innych firm. Konfiguracja składa się również z mieszanki kodu w plikach jar lub zip oraz plików klas znajdujących się bezpośrednio w niektórych katalogach. Tak więc mój kod musiał być w stanie działać w każdej konfiguracji. Po wielu badaniach wymyśliłem metodę, która będzie działać w co najmniej 95% wszystkich możliwych konfiguracji.
Poniższy kod jest w zasadzie metodą nadmiaru, która zawsze będzie działać.
Kod:
Ten kod skanuje dany pakiet pod kątem wszystkich klas, które są w nim zawarte. Będzie działać tylko dla wszystkich klas w bieżącym 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;
}
Te trzy metody umożliwiają znalezienie wszystkich klas w danym pakiecie.
Używasz go w ten sposób:
getClassesForPackage("package.your.classes.are.in");
Wyjaśnienie:
Metoda najpierw pobiera prąd ClassLoader. Następnie pobiera wszystkie zasoby zawierające wspomniany pakiet i iteruje je URL. Następnie tworzy a URLConnectioni określa, jaki typ UR1 mamy. Może to być katalog ( FileURLConnection) lub katalog w pliku jar lub zip ( JarURLConnection). W zależności od rodzaju połączenia będziemy wywoływać dwie różne metody.
Najpierw zobaczmy, co się stanie, jeśli jest to FileURLConnection.
Najpierw sprawdza, czy przekazany plik istnieje i jest katalogiem. W takim przypadku sprawdza, czy jest to plik klasy. Jeśli tak, Classobiekt zostanie utworzony i umieszczony w ArrayList. Jeśli nie jest to plik klasy, ale katalog, po prostu iterujemy w nim i robimy to samo. Wszystkie pozostałe przypadki / pliki zostaną zignorowane.
Jeśli URLConnectionjest to JarURLConnectioninna metoda prywatnej pomocy zostanie wywołana. Ta metoda iteruje wszystkie wpisy w archiwum zip / jar. Jeśli jeden wpis jest plikiem klasy i znajduje się w pakiecie, Classobiekt zostanie utworzony i zapisany w pliku ArrayList.
Po przeanalizowaniu wszystkich zasobów (metoda główna) zwraca ArrayListzawartość wszystkich klas w danym pakiecie, o której aktualnie ClassLoaderwie.
Jeśli proces zakończy się niepowodzeniem w dowolnym momencie, ClassNotFoundExceptionzostanie wyświetlony komunikat zawierający szczegółowe informacje na temat dokładnej przyczyny.