Как найти аннотированные методы в данном пакете?

Question

У меня есть простая аннотация маркера для методов (аналогично первому примеру в пункте 35 в Effective Java (2nd ed)):

/**
 * 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 классов, я хотел бы найти все методы, которые аннотированы с ним. (Потому что я хотел бы сделать некоторые проверки относительно всех аннотированных методов в модульном тесте.)

Какой (если таковой имеется) самый простой способ сделать это? Желательно без добавления новых сторонних библиотек или фреймворков.

Редактировать : чтобы уточнить, очевидно, method.isAnnotationPresent(InstallerMethod.class) будет способом проверить, есть ли метод с аннотацией - но эта проблема включает в себя поиск всех методов.

Answer 1

Если вы хотите реализовать это самостоятельно, эти методы найдут все классы в данном пакете:

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

Тогда вы можете просто отфильтровать эти классы с заданной аннотацией:

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

Answer 2

Возможно, вам стоит взглянуть на открытый исходный код Библиотека отражений . С его помощью вы можете легко достичь желаемого с помощью нескольких строк кода:

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

Answer 3

Если вы счастливы использовать Spring, то он делает что-то вроде этого, используя свой контекст: функциональность сканирования компонентов, где Spring сканирует аннотированные классы в заданном пакете. Под прикрытием это довольно отвратительно и включает в себя поиск файловой системы и файлов JAR в поисках классов в пакете.

Даже если вы не можете использовать Spring напрямую, ознакомление с его исходным кодом может дать вам некоторые идеи.

Конечно, Java-отражение APi здесь бесполезно, оно, в частности, не предоставляет средства для получения всех классов в пакете.