在他的近期部落格文章中,Glyn 介紹了 OSGi "uses" 指令。在這篇部落格中,我想更深入地探討 uses 約束違規的原因,並提供一些診斷應用程式中 uses 問題的技巧。
對於大多數範例,我將使用原始的 Equinox,而不是 dm Server。原因在於 uses 約束並非 dm Server 所獨有,而是與所有 OSGi 使用者相關。在這篇部落格的最後,我將示範 dm Server 內建的一些智慧約束失敗診斷功能。
相依約束不符
uses 違規最常見的原因是一個或多個相依約束之間的不匹配。舉例來說,請考慮以下三個 manifest 檔案
Manifest-Version: 1.0
Bundle-Name: Spring Bundle
Bundle-ManifestVersion: 2
Bundle-SymbolicName: spring
Bundle-Version: 2.5.5
Export-Package: spring.orm.hibernate;version="2.5.5";uses:="eclipselink"
Import-Package: eclipselink;version="[1.0, 2.0)"
Manifest-Version: 1.0
Bundle-Name: EclipseLink 1 Bundle
Bundle-ManifestVersion: 2
Bundle-SymbolicName: eclipselink
Bundle-Version: 1
Export-Package: eclipselink;version="1.0.0"
Manifest-Version: 1.0
Bundle-Name: EclipseLink 2 Bundle
Bundle-ManifestVersion: 2
Bundle-SymbolicName: eclipselink
Bundle-Version: 2
Export-Package: eclipselink;version="2.0.0"
在這裡您可以看到一個 spring bundle 和兩個 eclipselink bundles。顯然,這些不是真正的 bundles。spring bundle 匯入了 eclipselink 套件,範圍為 [1.0, 2.0)。顯然,只有 eclipselink_1 bundle 可以滿足這個約束。現在,請考慮來自兩個不同應用程式的這些 manifest 檔案
Manifest-Version: 1.0
Bundle-Name: App1 Bundle
Bundle-ManifestVersion: 2
Bundle-SymbolicName: app1
Bundle-Version: 1.0.0
Import-Package: spring.orm.hibernate,eclipselink;version="[1.0, 1.0]"
Manifest-Version: 1.0
Bundle-Name: App2 Bundle
Bundle-ManifestVersion: 2
Bundle-SymbolicName: app2
Bundle-Version: 1.0.0
Import-Package: spring.orm.hibernate,eclipselink;version="[2.0, 2.0]"
在這裡我們可以看到 app1 匯入了 eclipselink,範圍為 [1.0, 1.0],而 app2 匯入了 eclipselink,範圍為 [2.0, 2.0]。如果我將這些 bundles 安裝到 Equinox 中,然後嘗試啟動 app bundles,則主控台會顯示類似以下內容
id State Bundle
0 ACTIVE org.eclipse.osgi_3.4.0.v20080605-1900
2 RESOLVED spring_2.5.5
3 RESOLVED eclipselink_1.0.0
4 RESOLVED eclipselink_2.0.0
5 ACTIVE app1_1.0.0
6 INSTALLED app2_1.0.0
在這裡我們可以看到 spring 和 eclipselink bundles 都已解析。app1 bundle 已經啟動,但是 app2 bundle 無法啟動。要找出原因,我們可以使用 diag 命令
osgi> diag app2
file:/Users/robharrop/dev/resdiag/uses/app2/bin [6]
Package uses conflict: Import-Package: spring.orm.hibernate; version="0.0.0"
在這裡我們可以看到 app2 bundle 無法解析,因為它的 spring.orm.hibernate 匯入存在套件 uses 衝突。這表示 app2 中 spring.orm.hibernate 的匯入無法滿足,因為它的其他匯入之一與 _可以_ 提供 spring.orm.hibernate 的 bundle 上的 uses 約束衝突 - 在這種情況下是 spring bundle。
診斷的第一步是找出 spring.orm.hibernate bundle 的可能提供者。從我們的用例中我們知道唯一可能的提供者是 spring bundle,但是如果您不知道提供者,您可以使用 packages 命令找到它們
osgi> packages spring.orm.hibernate
spring.orm.hibernate; version="2.5.5"<file:/Users/robharrop/dev/resdiag/uses/spring/bin [2]>
file:/Users/robharrop/dev/resdiag/uses/app1/bin [5] imports
這向我們展示了 spring.orm.hibernate 套件由 bundle 2 匯出。有了這些知識,我們可以找出 spring.orm.hibernate 套件在 bundle 2 的 uses 指令中列出了哪些套件
osgi> headers 2
Bundle headers:
Bundle-ManifestVersion = 2
Bundle-Name = Spring Bundle
Bundle-SymbolicName = spring
Bundle-Version = 2.5.5
Export-Package = spring.orm.hibernate;version="2.5.5";uses:="eclipselink"
Import-Package = eclipselink;version="[1.0, 2.0)"
Manifest-Version = 1.0
在這裡我們可以看到 uses 中唯一的套件是 eclipselink 套件,所以它一定是罪魁禍首。事實上,我們可以知道 Spring bundle 需要 eclipselink,範圍為 [1.0, 2.0),而 app2 需要 eclipselink,範圍為 [2.0, 2.0] - 這兩個範圍是不相交的,這意味著 app2 _無法_ 連接到與 spring bundle 相同的 eclipselink 版本。
如果 uses 列表很長,您可以透過找出哪個列出的套件有多個提供者來縮小可能的違規範圍。必須始終有多個提供者,您才能看到 uses 約束違規。
版本不匹配不是相依約束不匹配的唯一原因。約束可能由於屬性和版本而不匹配。
安裝順序問題
如果我們重新審視先前的範例,並變更 spring bundle 的 manifest 檔案,使其可以接受 eclipselink 套件的 2.0 版,並放寬 app1 上的範圍,使其可以接受 1.0 以上的任何版本,我們應該可以解決這個問題
Manifest-Version: 1.0
Bundle-Name: Spring Bundle
Bundle-ManifestVersion: 2
Bundle-SymbolicName: spring
Bundle-Version: 2.5.5
Export-Package: spring.orm.hibernate;version="2.5.5";uses:="eclipselink"
Import-Package: eclipselink;version="[1.0, 2.0]"
Manifest-Version: 1.0
Bundle-Name: App1 Bundle
Bundle-ManifestVersion: 2
Bundle-SymbolicName: app1
Bundle-Version: 1.0.0
Import-Package: spring.orm.hibernate,eclipselink;version="1.0"
安裝 bundles 並啟動 app bundles 表明此變更產生了很大的不同
id State Bundle
0 ACTIVE org.eclipse.osgi_3.4.0.v20080605-1900
1 RESOLVED spring_2.5.5
2 RESOLVED eclipselink_1.0.0
3 RESOLVED eclipselink_2.0.0
4 ACTIVE app1_1.0.0
5 ACTIVE app2_1.0.0
現在兩個 app bundles 都可以啟動。不幸的是,還有一個更微妙的問題等著我們。根據安裝順序,這組 bundles 仍然可能無法一起執行。為了說明這一點,讓我們將 spring、eclipselink_1 和 app1 作為一個交易安裝,並啟動 app1
id State Bundle
0 ACTIVE org.eclipse.osgi_3.4.0.v20080605-1900
1 RESOLVED spring_2.5.5
2 RESOLVED eclipselink_1.0.0
3 ACTIVE app1_1.0.0
現在,讓我們安裝 eclipselink_2 和 app2
id State Bundle
0 ACTIVE org.eclipse.osgi_3.4.0.v20080605-1900
1 RESOLVED spring_2.5.5
2 RESOLVED eclipselink_1.0.0
3 ACTIVE app1_1.0.0
4 RESOLVED eclipselink_2.0.0
5 INSTALLED app2_1.0.0
app2 bundle 將無法啟動。diag 的輸出告訴我們原因
osgi> diag app2
file:/Users/robharrop/dev/resdiag/uses/app2/bin [5]
Package uses conflict: Import-Package: spring.orm.hibernate; version="0.0.0"
uses 約束又回來了。執行先前章節中識別的診斷步驟沒有幫助,因為沒有相依約束不匹配 - 我們知道這一點,因為第一次這些 bundles 解析得很好。
這裡的問題是解析順序。這些 bundles 分成兩個不同的區塊安裝和解析。第一個區塊包括 spring、eclipselink_1 和 app1,第二個區塊包括 eclipselink_2 和 app2。當第一個區塊解析時(由於啟動 app1 bundle 的結果),spring bundle 會連接到 eclipselink_1 bundle,以匯入 eclipselink 套件。這可以使用主控台確認
osgi> bundle app1
file:/Users/robharrop/dev/resdiag/uses/app1/bin [3]
Id=3, Status=ACTIVE Data Root=/opt/springsource-dm-server-1.0.0.RELEASE/lib/configuration/org.eclipse.osgi/bundles/3/data
No registered services.
No services in use.
No exported packages
Imported packages
spring.orm.hibernate; version="2.5.5"<file:/Users/robharrop/dev/resdiag/uses/spring/bin [1]>
eclipselink; version="1.0.0"<file:/Users/robharrop/dev/resdiag/uses/eclipselink1/bin [2]>
No fragment bundles
Named class space
app1; bundle-version="1.0.0"[provided]
No required bundles
請注意,匯入的套件區段顯示 eclipselink 版本 1.0.0 是從 eclipselink_1 bundle 匯入的。當安裝第二個區塊時,app2 bundle 無法解析,因為它需要版本 2.0.0 的 eclipselink,但 spring 已經連接到版本 1.0.0 的 eclipselink。當所有 bundles 作為一個區塊安裝和解析時,OSGi 解析器將嘗試滿足 _所有_ 約束,包括確保可以滿足 spring.orm.hibernate 上的 uses 約束。
要解決這個問題,我們不需要變更我們的 bundles。相反地,我們可以重新安裝一個區塊中的 bundles,或者我們可以觸發針對 spring bundle 的重新整理 - 有效地要求 OSGi 重新執行解析程序。現在 eclipselink_2 bundle 已經安裝,我們可以預期這會有不同的結果
osgi> refresh spring
osgi> ss
Framework is launched.
id State Bundle
0 ACTIVE org.eclipse.osgi_3.4.0.v20080605-1900
1 RESOLVED spring_2.5.5
2 RESOLVED eclipselink_1.0.0
3 ACTIVE app1_1.0.0
4 RESOLVED eclipselink_2.0.0
5 ACTIVE app2_1.0.0
osgi> bundle spring
file:/Users/robharrop/dev/resdiag/uses/spring/bin [1]
Id=1, Status=RESOLVED Data Root=/opt/springsource-dm-server-1.0.0.RELEASE/lib/configuration/org.eclipse.osgi/bundles/1/data
No registered services.
No services in use.
Exported packages
spring.orm.hibernate; version="2.5.5"[exported]
Imported packages
eclipselink; version="2.0.0"<file:/Users/robharrop/dev/resdiag/uses/eclipselink2/bin [4]>
No fragment bundles
Named class space
spring; bundle-version="2.5.5"[provided]
No required bundles
請注意,重新整理 spring 會導致 app2 bundle 解析。spring 中 eclipselink 套件的連接已變更為由 eclipselink_2 bundle 中版本 2.0.0 的匯出滿足。
dm Server 中的 Uses 約束
當您在 dm Server 中遇到 uses 約束違規時,我們已經嘗試為您執行一些分析步驟,特別是識別可能不匹配的相依約束
Could not satisfy constraints for bundle 'app2' at version '1.0.0'.
Cannot resolve: app2
Resolver report:
Bundle: app2_1.0.0 - Uses Conflict: Import-Package: spring.orm.hibernate; version="0.0.0"
Possible Supplier: spring_2.5.5 - Export-Package: spring.orm.hibernate; version="2.5.5"
Possible Conflicts: eclipselink
Uses 約束在企業程式庫中很常見,手動診斷失敗可能是一場真正的惡夢。特別是,當您有一個匯出的套件,並且在其 uses 子句中列出了 10 個或更多套件時,確定可能的衝突可能非常耗時。因此,自動化診斷是必須的,我希望不斷改進 dm Server 中的診斷程式碼,以便處理常見錯誤變得微不足道。
在下一個版本中,我們計劃將診斷工具直接建置到我們的 dm Server Eclipse 工具中,以便大多數這些問題將由 dm Server 自動診斷。