在 Android 中实现类似 Spring 的包扫描

Question

我正在尝试为我正在开发的 Android 框架实现包扫描功能，类似于 Spring 的component-scan。基本上，我希望能够指定一个基本包，例如com.foo.bar 并检索具有特定注释的所有 Class 实例。我不想在我的框架中注册每个组件，因为这会破坏自动扫描的目的。

根据我的研究，Java 似乎无法使用反射检索给定包名称的资源。但是，我简要查看了Reflections framework，我想知道是否有与 Android 兼容的等价物。如果没有，也许有一种不太明显的方法可以完成我想做的事情。

我稍微研究了 Spring 源代码以了解他们是如何实现这一点的，但我认为他们所做的事情不会在 Dalvik 运行时中起作用。

更新

目前，下面的代码是我能做的最好的检索所有包含特定注释的类的方法，但坦率地说，这是一个非常糟糕的解决方案。它对ClassLoader 做了一些非常不安全的假设，而且它扫描（并加载）所有应用程序类。

public Set<Class<?>> getClassesWithAnnotation(Class<? extends Annotation> annotation) {
    Set<Class<?>> classes = new HashSet<Class<?>>();
    Field dexField = PathClassLoader.class.getDeclaredField("mDexs");
    dexField.setAccessible(true);
    PathClassLoader classLoader = (PathClassLoader) Thread.currentThread().getContextClassLoader();
    DexFile[] dexs = (DexFile[]) dexField.get(classLoader);
    for (DexFile dex : dexs) {
        Enumeration<String> entries = dex.entries();
        while (entries.hasMoreElements()) {
            String entry = entries.nextElement();
            Class<?> entryClass = dex.loadClass(entry, classLoader);
            if (entryClass != null && entryClass.isAnnotationPresent(annotation)) {
                classes.add(entryClass);
            }
        }
    }
    return classes;
}

Answer 1

我想在运行时找到所有的子类。 所以我一直在寻找android类扫描。 这是我在 web.xml 中收集到的最终代码。 你会明白的。

public static void findSubClasses(Context context, Class parent) {
    ApplicationInfo ai = context.getApplicationInfo();
    String classPath = ai.sourceDir;
    DexFile dex = null;
    try {
        dex = new DexFile(classPath);
        Enumeration<String> apkClassNames = dex.entries();
        while (apkClassNames.hasMoreElements()) {
            String className = apkClassNames.nextElement();
            try {
                Class c = context.getClassLoader().loadClass(className);
                if (parent.isAssignableFrom(c)) {
                    android.util.Log.i("nora", className);
                }
            } catch (ClassNotFoundException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
            //              android.util.Log.i("nora", className);
        }
    } catch (IOException e) {
        // TODO Auto-generated catch block
        e.printStackTrace();
    } finally {
        try {
            dex.close();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
}

Answer 2

我同意 Joop Eggen 的观点，并认为他的方法很好。在 Android 中，我尽量避免导致应用程序长时间启动的常见网络应用程序功能。我不使用反射或包扫描。

但是如果你想......如果我理解正确你想要一个类的注释。除了使用注释，您还可以使用标记接口（只是有更多的可能性）。

1) 看看

• 注释：Java custom annotation and dynamic loading
  在问题中有一个实现，可以回答您的问题。
• 注解：Scanning Java annotations at runtime
• 接口：Find Java classes implementing an interface
• 接口：Is something similar to ServiceLoader in Java 1.5?
• 接口：How can I get a list of all the implementations of an interface programmatically in Java?
• 接口：由于该方法很昂贵，ServiceLoader 可能是执行时间和舒适度之间的折衷，因为它只加载服务文件中给出的类。另一方面，如果您的包中只有具有特定接口的类，那么 ServiceLoader 并没有那么快。

2) 安卓注解

我更喜欢AndroidAnnotations 的工作方式（也许AndroidAnnotations 中的集成是更可取的方式）：它使用标准Java Annotation Processing Tool 自动添加生成源代码的额外编译步骤。因此，您可以根据编译时生成的注释执行代码，而不是运行时扫描。

我认为 Bean/EBean 注释可以为您工作（仅单个类）：https://github.com/excilys/androidannotations/wiki/Enhance%20custom%20classes

扫描功能不可用，请参阅thread

3) 编写自己的注释处理器

• 见APT (Annotation Processing Tool)。这个想法是生成一个静态函数，该函数返回一个带注释的类列表，因此不需要进行类扫描。
• 一个很好的资源是http://javadude.com/articles/annotations/index.html

Answer 3

看看 Vogar 的 ClassPathScanner。它使用它来查找类路径上的测试用例。

Answer 4

编辑：

我在 Android 问题跟踪器中找到了this issue。 ClassLoader.getResource(String) 似乎“按预期工作”，因为它返回 null。这是意料之中的，因为 DalvikVM 在编译后不会保留资源。问题中列出了解决方法，但可能还有其他方法可以访问您想要的类。

使用PackageManager 获取ApplicationInfo 的实例。 ApplicationInfo 有一个名为 sourceDir 的公共字段，它是该应用程序源目录位置的完整路径（String）。从此String 创建一个File，您应该能够导航到源目录中的包。在那里，您可以使用我原始答案中的方法来查找您要查找的类。

String applicationSourceDir = 
    getPackageManager().getApplicationInfo(androidPackageName, 0).sourceDir;

/EDIT

您应该能够使用ClassLoader.getResource(String) 为您的特定包获取URL（传入的String 是您感兴趣的包名称，由路径分隔符而不是句点分隔）。有了这个URL，您就可以调用getFile()，您可以从中创建一个Java File 到包文件夹。从那里调用packageFile.listFiles()，你就有了你的类/子包。

对子包进行递归，在类中使用静态Class.forName(String) 方法找到Class 对象。

Answer 5

在您的 java 构建过程中加入类路径扫描，生成注入数据/代码。然后这也可以移植到 Dalvik。比动态扫描效率更高。