你如何找到Java中给定类的所有子类?
Question
一个人如何去尝试在Java中查找给定类(或给定接口的所有实现者)的所有子类? 到目前为止,我有一个方法来做到这一点,但我觉得效率很低(至少可以这么说)。 该方法是:
获取类路径中存在的所有类名的列表
加载每个类并测试它是否是所需类或接口的子类或实现者
在Eclipse中,有一个称为类型层次结构的很好的功能,可以非常有效地显示这一点。 人们如何去编程地做呢?
Answers
使用纯Java扫描类是不容易的。
Spring框架提供了一个名为ClassPathScanningCandidateComponentProvider的类,可以完成您所需的任务。 以下示例将查找包org.example.package中MyClass的所有子类
ClassPathScanningCandidateComponentProvider provider = new ClassPathScanningCandidateComponentProvider(false);
provider.addIncludeFilter(new AssignableTypeFilter(MyClass.class));
// scan in org.example.package
Set components = provider.findCandidateComponents("org/example/package");
for (BeanDefinition component : components)
{
Class cls = Class.forName(component.getBeanClassName());
// use class cls found
}
这种方法具有使用字节码分析器来查找候选的额外好处,这意味着它不会加载它扫描的所有类。
您可以尝试我的库FastClasspathScanner - 它可以在类路径中找到给定类的所有子类(以及给定接口的所有子接口,实现给定接口的所有类,使用给定注释标注的所有类等等) 。 它是一个小的依赖项,与其他类路径扫描选项相比,它非常快速。
顺便说一句,扫描类路径并不像检查java.class.path属性那么简单,因为有许多方法可以指定类路径(例如,可以将Class-Path条目添加到jar文件的清单中)。 FastClasspathScanner为您处理这些复杂问题。
应该注意的是,这当然只能找到当前类路径中存在的所有子类。 大概这对你目前正在看的东西是可以的,而且你很可能考虑过这个问题,但是如果你有任何一点发布非野生课程(对于不同水平的“野生”),那么它是完全可行的别人已经编写了你自己不知道的子类。
因此,如果您碰巧希望看到所有的子类,因为您想要进行更改,并且会看到它如何影响子类的行为 - 请记住您看不到的子类。 理想情况下,所有的非私人方法,以及班级本身都应该有详细记录; 至少根据本文档进行更改而不更改方法/非专用字段的语义,并且您的更改应该是向后兼容的,适用于任何遵循您的超类定义的子类。
不要忘记,为类生成的Javadoc将包含已知子类(以及接口,已知实现类)的列表。
我知道我对这个派对迟了几年,但我遇到了这个问题,试图解决同样的问题。 如果你正在编写一个Eclipse插件(从而利用它们的缓存等),你可以使用Eclipse的内部搜索来寻找实现接口的类。 这是我的(非常粗糙)第一次切割:
protected void listImplementingClasses( String iface ) throws CoreException
{
final IJavaProject project = ;
try
{
final IType ifaceType = project.findType( iface );
final SearchPattern ifacePattern = SearchPattern.createPattern( ifaceType, IJavaSearchConstants.IMPLEMENTORS );
final IJavaSearchScope scope = SearchEngine.createWorkspaceScope();
final SearchEngine searchEngine = new SearchEngine();
final LinkedList results = new LinkedList();
searchEngine.search( ifacePattern,
new SearchParticipant[]{ SearchEngine.getDefaultSearchParticipant() }, scope, new SearchRequestor() {
@Override
public void acceptSearchMatch( SearchMatch match ) throws CoreException
{
results.add( match );
}
}, new IProgressMonitor() {
@Override
public void beginTask( String name, int totalWork )
{
}
@Override
public void done()
{
System.out.println( results );
}
@Override
public void internalWorked( double work )
{
}
@Override
public boolean isCanceled()
{
return false;
}
@Override
public void setCanceled( boolean value )
{
}
@Override
public void setTaskName( String name )
{
}
@Override
public void subTask( String name )
{
}
@Override
public void worked( int work )
{
}
});
} catch( JavaModelException e )
{
e.printStackTrace();
}
}
我目前看到的第一个问题是,我只捕获直接实现接口的类,而不是所有的子类 - 但是一点递归从不会伤害任何人。
根据您的特定需求,在某些情况下,Java的服务加载器机制可能会实现您的目标。
简而言之,它允许开发人员通过将其列入JAR / WAR文件的META-INF/services目录中的文件中,明确声明某个类是其他类的子类(或实现了某个接口)。 然后可以使用java.util.ServiceLoader类来发现它,当给定一个Class对象时,它将生成该类的所有声明子类的实例(或者,如果Class表示一个接口,则实现该接口的所有类)。
这种方法的主要优点是不需要手动扫描子类的整个类路径 - 所有的发现逻辑都包含在ServiceLoader类中,它只加载在META-INF/services目录中显式声明的类(不是classpath中的每个类)。
但是,有一些缺点:
它不会找到所有的子类,只有那些明确声明的子类。 因此,如果你需要真正找到所有的子类,这种方法可能是不够的。
它要求开发者在META-INF/services目录下显式声明这个类。 这对开发人员来说是一种额外的负担,并且可能容易出错。
ServiceLoader.iterator()生成子类实例,而不是它们的Class对象。 这导致两个问题:
对于如何构造子类,您没有任何说法 - 使用无参数构造函数来创建实例。
因此,子类必须具有默认构造函数,或者必须声明一个无参数构造函数。
显然,Java 9将解决这些缺点中的一些(特别是关于子类的实例化的那些缺点)。
一个例子
假设您有兴趣找到实现接口com.example.Example类。 com.example.Example :
package com.example;
public interface Example {
public String getStr();
}
类com.example.ExampleImpl实现该接口:
package com.example;
public class ExampleImpl implements Example {
public String getStr() {
return "ExampleImpl's string.";
}
}
您将通过创建包含文本com.example.ExampleImpl的文件META-INF/services/com.example.Example来声明类ExampleImpl是ExampleImpl的一个实现。
然后,您可以获取每个Example (包括ExampleImpl一个实例)的实例,如下所示:
ServiceLoader loader = ServiceLoader.load(Example.class)
for (Example example : loader) {
System.out.println(example.getStr());
}
// Prints "ExampleImpl's string.", plus whatever is returned
// by other declared implementations of com.example.Example.
将它们添加到(this.getClass()。getName())父类构造函数(或创建一个默认的)中的静态映射中,但会在运行时更新。 如果懒惰初始化是一个选项,你可以尝试这种方法。