在 Glyn 的 最近的博文 中,他介绍了 OSGi 的“uses”指令。在本篇博文中,我想更深入地探讨 uses 约束冲突的原因,并提供一些诊断应用程序中 uses 问题的技巧。
对于大多数示例,我将使用原始的 Equinox,而不是 dm Server。这样做的原因是 uses 约束并非特定于 dm Server,而是与所有 OSGi 用户相关。在本篇博文的最后,我将演示 dm Server 中内置的一些智能约束失败诊断功能。
依赖约束不匹配
uses 冲突最常见的原因是依赖约束之一或多个不匹配。例如,考虑以下三个清单
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 bundle。显然,这些不是真正的 bundle。 spring bundle 对 eclipselink 包的导入范围为 [1.0, 2.0)。显然,只有 eclipselink_1 bundle 可以满足此约束。现在,考虑来自两个不同应用程序的以下清单
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]。如果我将这些 bundle 安装到 Equinox 中,然后尝试启动 app bundle,控制台将显示如下内容
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 bundle 都已解析。 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 导出。有了这些信息,我们就可以找出 bundle 2 中 spring.orm.hibernate 包的 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 的清单更改为可以接受 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"
安装 bundle 并启动 app bundle 显示此更改产生了很大影响
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 bundle 都可以启动了。不幸的是,还有一个更微妙的问题在等待着我们。根据安装顺序,这组 bundle 仍然可能无法一起运行。为了说明这一点,让我们将 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 约束又回来了。执行上一节中识别的诊断步骤在这里将无济于事,因为不存在依赖约束不匹配——我们知道这是因为第一次这些 bundle 解析得很好。
这里的问题是解析顺序问题。bundle 分成两个不同的块进行安装和解析。第一个块包含 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 无法解析,因为它需要 eclipselink 版本 2.0.0,但 spring 已经连接到版本为 1.0.0 的 eclipselink。当所有 bundle 作为一个块安装和解析时,OSGi 解析器将尝试满足所有约束,包括确保 spring.orm.hibernate 上的 uses 约束可以满足。
要解决此问题,我们不需要更改 bundle。相反,我们可以将 bundle 作为一个块重新安装,或者我们可以针对 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 可以自动诊断大多数这些问题。