模块化/可插拔的 Java Web 应用程序

Question

我一直在尝试构建一个模块化的网络应用程序。

我的要求是动态生成 UI，但让 ui 的组件可插入。例如，我可能有一组开箱即用的核心 UI 小部件，但如果客户想要创建自己的小部件，则会有一个定义的接口供他们实现自己的组件。

我正在使用 vaadin 作为我的 ui 框架。并且只想让最终用户提供一个包含 ui 的 jar 或 war 文件。我不想将 jar 捆绑在我的 war 文件中，但是，最终用户提供的任何内容都应该可以按原样部署。

我已经研究过使用 osgi，并且已经能够获得一个允许使用 vaadin 从捆绑包中动态 ui 的框架，但是我正在经历其他需求的依赖地狱。还有其他我没有考虑过的选择吗？

Answer 1

我使用 osgi 和 vaadin 按照我想要的方式工作。我使用这个教程作为一个参考。这让我达到了我所需要的一半。

Answer 2

看来我正在做一件非常相似的事情。虽然最终诸如 OSGi 和 NetBeans Platform（也可以在服务器端使用）之类的组件框架是我已经使用过并且正在用于其他项目的可行解决方案，但当您使用更多功能时，它们会付出其复杂性的代价除了搜索注册组件（例如强制执行依赖项检查、版本检查、模块隔离等）之外，它们还提供了这些功能。

但对于扫描捆绑类，有一个更简单的解决方案，基于注释扫描。在我的 Vaadin 项目中，我正在创建一个引用“抽象”组件名称的用户界面，该名称必须与用户可能提供的实际 Java 类相匹配。

实现组件的 Java 类用定制的注释进行标记： 例如

@ViewMetadata(typeUri="component/HtmlTextWithTitle", controlledBy=DefaultHtmlTextWithTitleViewController.class)
public class VaadinHtmlTextWithTitleView extends Label implements HtmlTextWithTitleView

然后我使用 ClassScanner 在类路径中搜索带注释的类：

    final ClassScanner classScanner = new ClassScanner();
    classScanner.addIncludeFilter(new AnnotationTypeFilter(ViewMetadata.class));

    for (final Class<?> viewClass : classScanner.findClasses())
      {
        final ViewMetadata viewMetadata = viewClass.getAnnotation(ViewMetadata.class);
        final String typeUri = viewMetadata.typeUri();
        // etc...
      }

这是我对 ClassScanner 的完整实现，在 Spring 之上实现：

import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
import org.springframework.core.type.filter.TypeFilter;
import org.springframework.util.ClassUtils;

public class ClassScanner 
  {
    private final String basePackage = "it"; // FIXME

    private final ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false);

    @Nonnull
    public final Collection<Class<?>> findClasses() 
      {
        final List<Class<?>> classes = new ArrayList<Class<?>>();

        for (final BeanDefinition candidate : scanner.findCandidateComponents(basePackage)) 
          {
            classes.add(ClassUtils.resolveClassName(candidate.getBeanClassName(), ClassUtils.getDefaultClassLoader()));
          }

        return classes;
      }

    public void addIncludeFilter (final @Nonnull TypeFilter filter)
      {
        scanner.addIncludeFilter(filter);
      }
  }

它非常简单，但有效。请注意，由于 Java 类加载器的工作方式，您必须至少指定一个要搜索的包。在我的示例中，我硬连线了顶级包“it”（我的东西是“it.tidalwave.*”），很容易将此信息放入可配置的属性中，最终指定多个包。

---

另一种解决方案可以通过仅使用 NetBeans 平台中的两个库来实现。我强调这样一个概念：这不会将整个平台导入到您的项目中，包括类加载器设施等，而只是使用两个 jar 文件。因此它不是侵入性的。这些库是 org-openide-util.jar 和 org-openide-util-lookup.jar（我再次强调，您可以使用纯 .jar 文件，而不是特定于 NetBeans 平台的 .nbm 文件）。

基本上，您可以使用 @ServiceProvider 注解。它在编译期间被触发（使用 Java 6）并生成一个 META-INF/services/ 描述文件，该文件将放置在类路径中。该文件是 Java 的标准功能（我相信是从 1.3 开始），可以使用标准类 ServiceLoader。在这种情况下，您只能在编译期间使用 NetBeans 平台库，因为它们仅用于生成 META-INF/服务。最终，通过 Lookup 类。

这两种解决方案之间存在设计差异。通过我的自定义注释，我发现了类：然后我通过反射使用它们来实例化对象。使用@ServiceProvider，系统会自动实例化类中的“单例”对象。因此，在前一种情况下，我为要创建的对象注册类，在第二种情况下，我注册一个工厂来创建它们。在这种情况下，似乎前一种解决方案需要少一段，这就是我使用它的原因（通常，我经常使用@ServiceProvider）。

---

总结起来，列举了三种解决方案：

1. 将我提供的 ClassScanner 与 Spring 结合使用。运行时需要 Spring。
2. 在代码中使用@ServiceProvider并使用ServiceLoader进行扫描。在编译时需要两个 NetBeans 平台库，在运行时仅需要 Java 运行时。
3. 在代码中使用@ServiceProvider并使用Lookup进行扫描。运行时需要两个 NetBeans 平台库。

您还可以查看此问题的答案。

Answer 3

嗯，我之前曾将 OSGi 用于大型模块化 UI。我们使用在 Shindig 内运行的 opensocial 小工具。 OSGi 很好，因为您可以将其他小工具作为捆绑包放入框架中，然后让侦听器拾取它们并将它们添加到用户的小工具选择中。该模型可以很好地扩展到主题等其他事物。您在使用 OSGi 和其他依赖项时遇到哪些问题？