Java 如何在给定的包中找到带注释的方法？

我有一个简单的方法标记注释（类似于有效Java（第二版）第35项中的第一个示例）：

然后，在一个给定的包（比如说

com.acme.installer

）中，它有几个包含大约20个类的子包，我想找到用它注释的所有方法。（因为我想对单元测试中所有带注释的方法进行一些检查。）

最简单的方法是什么（如果有的话）？最好不添加新的第三方库或框架

---

编辑：为了澄清这一点，显然

方法.isAnnotationPresent（InstallerMethod.class）

将是检查方法是否具有注释的方法-但这个问题包括查找所有方法。

如果您想自己实现它，这些方法将查找给定包中的所有类：

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

---

如果您很乐意使用Spring，那么可以使用它的上下文执行以下操作：组件扫描功能，其中Spring扫描给定包中带注释的类。在封面下，这是相当可怕的，涉及到在文件系统和JAR文件中查找包中的类

即使您不能直接使用Spring，浏览一下它的源代码可能会给您一些想法

---

当然，Java反射APi在这里没有用处，它并没有提供获取包中所有类的方法。

您可能应该看看开源。使用它，您只需几行代码即可轻松实现所需：

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

反射=新反射（
新建ConfigurationBuilder（）.setURL（
ClasspathHelper.forPackage（“com.acme.installer”）.setScanners(
新方法AnnotationsCanner（））；
Set methods=reflections.getMethodsNotatedWith（InstallerMethod.class）；

Check-Hmm，是的，我想这又回到了那个问题（我在二月份问过这个问题）：P但是正确的答案是“不，不能使用反射”，这里的问题是如何最容易地找到带注释的方法，使用任何方法……因为这里的困难部分实际上与注释无关（但从包中查找类），这个问题并不像我想的那样相关。：/哦，好吧，也许这仍然可以帮助那些想知道同样事情的人…谢谢！用这个我可以做我想做的事。这是相当多的代码，但也许没有一种更简单的方法（没有外部libs），让classloader按照它的方式工作。谢谢分享。我使用这段代码作为我自己解决方案的基础，不过其他人应该注意，如果要在JAR文件中查找类，则需要做更多的工作。@MickSear我对在JAR文件中查找类非常感兴趣。你能给我一些额外工作的提示吗？@OndraŽižka这个片段已经不在你的链接中了。@parkr非常感谢。这节省了我很多时间。我有同样的方法，但在形成完全限定名称时得到了重复的包。谢谢。嗯，你说的是“Spring扫描带注释的类”-在我们寻找带注释的方法的情况下，即使在没有注释的类中，你能使用它吗？或者，如果您使用Spring实现parkr答案中的getClasses（String packageName）这样的方法，它会变得更简单吗？Spring代码会查找该包中的所有类，然后查找类和方法级别的注释。在某些环境中，您可能可以使它变得更简单，但不是非常简单。您确定这有效吗？试试看，我觉得不行。我必须在Reflections类构造函数中设置扫描器以使其工作，如下所示：

Reflections Reflections=new Reflections（new ConfigurationBuilder（）.setURL（ClasspathHelper.forPackage（“com.acme.installer”））.setScanners（new MethodAnnotationsCanner（））for (Method method : testClass.getMethods())
{
    if (method.isAnnotationPresent(InstallerMethod.class))
    {
        // do something
    }
}

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