किसी दिए गए पैकेज में एनोटेटेड विधियों को कैसे ढूंढें?

Question

मेरे पास विधियों के लिए एक सरल मार्कर एनोटेशन है ( प्रभावी जावा (द्वितीय संस्करण) में आइटम 35 में पहले उदाहरण के समान):

/** 
* Marker annotation for methods that are called from installer's 
* validation scripts etc. 
*/ 
@Retention(RetentionPolicy.RUNTIME) 
@Target(ElementType.METHOD) 
public @interface InstallerMethod { 
} 

फिर, किसी दिए गए पैकेज में (com.acme.installer कहें), जिसमें एक है कुछ 20 वर्गों वाले कुछ उप-पैकेज, मैं उन सभी विधियों को ढूंढना चाहता हूं जो इसके साथ एनोटेटेड हैं। (क्योंकि मैं यूनिट टेस्ट में सभी एनोटेटेड विधियों के बारे में कुछ चेक करना चाहता हूं।) Xzx26

क्या (यदि कोई है) ऐसा करने का सबसे आसान तरीका है? पसंदीदा रूप से नई तृतीय पक्ष पुस्तकालयों या ढांचे को जोड़ने के बिना।

संपादित करें: स्पष्टीकरण के लिए, स्पष्ट रूप से method.isAnnotationPresent(InstallerMethod.class) यह जांचने का तरीका होगा कि किसी विधि में एनोटेशन है या नहीं - लेकिन इस समस्या में सभी विधियों को ढूंढना शामिल है।

Answer 1

आप इसे अपने आप को लागू करने के लिए, इन तरीकों को दिए गए पैकेज में सभी वर्गों मिलेगा चाहते हैं:

for (Method method : testClass.getMethods()) 
{ 
    if (method.isAnnotationPresent(InstallerMethod.class)) 
    { 
     // do something 
    } 
} 

Answer 2

:

/** 
* 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 Iterable<Class> getClasses(String packageName) throws ClassNotFoundException, IOException 
{ 
    ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); 
    String path = packageName.replace('.', '/'); 
    Enumeration<URL> resources = classLoader.getResources(path); 
    List<File> dirs = new ArrayList<File>(); 
    while (resources.hasMoreElements()) 
    { 
     URL resource = resources.nextElement(); 
     URI uri = new URI(resource.toString()); 
     dirs.add(new File(uri.getPath())); 
    } 
    List<Class> classes = new ArrayList<Class>(); 
    for (File directory : dirs) 
    { 
     classes.addAll(findClasses(directory, packageName)); 
    } 

    return classes; 
} 

/** 
* 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 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()) 
     { 
      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; 
} 

तो फिर तुम सिर्फ दिए गए एनोटेशन के साथ उन वर्गों पर फ़िल्टर कर सकते हैं

यदि आप स्प्रिंग का उपयोग करने में प्रसन्न हैं, तो यह इन संदर्भों के साथ कुछ संदर्भ करता है: घटक-स्कैन कार्यक्षमता, जहां स्प्रिंग किसी दिए गए पैकेज में एनोटेटेड कक्षाओं के लिए स्कैन करता है। कवर के तहत, यह बहुत भयानक है, और फाइल सिस्टम पर और जेएआर फाइलों में पैकेज में कक्षाओं की तलाश में गड़बड़ाना शामिल है।

भले ही आप सीधे वसंत का उपयोग नहीं कर सकते हैं, इसके स्रोत कोड को देखने से आपको कुछ विचार मिल सकते हैं।

निश्चित रूप से, जावा प्रतिबिंब एपीआई का कोई उपयोग नहीं है, यह विशेष रूप से पैकेज में सभी वर्गों को प्राप्त करने का साधन प्रदान नहीं करता है।

Answer 3

आपको शायद ओपन सोर्स Reflections library पर एक नज़र डालना चाहिए। इसके साथ आप आसानी से प्राप्त कर सकते हैं क्या आप कोड की कुछ लाइनों के साथ हैं:

Reflections reflections = new Reflections( 
    new ConfigurationBuilder().setUrls( 
    ClasspathHelper.forPackage("com.acme.installer")).setScanners(
    new MethodAnnotationsScanner())); 
Set<Method> methods = reflections.getMethodsAnnotatedWith(InstallerMethod.class);