譯自《OSGi》
OSGi
本章主要面向已經(jīng)熟悉OSGi的人 笋熬,代表開放式服務(wù)網(wǎng)關(guān)計劃(Open Services Gateway Initiative) 。 OSGi背后的想法是將模塊添加到Java應(yīng)用程序中腻菇,而不需要重新啟動胳螟。 TornadoFX支持OSGi昔馋,并允許高度模塊化和動態(tài)的應(yīng)用。
如果您對OSGi目前沒有興趣糖耸,歡迎跳過本章秘遏。 然而,強烈建議至少知道它是什么嘉竟,這樣您就可以識別將來可能需要使用的時刻邦危。
TornadoFX帶有OSGi運行時所需的元數(shù)據(jù),以檢測和啟用它舍扰。 當tornadofx.jar
加載到OSGi容器中時铡俐,會在運行時自動安裝多個服務(wù)。 這些服務(wù)使我們能夠討論一些非常有趣的功能妥粟。
OSGi 簡介
在繼續(xù)本章之前,請先熟悉OSGi的基礎(chǔ)知識吏够。 要快速了解OSGi技術(shù)勾给,您可以查看OSGi聯(lián)盟網(wǎng)站(OSGi Alliance website)上的教程 (tutorials)。 Apache Felix教程(Apache Felix tutorials)也是基本OSGi模式的良好參考起點锅知。
服務(wù)(Services)
當TornadoFX JAR加載時播急,您可以創(chuàng)建自己的TornadoFX軟件包(bundle),并以任何您喜歡的方式創(chuàng)建應(yīng)用程序售睹。 然而桩警,一些使用模式是非常典型和有用的,因此TornadoFX具有內(nèi)置的對他們的支持昌妹。
動態(tài)應(yīng)用(Dynamic Applications)
OSGi的動態(tài)性質(zhì)一般適用于GUI應(yīng)用程序捶枢。 隨著環(huán)境的變化,具有某些功能的加入或撤出( come and go)的能力可以很強大飞崖。 不幸的是烂叔,JavaFX本身是以一種防止在初始的應(yīng)用程序關(guān)閉后啟動另一個JavaFX應(yīng)用程序的方式編寫的。 為了規(guī)避這個缺點固歪,您可以根據(jù)需要停止和啟動應(yīng)用程序蒜鸡,TornadoFX提供了一種使用應(yīng)用程序代理(application proxy)注冊App
類的方法,即使在您的應(yīng)用程序關(guān)閉時牢裳,也能保持JavaFX環(huán)境運行逢防。
要開始,可以實現(xiàn)一個BundleActivator
蒲讯,它提供start()
和stop()
一個App
的方法 忘朝。 您的bundle的 Activator
中,可以通過調(diào)用context.registerApplication
來注冊您的應(yīng)用程序的這個功能判帮,并使用您的App
類作為單個參數(shù)完成:
class Activator : BundleActivator {
override fun start(context: BundleContext) {
context.registerApplication(MyApp::class)
}
override fun stop(context: BundleContext) {
}
}
如果您更喜歡使用OSGi聲明性服務(wù)(declarative services)辜伟,下面的方式會具有相同的效果氓侧,只要您加載了OSGi DS軟件包:
@Component
class AppRegistration : ApplicationProvider {
override val application = MyApp::class
}
如果您的容器中提供了TornadoFX軟件包,這足以在軟件包激活后自動啟動應(yīng)用程序导狡。 您現(xiàn)在可以通過停止或啟動軟件包(bundle)來停止并啟動多次你的應(yīng)用约巷。
動態(tài)樣式表
要為其他TornadoFX軟件包提供類型安全的樣式表(type-safe stylesheets),您可以通過在Activator
中注冊他們:
class Activator : BundleActivator {
override fun start(context: BundleContext) {
context.registerStylesheet(Styles::class)
}
override fun stop(context: BundleContext) {
}
}
使用OSGi聲明式服務(wù)(Declarative Services)旱捧,注冊如下所示:
@Component
class StyleRegistration : StylesheetProvider {
override val stylesheet = Styles::class
}
每當加載此bundle時独郎,每個活動View
都將應(yīng)用此樣式表。 該bundle卸載后枚赡,樣式表也將自動刪除氓癌。 如果要根據(jù)相同的樣式類(style classes)提供多個樣式表(multiple stylesheets),最好創(chuàng)建一個導(dǎo)出cssclass
定義的bundle贫橙,以便您的Views
可以引用這些樣式贪婉,并且樣式表包(stylesheet bundles)可以根據(jù)它們創(chuàng)建選擇器(selectors)。
動態(tài)視圖
OSGi的一個很酷的方面是在UI元素可用時就彈出UI元素的能力卢肃。 典型的用例是“儀表板(dashboard)”應(yīng)用程序疲迂。 在此示例中,基礎(chǔ)應(yīng)用程序包(base application bundle)包含可以保存其他視圖(Views)的View
莫湘,并告訴TornadoFX OSGi運行時(Runtime)尤蒿,如果符合特定條件,它將自動嵌入視圖(Views)幅垮。
例如腰池,我們可以創(chuàng)建一個包含VBox
的View
。 我們告訴TornadoFX OSGi運行時忙芒,我們希望將其他視圖(Views)嵌入其中示弓,如果它們使用了discriminator
儀表板(dashboard)標記:
class Dashboard : View() {
override val root = VBox()
init {
title = "Dashboard Application"
addViewsWhen { it.discriminator == "dashboard" }
}
}
如果addViewsWhen
函數(shù)返回true
,則將View
添加到VBox
呵萨。 要提供對此儀表板(Dashboard)的視圖(Views)避乏,另一個包(bundle)可以聲明它要通過設(shè)置dashboard
discriminator導(dǎo)出它的視圖。 在這里甘桑,我們注冊一個虛構(gòu)的MusicPlayer
視圖拍皮,當它的包(bundle)變?yōu)榛顒訒r,就會被放置在儀表板中( docked into the dashboard)跑杭。
class Activator : BundleActivator {
override fun start(context: BundleContext) {
context.registerView(MusicPlayer::class, "dashboard")
}
override fun stop(context: BundleContext) {
}
}
再次铆帽,導(dǎo)出視圖的OSGi Declarative Services方式如下所示:
@Component
class MusicPlayerRegistration : ViewProvider {
override val discriminator = "dashboard"
override fun getView() = find(MusicPlayer::class)
}
addViewsWhen
函數(shù)足夠聰明以檢查VBox
并找出如何添加子視圖。 還可以看出德谅,如果您在TabPane
上調(diào)用該函數(shù)爹橱,它將創(chuàng)建一個新的Tab
并將標題設(shè)置為子視圖的標題等。如果您想使用所提供的視圖進行自定義窄做,則可以從函數(shù)返回false
愧驱,以便不會自動添加子視圖慰技,然后就可以執(zhí)行所需的任何操作。 即使Tab
示例是開箱即用的组砚,您也可以明確地這樣做:
tabPane.addViewsWhen {
if (it.discriminator == "dashboard") {
val view = it.getView()
tabPane.tab(view.title, view.root)
}
false
}
手動處理動態(tài)視圖
創(chuàng)建您的第一個OSGi包
一個好的起點是TornadoFX IntelliJ IDEA插件中的tornadofx-maven-osgi-project
模板吻商。 這包含從您的源代碼來構(gòu)建OSGi軟件包所需的一切。 OSGI IDEA插件使得從IDE直接設(shè)置和運行OSGi容器非常容易糟红。 https://www.youtube.com/watch?v=liOFCH5MMKK上有一個屏幕截圖艾帐,顯示了這些概念的運用。
OSGi控制臺
TornadoFX有一個內(nèi)置的OSGi控制臺盆偿,您可以從中檢查軟件包柒爸,更改其狀態(tài),甚至通過拖放來安裝新的軟件包事扭。 您可以使用Alt-Meta-O
打開控制臺捎稚,或通過設(shè)置FX.osgiConsoleShortcut
或以編程方式打開OSGIConsole View
來配置其他快捷方式。
要求
要在OSGi容器中運行TornadoFX求橄,需要加載所需的包(bundles)今野。 通常只是需要將這些jar轉(zhuǎn)儲到容器的bundle
目錄中就行了。 請注意谈撒,要在OSGi容器中使用的任何jar需要“啟用OSGi”(OSGi enabled),這實際上意味著添加一些OSGi特定條目到META-INF/MANIFEST.MF
文件匾南。
我們提供了一個完整的安裝啃匿,其中Apache Felix和TornadoFX已經(jīng)安裝在http://tornadofx.tornado.no/felix-tornadofx-5.4.0.zip 。 記得切換tornadofx.jar
的最新版本蛆楞,因為這個bundle最有可能落后于幾個版本溯乒。
這些是在OSGi容器中運行任何TornadoFX應(yīng)用程序所需的工件。 您的容器可能已經(jīng)與其中的一些捆綁在一起豹爹,因此請檢查容器文檔以獲取更多詳細信息裆悄。
- Kotlin OSGi bundle 包含特定版本的
kotlin-stdlib
和kotlin-reflect
,具有所需的OSGi清單(manifest)信息臂聋。
- Kotlin OSGi bundle 包含特定版本的
- 這鏈接到Apache Felix實現(xiàn)的OSGi配置管理界面(OSGi Config Admin interface)光稼。 隨意使用你的OSGi容器的實現(xiàn)。 某些容器(如Apache Karaf)已經(jīng)裝載了Config Admin bundle孩等,因此您不需要它艾君。