译自《OSGi》

OSGi

本章主要面向已经熟悉OSGi的人 ，代表开放式服务网关计划（Open Services Gateway Initiative） 。 OSGi背后的想法是将模块添加到Java应用程序中，而不需要重新启动。 TornadoFX支持OSGi，并允许高度模块化和动态的应用。

如果您对OSGi目前没有兴趣，欢迎跳过本章。 然而，强烈建议至少知道它是什么，这样您就可以识别将来可能需要使用的时刻。

TornadoFX带有OSGi运行时所需的元数据，以检测和启用它。 当tornadofx.jar加载到OSGi容器中时，会在运行时自动安装多个服务。 这些服务使我们能够讨论一些非常有趣的功能。

OSGi 简介

在继续本章之前，请先熟悉OSGi的基础知识。 要快速了解OSGi技术，您可以查看OSGi联盟网站（OSGi Alliance website）上的教程 （tutorials）。 Apache Felix教程（Apache Felix tutorials）也是基本OSGi模式的良好参考起点。

服务（Services）

当TornadoFX JAR加载时，您可以创建自己的TornadoFX软件包（bundle），并以任何您喜欢的方式创建应用程序。 然而，一些使用模式是非常典型和有用的，因此TornadoFX具有内置的对他们的支持。

动态应用（Dynamic Applications）

OSGi的动态性质一般适用于GUI应用程序。 随着环境的变化，具有某些功能的加入或撤出（ come and go）的能力可以很强大。 不幸的是，JavaFX本身是以一种防止在初始的应用程序关闭后启动另一个JavaFX应用程序的方式编写的。 为了规避这个缺点，您可以根据需要停止和启动应用程序，TornadoFX提供了一种使用应用程序代理（application proxy）注册App类的方法，即使在您的应用程序关闭时，也能保持JavaFX环境运行。

要开始，可以实现一个BundleActivator，它提供start()和stop() 一个App的方法 。 您的bundle的 Activator中，可以通过调用context.registerApplication来注册您的应用程序的这个功能，并使用您的App类作为单个参数完成：

class Activator : BundleActivator {
    override fun start(context: BundleContext) {
        context.registerApplication(MyApp::class)
    }

    override fun stop(context: BundleContext) {
    }
}

如果您更喜欢使用OSGi声明性服务（declarative services），下面的方式会具有相同的效果，只要您加载了OSGi DS软件包：

@Component
class AppRegistration : ApplicationProvider {
    override val application = MyApp::class
}

如果您的容器中提供了TornadoFX软件包，这足以在软件包激活后自动启动应用程序。 您现在可以通过停止或启动软件包（bundle）来停止并启动多次你的应用。

动态样式表

要为其他TornadoFX软件包提供类型安全的样式表（type-safe stylesheets），您可以通过在Activator中注册他们：

class Activator : BundleActivator {
    override fun start(context: BundleContext) {
        context.registerStylesheet(Styles::class)
    }

    override fun stop(context: BundleContext) {
    }
}

使用OSGi声明式服务（Declarative Services），注册如下所示：

@Component
class StyleRegistration : StylesheetProvider {
    override val stylesheet = Styles::class
}

每当加载此bundle时，每个活动View都将应用此样式表。 该bundle卸载后，样式表也将自动删除。 如果要根据相同的样式类（style classes）提供多个样式表（multiple stylesheets），最好创建一个导出cssclass定义的bundle，以便您的Views可以引用这些样式，并且样式表包（stylesheet bundles）可以根据它们创建选择器（selectors）。

动态视图

OSGi的一个很酷的方面是在UI元素可用时就弹出UI元素的能力。 典型的用例是“仪表板（dashboard）”应用程序。 在此示例中，基础应用程序包（base application bundle）包含可以保存其他视图（Views）的View，并告诉TornadoFX OSGi运行时（Runtime），如果符合特定条件，它将自动嵌入视图（Views）。

例如，我们可以创建一个包含VBox的View。 我们告诉TornadoFX OSGi运行时，我们希望将其他视图（Views）嵌入其中，如果它们使用了discriminator仪表板（dashboard）标记：

class Dashboard : View() {
    override val root = VBox()

    init {
        title = "Dashboard Application"
        addViewsWhen { it.discriminator == "dashboard" }
    }
}

如果addViewsWhen函数返回true，则将View添加到VBox 。 要提供对此仪表板（Dashboard）的视图（Views），另一个包（bundle）可以声明它要通过设置dashboarddiscriminator导出它的视图。 在这里，我们注册一个虚构的MusicPlayer视图，当它的包（bundle）变为活动时，就会被放置在仪表板中（ docked into the dashboard）。

class Activator : BundleActivator {
    override fun start(context: BundleContext) {
        context.registerView(MusicPlayer::class, "dashboard")
    }

    override fun stop(context: BundleContext) {
    }
}

再次，导出视图的OSGi Declarative Services方式如下所示：

@Component
class MusicPlayerRegistration : ViewProvider {
    override val discriminator = "dashboard"
    override fun getView() = find(MusicPlayer::class)
}

addViewsWhen函数足够聪明以检查VBox并找出如何添加子视图。 还可以看出，如果您在TabPane上调用该函数，它将创建一个新的Tab并将标题设置为子视图的标题等。如果您想使用所提供的视图进行自定义，则可以从函数返回false，以便不会自动添加子视图，然后就可以执行所需的任何操作。 即使Tab示例是开箱即用的，您也可以明确地这样做：

tabPane.addViewsWhen {
    if (it.discriminator == "dashboard") {
        val view = it.getView()
        tabPane.tab(view.title, view.root)
    }
    false
}

手动处理动态视图

创建您的第一个OSGi包

一个好的起点是TornadoFX IntelliJ IDEA插件中的tornadofx-maven-osgi-project模板。 这包含从您的源代码来构建OSGi软件包所需的一切。 OSGI IDEA插件使得从IDE直接设置和运行OSGi容器非常容易。 https://www.youtube.com/watch?v=liOFCH5MMKK上有一个屏幕截图，显示了这些概念的运用。

OSGi控制台

TornadoFX有一个内置的OSGi控制台，您可以从中检查软件包，更改其状态，甚至通过拖放来安装新的软件包。 您可以使用Alt-Meta-O打开控制台，或通过设置FX.osgiConsoleShortcut或以编程方式打开OSGIConsole View来配置其他快捷方式。

要求

要在OSGi容器中运行TornadoFX，需要加载所需的包（bundles）。 通常只是需要将这些jar转储到容器的bundle目录中就行了。 请注意，要在OSGi容器中使用的任何jar需要“启用OSGi”（OSGi enabled），这实际上意味着添加一些OSGi特定条目到META-INF/MANIFEST.MF文件。

我们提供了一个完整的安装，其中Apache Felix和TornadoFX已经安装在http://tornadofx.tornado.no/felix-tornadofx-5.4.0.zip 。 记得切换tornadofx.jar的最新版本，因为这个bundle最有可能落后于几个版本。

这些是在OSGi容器中运行任何TornadoFX应用程序所需的工件。 您的容器可能已经与其中的一些捆绑在一起，因此请检查容器文档以获取更多详细信息。

• 1. Kotlin OSGi bundle 包含特定版本的kotlin-stdlib和kotlin-reflect，具有所需的OSGi清单（manifest）信息。
• 2. 这链接到Apache Felix实现的OSGi配置管理界面（OSGi Config Admin interface）。 随意使用你的OSGi容器的实现。 某些容器（如Apache Karaf）已经装载了Config Admin bundle，因此您不需要它。