web-dev-qa-db-ja.com

特定のパッケージで注釈付きメソッドを見つける方法は？

メソッドの簡単なマーカーアノテーションがあります（Effective Java（第2版）の項目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個のクラスを含むサブパッケージがいくつかあり、それに注釈が付けられているすべてのメソッドを検索したいと思います。 （ユニットテストですべての注釈付きメソッドについてチェックを行いたいため）

これを行う最も簡単な方法は何ですか？できれば、新しいサードパーティのライブラリやフレームワークを追加しないでください。

編集：明確にするために、明らかにmethod.isAnnotationPresent(InstallerMethod.class)はメソッドに注釈があるかどうかを確認する方法になりますが、この問題にはすべてのメソッドの検索が含まれます。

javaannotations
49
Jonik

自分で実装したい場合、これらのメソッドは特定のパッケージ内のすべてのクラスを見つけます：

/**
 * 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
    }
}
51
parkr

おそらく、オープンソース Reflectionsライブラリ をご覧ください。これを使用すると、数行のコードで簡単に目的を達成できます。

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

Springを使用してよければ、context：component-scan機能を使用してこれらの行に沿って何かを実行します。Springは、指定されたパッケージ内の注釈付きクラスをスキャンします。カバーの下では、かなり厄介で、パッケージ内のクラスを探すためにファイルシステムとJARファイルをグラブする必要があります。

Springを直接使用できない場合でも、そのソースコードに目を通すと、アイデアが得られる場合があります。

確かに、JavaリフレクションAPiはここでは使用できません。具体的には、パッケージ内のすべてのクラスを取得する手段を提供しません。

1
skaffman