क्या किसी दिए गए पैकेज में सभी वर्गों या इंटरफेस को ढूंढना संभव है? (जल्दी से उदाहरण के लिए Package
, यह नहीं की तरह लग रहे हो जाएगा।)
क्या किसी दिए गए पैकेज में सभी वर्गों या इंटरफेस को ढूंढना संभव है? (जल्दी से उदाहरण के लिए Package
, यह नहीं की तरह लग रहे हो जाएगा।)
जवाबों:
क्लास लोडर की गतिशील प्रकृति के कारण, यह संभव नहीं है। वीएम को यह बताने के लिए क्लास लोडर की आवश्यकता नहीं है कि वे कौन सी कक्षाएं प्रदान कर सकते हैं, इसके बजाय उन्हें कक्षाओं के लिए अनुरोध सौंप दिया जाता है, और एक क्लास वापस करना पड़ता है या एक अपवाद फेंकना पड़ता है।
हालांकि, यदि आप अपने स्वयं के क्लास लोडर लिखते हैं, या क्लासपैथ की जांच करते हैं और यह जार है, तो यह जानकारी प्राप्त करना संभव है। यह फाइलसिस्टम संचालन के माध्यम से होगा, हालांकि प्रतिबिंब नहीं। यहां तक कि पुस्तकालय भी हो सकते हैं जो आपको ऐसा करने में मदद कर सकते हैं।
यदि ऐसी कक्षाएं हैं जो दूर से उत्पन्न होती हैं, या दूरस्थ रूप से वितरित की जाती हैं, तो आप उन कक्षाओं की खोज नहीं कर पाएंगे।
सामान्य विधि इसके बजाय उन वर्गों को पंजीकृत करने के लिए है जिन्हें आपको किसी फ़ाइल में पहुंच की आवश्यकता है, या उन्हें एक अलग वर्ग में संदर्भ दें। या जब नामकरण की बात आती है तो सिर्फ सम्मेलन का उपयोग करें।
परिशिष्ट: परावर्तन पुस्तकालय आपको वर्तमान वर्गपथ में कक्षाएं देखने की अनुमति देगा। इसका उपयोग पैकेज में सभी वर्गों को प्राप्त करने के लिए किया जा सकता है:
Reflections reflections = new Reflections("my.project.prefix");
Set<Class<? extends Object>> allClasses =
reflections.getSubTypesOf(Object.class);
आपको शायद ओपन सोर्स रिफ्लेक्शंस लाइब्रेरी पर एक नज़र डालनी चाहिए । इसके साथ आप आसानी से वह हासिल कर सकते हैं जो आप चाहते हैं।
सबसे पहले, रिफ्लेक्शन इंडेक्स सेट करें (यह डिफ़ॉल्ट रूप से अक्षम है क्योंकि सभी वर्गों के लिए खोज करना है):
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"))));
फिर आप दिए गए पैकेज में सभी वस्तुओं के लिए क्वेरी कर सकते हैं:
Set<Class<?>> classes = reflections.getSubTypesOf(Object.class);
.addUrls(ClasspathHelper.forJavaClassPath())
ऊपर के बजाय का उपयोग करके उन्हें मेरे लिए हल किया। साथ ही कम कोड!
Google अमरूद 14 में ClassPath
शीर्ष स्तर की कक्षाओं को स्कैन करने के लिए तीन तरीकों के साथ एक नया वर्ग शामिल है :
getTopLevelClasses()
getTopLevelClasses(String packageName)
getTopLevelClassesRecursive(String packageName)
अधिक जानकारी के लिए ClassPath
javadocs देखें ।
ClassPath
साथ टैग किया गया है @Beta
, तो कुछ के लिए एक अच्छा विचार नहीं हो सकता है ...
आप इस विधि 1 का उपयोग कर सकते हैं जो इसका उपयोग करता है 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 यह विधि मूल रूप से http://snippets.dzone.com/posts/show/4831 से ली गई थी , जिसे इंटरनेट आर्काइव द्वारा संग्रहीत किया गया था, जो अब से जुड़ा हुआ है। स्निपेट https://dzone.com/articles/get-all-classes-within-package पर भी उपलब्ध है ।
%20
, लेकिन new File()
कंस्ट्रक्टर ने माना कि शाब्दिक प्रतिशत दो शून्य पर हस्ताक्षर करता है। मैंने इसे dirs.add(...)
लाइन में बदलकर इसे ठीक किया : dirs.add(new File(resource.toURI()));
इसका मतलब यह भी था कि मुझे URISyntaxException
थ्रो क्लॉज में जोड़ना थाgetClasses
यह उदाहरण स्प्रिंग 4 के लिए है, लेकिन आप क्लासपैथ स्कैनर को पहले के संस्करणों में भी पा सकते हैं।
// 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 ...
}
नोट: 14 संस्करण में, एपीआई अभी भी @Beta के रूप में चिह्नित है , इसलिए उत्पादन कोड में सावधान रहें।
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
अमरूद में वर्ग को भी चिह्नित किया गया है @Beta
: "वर्ग या विधि स्तर पर @Beta एनोटेशन के साथ चिह्नित एपीआई परिवर्तन के अधीन हैं। उन्हें किसी भी तरह से संशोधित किया जा सकता है, या यहां तक कि किसी भी बड़ी रिलीज में हटा दिया जा सकता है। यदि आपका कोड है। एक पुस्तकालय ही है (यानी यह आपके नियंत्रण से बाहर के उपयोगकर्ताओं के CLASSPATH पर उपयोग किया जाता है), आपको बीटा APIs का उपयोग नहीं करना चाहिए, जब तक कि आप उन्हें पुनर्प्राप्त नहीं करते ... " code.google.com/p/guava-lbooks/#Important-Warnings
getAllClasses()
विधि का उपयोग किया जा सकता है।
हैलो। मुझे हमेशा ऊपर (और अन्य साइटों पर) समाधान के साथ कुछ मुद्दे थे।
मैं, एक डेवलपर के रूप में, एक एपीआई के लिए एक ऐडऑन प्रोग्रामिंग कर रहा हूं। एपीआई किसी भी बाहरी पुस्तकालयों या 3 पार्टी उपकरणों के उपयोग को रोकता है। सेटअप में जार या ज़िप फ़ाइलों और सीधे कुछ निर्देशिकाओं में स्थित क्लास फ़ाइलों में कोड का मिश्रण भी होता है। इसलिए मेरे कोड को हर सेटअप के आसपास काम करने में सक्षम होना था। काफी शोध के बाद मैं एक ऐसा तरीका लेकर आया हूं जो कम से कम 95% सभी संभव सेटअपों में काम करेगा।
निम्नलिखित कोड मूल रूप से ओवरकिल विधि है जो हमेशा काम करेगी।
यह कोड उन सभी वर्गों के लिए दिए गए पैकेज को स्कैन करता है जो इसमें शामिल हैं। यह केवल वर्तमान में सभी वर्गों के लिए काम करेगा 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;
}
ये तीन विधियाँ आपको दिए गए पैकेज में सभी वर्गों को खोजने की क्षमता प्रदान करती हैं।
आप इसे इस तरह उपयोग करते हैं:
getClassesForPackage("package.your.classes.are.in");
विधि को पहले करंट मिलता है ClassLoader
। इसके बाद उन सभी संसाधनों को लाया जाता है, जिनमें इन पैकेजों के बारे में बताया गया है URL
। यह तब एक बनाता है URLConnection
और निर्धारित करता है कि हमारे पास किस प्रकार का यूआरएल है। यह या तो एक निर्देशिका ( FileURLConnection
) या जार या ज़िप फ़ाइल के अंदर एक निर्देशिका हो सकती है ( JarURLConnection
)। इस पर निर्भर करता है कि हमारे पास किस प्रकार के दो अलग-अलग तरीके हैं।
पहले देखते हैं कि क्या होता है यदि यह ए FileURLConnection
।
यह पहले चेक करता है कि पास की गई फाइल मौजूद है और डायरेक्टरी है। यदि यह मामला है तो यह जाँचता है कि क्या यह एक वर्ग फ़ाइल है। यदि ऐसा है तो एक Class
ऑब्जेक्ट बनाया जाएगा और अंदर डाला जाएगाArrayList
। यदि यह एक वर्ग फ़ाइल नहीं है, लेकिन एक निर्देशिका है, तो हम बस इसमें पुनरावृत्ति करते हैं और एक ही काम करते हैं। अन्य सभी मामलों / फाइलों को नजरअंदाज कर दिया जाएगा।
तो URLConnection
एक है JarURLConnection
अन्य निजी सहायक विधि बुलाया जाएगा। यह तरीका जिप / जार आर्काइव में सभी एंट्रीज पर निर्भर करता है। यदि एक प्रविष्टि एक क्लास फ़ाइल है और पैकेज के अंदर है तो एक Class
ऑब्जेक्ट बनाया जाएगा और उसमें स्टोर किया जाएगा ArrayList
।
सभी संसाधनों को पार्स कर दिए जाने के बाद (मुख्य विधि) ArrayList
दिए गए पैकेज में सभी वर्गों को वापस लौटाता है , जिसके ClassLoader
बारे में वर्तमान जानता है।
यदि प्रक्रिया किसी भी बिंदु पर विफल हो जाती है, ClassNotFoundException
तो सटीक कारण के बारे में विस्तृत जानकारी को फेंक दिया जाएगा।
sun.net.www.protocol.file.FileURLConnection
, जो संकलन-समय पर एक चेतावनी उत्पन्न करता है ("चेतावनी: sun.net.www.protocol.file.FileURLConnection Sun मालिकाना API है और भविष्य में रिलीज़ में हटाया जा सकता है")। क्या उस वर्ग का उपयोग करने का कोई विकल्प है, या एनोटेशन का उपयोग करके चेतावनी को दबाया जा सकता है?
if ( ... instanceof JarURLConnecton) { ... } else { // Asume that the Connection is valid and points to a File }
यह वही है जो मैंने JPA एनोटेट कक्षाओं को खोजने के लिए अपने कोड पर किया था
किसी भी अतिरिक्त पुस्तकालयों का उपयोग किए बिना:
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
तो null
...:
String pack = getPackage().getName();
, तो आपको जोड़ना होगाpack = pack.replaceAll("[.]", "/");
सामान्य वर्ग में लोडर क्लासपाथ पर सभी वर्गों के माध्यम से स्कैनिंग की अनुमति नहीं देते हैं। लेकिन आमतौर पर केवल इस्तेमाल किया जाने वाला क्लास लोडर UrlClassLoader होता है जिससे हम डायरेक्टरी और जार फाइल्स ( getURLs देखें ) की सूची को पुनः प्राप्त कर सकते हैं और उपलब्ध कक्षाओं को सूचीबद्ध करने के लिए उन्हें एक-एक करके खोल सकते हैं। क्लास पथ स्कैनिंग नामक इस दृष्टिकोण को स्कैनोटेशन और रिफ्लेक्शंस में लागू किया जाता है ।
Reflections reflections = new Reflections("my.package");
Set<Class<? extends Object>> classes = reflections.getSubTypesOf(Object.class);
एक अन्य दृष्टिकोण एनोटेशन प्रोसेसर लिखने के लिए जावा प्लगएबल एनोटेशन प्रोसेसिंग एपीआई का उपयोग करना है जो संकलन समय पर सभी एनोटेट कक्षाओं को इकट्ठा करेगा और रनटाइम उपयोग के लिए इंडेक्स फाइल का निर्माण करेगा। यह तंत्र ClassIndex लाइब्रेरी में लागू किया गया है:
// package-info.java
@IndexSubclasses
package my.package;
// your code
Iterable<Class> classes = ClassIndex.getPackageClasses("my.package");
ध्यान दें कि कोई अतिरिक्त सेटअप की आवश्यकता नहीं है क्योंकि स्कैनिंग पूरी तरह से स्वचालित है जावा कम्पाइलर के लिए धन्यवाद स्वचालित रूप से क्लासपैथ पर पाए गए किसी भी प्रोसेसर की खोज करता है।
किसी दिए गए पैकेज में सभी वर्गों को सूचीबद्ध करने के लिए सबसे मजबूत तंत्र वर्तमान में क्लासग्राफ है , क्योंकि यह नए जेपीएमएस मॉड्यूल सिस्टम सहित क्लासपैथ विनिर्देशन तंत्र के व्यापक संभव सरणी को संभालता है। (मैं लेखक हूं)
List<String> classNames = new ArrayList<>();
try (ScanResult scanResult = new ClassGraph().whitelistPackages("my.package")
.enableClassInfo().scan()) {
classNames.addAll(scanResult.getAllClasses().getNames());
}
यहाँ है कि मैं यह कैसे करते हैं। मैं सभी सबफ़ोल्डर्स (उप-पैकेज) को स्कैन करता हूं और अनाम कक्षाओं को लोड करने का प्रयास नहीं करता:
/**
* 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;
}
मैंने एक साधारण गितुब परियोजना लगाई जो इस समस्या को हल करती है:
https://github.com/ddopson/java-class-enumerator
यह बीओटीएच फ़ाइल-आधारित क्लासपैथ और जार फ़ाइलों के लिए काम करना चाहिए।
यदि आप परियोजना की जाँच करने के बाद 'मेक' चलाते हैं तो इसे प्रिंट किया जाएगा:
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.
मेरा दूसरा जवाब भी देखिए
हाँ कुछ एपीआई का उपयोग करके, यहाँ है कि मैं इसे कैसे करना पसंद करता हूं, इस समस्या का सामना करना पड़ा जो मैं हाइबरनेट कोर का उपयोग कर रहा था और उन कक्षाओं को ढूंढना था जहां एक निश्चित एनोटेशन के साथ एनोटेट किया गया था।
इन्हें एक कस्टम एनोटेशन बनाएं, जिसके उपयोग से आप यह चिन्हित करेंगे कि आप कौन सी कक्षाएं लेना चाहते हैं।
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 {
}
फिर अपनी कक्षा को इसके साथ चिह्नित करें
@EntityToBeScanned
public MyClass{
}
इस उपयोगिता वर्ग को बनाएं जिसमें निम्न विधि हो
public class ClassScanner {
public static Set<Class<?>> allFoundClassesAnnotatedWithEntityToBeScanned(){
Reflections reflections = new Reflections(".*");
Set<Class<?>> annotated = reflections.getTypesAnnotatedWith(EntityToBeScanned.class);
return annotated;
}
}
क्लासेस का एक सेट प्राप्त करने के लिए allFoundClassesAnnotatedWithEntityToBeScanned () विधि को कॉल करें ।
आपको नीचे दिए गए परिवादों की आवश्यकता होगी
<!-- 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>
आपको कक्षा पथ में प्रत्येक श्रेणी लोडर प्रविष्टि देखने की आवश्यकता है:
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());
// ....
}
यदि प्रविष्टि निर्देशिका है, तो बस सही उपनिर्देशिका में देखें:
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));
}
}
यदि प्रविष्टि फ़ाइल है, और यह जार है, तो इसके ज़िप प्रविष्टियों का निरीक्षण करें:
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());
}
}
अब एक बार जब आपके पास पैकेज के साथ सभी वर्ग के नाम हैं, तो आप उन्हें प्रतिबिंब के साथ लोड करने का प्रयास कर सकते हैं और विश्लेषण कर सकते हैं कि क्या वे कक्षाएं या इंटरफेस हैं, आदि।
मैं रिफ्लेक्शंस लाइब्रेरी का उपयोग करने की कोशिश कर रहा हूं, लेकिन इसका उपयोग करने में कुछ समस्याएं थीं, और बहुत सारे जार थे जिन्हें मुझे सिर्फ एक पैकेज पर कक्षाएं प्राप्त करने के लिए शामिल करना चाहिए।
मैं इस डुप्लिकेट प्रश्न में पाया गया एक समाधान पोस्ट करूँगा: पैकेज में सभी वर्गों के नाम कैसे प्राप्त करें?
जवाब sp00m द्वारा लिखा गया था ; मैंने इसे काम करने के लिए कुछ सुधार जोड़े हैं:
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;
}
}
इसका उपयोग करने के लिए बस खोज विधि को इस उदाहरण में उल्लिखित sp00n के रूप में कहें: मैंने ज़रूरत पड़ने पर कक्षाओं के उदाहरणों का निर्माण किया है।
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();
//...
}
मैंने सिर्फ एक उपयोग वर्ग लिखा है, इसमें परीक्षण विधियां शामिल हैं, आप एक जांच कर सकते हैं ~
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();
}
}
@RunWith(Parameterized.class)
मावेन का उपयोग करते समय पैरामीटर परीक्षण के लिए अलेक्जेंडर ब्लोम्स्कोल्ड का समाधान मेरे लिए काम नहीं करता था । परीक्षणों को सही ढंग से नामित किया गया था और यह भी पाया गया था लेकिन निष्पादित नहीं किया गया:
-------------------------------------------------------
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
इसी तरह का एक मुद्दा यहाँ बताया गया है ।
मेरे मामले में @Parameters
में एक पैकेज में प्रत्येक वर्ग के उदाहरण बना रहा है। आईडीई में स्थानीय स्तर पर चलने पर परीक्षणों ने अच्छा काम किया। हालांकि, जब मावेन को कोई कक्षाएं नहीं चल रही थीं, जहां अलेक्जेंडर ब्लोम्स्कोल्ड के समाधान के साथ मिला।
मैंने इसे निम्नलिखित स्निप के साथ काम किया, जो अलेक्जेंडर ब्लोम्स्कोल्ड के उत्तर पर डेविड पियर्सन की टिप्पणी से प्रेरित था:
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);
इस बारे में क्या:
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;
}
फिर आप फ़ंक्शन को ओवरलोड कर सकते हैं:
public static List<Class<?>> getClassesForPackage(final Package pkg) throws IOException, URISyntaxException {
return getClassesForPackage(pkg.getName());
}
यदि आपको इसका परीक्षण करने की आवश्यकता है:
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);
}
}
यदि आपके आईडीई में आयात सहायक नहीं है:
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;
यह काम करता हैं:
अपनी आईडीई से
एक JAR फ़ाइल के लिए
बाहरी निर्भरता के बिना
लगभग सभी उत्तर या तो उपयोग करता है Reflections
फ़ाइल सिस्टम से क्लास फ़ाइलों या पढ़ता है। यदि आप फ़ाइल सिस्टम से कक्षाएं पढ़ने की कोशिश करते हैं, तो आपको अपने एप्लिकेशन को JAR या अन्य के रूप में पैकेज करते समय त्रुटियाँ हो सकती हैं। इसके अलावा, आप उस उद्देश्य के लिए एक अलग पुस्तकालय का उपयोग नहीं करना चाह सकते हैं।
यहां एक और दृष्टिकोण है जो शुद्ध जावा है और फाइल सिस्टम पर निर्भर नहीं करता है।
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));
}
}
जावा 8 एक नहीं है । आप धाराओं के बजाय छोरों के लिए उपयोग कर सकते हैं। और आप इसे इस तरह से टेस्ट कर सकते हैं
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);
}
बशर्ते आप किसी भी डायनेमिक क्लास लोडर का उपयोग नहीं कर रहे हों, आप क्लासपैथ की खोज कर सकते हैं और प्रत्येक प्रविष्टि के लिए डायरेक्टरी या जेएआर फ़ाइल खोज सकते हैं।
उल्लेखनीय है
यदि आप किसी पैकेज के तहत सभी वर्गों की सूची चाहते हैं, तो आप Reflection
निम्न तरीके का उपयोग कर सकते हैं :
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));
}
यह उन कक्षाओं की एक सूची बनाएगा जो बाद में आप अपनी इच्छानुसार उनका उपयोग कर सकते हैं।
यह बहुत संभव है, लेकिन बिना अतिरिक्त पुस्तकालयों के जैसे Reflections
यह कठिन है ...
यह कठिन है क्योंकि आपने कक्षा का नाम प्राप्त करने के लिए पूर्ण साधन नहीं बनाया है।
और, मैं अपनी ClassFinder
कक्षा का कोड लेता हूं :
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;
}
}
@ स्टैले के उत्तर के आधार पर , और तीसरे पक्ष के पुस्तकालयों पर भरोसा न करने के प्रयास में, मैं पहले पैकेज के भौतिक स्थान का निरीक्षण करके फाइल सिस्टम दृष्टिकोण को लागू करूंगा:
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);
यदि आप केवल संबंधित वर्गों के एक समूह को लोड करना चाह रहे हैं, तो स्प्रिंग आपकी मदद कर सकता है।
स्प्रिंग उन सभी वर्गों की सूची या मानचित्र को तुरंत बदल सकता है जो किसी दिए गए इंटरफ़ेस को कोड की एक पंक्ति में लागू करते हैं। सूची या मानचित्र में उन सभी वर्गों के उदाहरण होंगे जो उस इंटरफ़ेस को लागू करते हैं।
कहा जा रहा है, फ़ाइल सिस्टम से कक्षाओं की सूची को लोड करने के विकल्प के रूप में, इसके बजाय केवल उन सभी वर्गों में एक ही इंटरफ़ेस लागू करें जिन्हें आप लोड करना चाहते हैं, पैकेज की परवाह किए बिना और उन सभी के उदाहरण प्रदान करने के लिए स्प्रिंग का उपयोग करें। इस तरह, आप उन सभी वर्गों को लोड (और त्वरित) कर सकते हैं जो आप चाहते हैं कि वे किस पैकेज में हैं।
दूसरी ओर, यदि उन सभी को एक पैकेज में रखना है जो आप चाहते हैं, तो बस उस पैकेज में सभी कक्षाएं एक दिए गए इंटरफ़ेस को लागू करें।
सादे जावा: 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);
}
}
पुनश्च: त्रुटियों से निपटने के लिए बॉयलरप्लेट्स को सरल बनाने के लिए, आदि, मैं यहां vavr
और lombok
पुस्तकालयों का उपयोग कर रहा हूं
अन्य कार्यान्वयन मेरे GitHub daggerok / जावा-प्रतिबिंब-खोज-एनोटेट-वर्ग-या-विधियों रेपो में पाए जा सकते हैं
मैं इतना आसान कुछ के लिए एक छोटा काम कर नहीं ढूँढ सका। तो यहाँ यह है, मैं थोड़ी देर के लिए चारों ओर पेंच के बाद इसे खुद बनाया:
Reflections reflections =
new Reflections(new ConfigurationBuilder()
.filterInputsBy(new FilterBuilder().includePackage(packagePath))
.setUrls(ClasspathHelper.forPackage(packagePath))
.setScanners(new SubTypesScanner(false)));
Set<String> typeList = reflections.getAllTypes();
यदि आप स्प्रिंग-लैंड में हैं तो आप उपयोग कर सकते हैं PathMatchingResourcePatternResolver
;
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
Resource[] resources = resolver.getResources("classpath*:some/package/name/*.class");
Arrays.asList(resources).forEach(r->{
...
});