OSGi Bundle之Hello World

开发一个简单的Hello World的OSGi Bundle(OSGi绑定包)

在OSGi中，软件是以Bundle的形式发布的。一个Bundle由Java类和其它资源构成，它可为其它的Bundle提供服务，也可以导入其它Bundle中的Java包；同时，OSGi的Bundle也可以为其所在的设备提供一些功能。Eclipse为开发OSGiBundle提供了优秀的支持，它不仅提供了向导来创建OSGi Bundle，而且还提供了内嵌的Equinox容器，您可以使用该容器执行和调试OSGi插件。请注意每一个Eclipse插件，从本质上说，都是一个OSGi Bundle，只是这个OSGiBundle多加了一些Eclipse专用的代码而已。下面我们来看看如何使用Eclipse开发一个简单的OSGi的HelloWorld Bundle。

3.1.新建Bundle

1) 在Eclipse中，点击“File->New->Project”菜单，您将会看到新项目创建对话框；

2) 在新项目对话框中，选择“Plug-inProject(插件项目)”并点击“Next(下一步)”按钮，您将看到插件项目对话框；

3) 在插件项目对话框中，请键入下列值：

Project Name(项目名称)：com.javaworld.sample.HelloWorld

Target Platform(目标平台)：an OSGiFramework->Standard （OSGi框架->标准）

4) 对其它的要求输入值采用缺省值，并点击“Next(下一步)”按钮，您将会看到插件上下文对话框；

5) 在插件上下文对话框中，请选择缺省值并点击“Next(下一步)”按钮；

6) 在模板对话框中，请选择“Hello OSGiBundle（你好，OSGi包）”模板，然后点击“Finish(完成)”按钮完成该项目。

Eclipse将花几秒钟生成HelloWorld Bundle模板代码，它将新建两个文件：Activator.java和MANIFEST.MF，下面，让我们看看这两个文件：

3.1.1. Activator.java文件

源代码清单1.Activator.java

1. package com.javaworld.sample.helloworld;
2. importorg.osgi.framework.BundleActivator;
3. importorg.osgi.framework.BundleContext;
4. publicclass Activator implements BundleActivator {
5. publicvoid start(BundleContext context)throws Exception {
6. System.out.println("Helloworld");
7. }
8. publicvoid stop(BundleContext context)throws Exception {
9. System.out.println("GoodbyeWorld");
10. }
11. }

如果您想让您开发的Bundle能在其启动或关闭时通知自身，那么您应新建一个类，让它实现BundleActivator接口，同时，您还需要遵行下列规则：

这个实现了BundleActivator接口的类必须有一个public的、不带参数的构造函数，这样，OSGi框架就能调用该类的Class.newInstance()方法创建这个BundleActivator对象；

容器将调用Activator类的start()方法来启动Bundle，因此，我们可以在start()方法中执行一些资源初始化的操作，例如，我们可以在该方法中获取数据库连接，以备后用。这个start()方法的唯一参数是一个BundleObject对象，Bundles可以通过该对象和OSGi框架通讯，我们可以从该对象中获取OSGi容器相关的一些信息；如果某个Bundle抛出异常，容器将之置为“stopped(已停止)”状态，此时，这个Bundle就不能对外提供服务。

如果我们要关闭一个Bundle，容器将调用Activator类中的stop()方法。因此，我们可在stop()方法中执行一些资源清理任务，比如释放数据库连接。

一旦Activator类准备就绪，您就可以通过MANIFEST.MF文件把该包的合法名称传给容器。下面，我们就看看这个MANIFEST.MF文件。

3.1.2. MANIFEST.MF文件

该文件是Bundle的部署描述文件，其格式和正常JAR文件包中的MANIFEST.MF文件相同，因此它由一系列的属性及这些属性对应的值组成，属性名位于每一行的开头，我们可以称其为属性头。OSGi规范规定，您可以使用属性头向容器描述您的Bundle。您的HelloWorld Bundle的MANIFEST.MF文件看起来应该如清单2所示：

源代码清单2. Hello World Bundle中的MANIFEST.MF文件

1. Manifest-Version:1.0
2. Bundle-ManifestVersion:2
3. Bundle-Name:HelloWorld Plug-in
4. Bundle-SymbolicName:com.javaworld.sample.HelloWorld
5. Bundle-Version:1.0.0
6. Bundle-Activator:com.javaworld.sample.helloworld.Activator
7. Bundle-Vendor:JAVAWORLD
8. Bundle-Localization:plugin
9. Import-Package:org.osgi.framework;version="1.3.0"

我们来看看这个文件中使用的属性头：

Bundle-ManifestVersion

该属性头告诉OSGi容器，本Bundle将遵循OSGi规范，数值2表示本Bundle和OSGi规范第4版本兼容；如果该属性的数值为1，那么则表示本包和OSGi版本3或更早版本兼容。

Bundle-Name

该属性头为本Bundle定义了一个简短的、可以阅读的名称；

Bundle-SymbolicName

这个属性头为本Bundle定义了一个唯一的、非本地化的名字；当您需要从别的Bundles中访问某一指定的Bundle时，您就要使用这个名字。

Bundle-Version

该属性头给出了本Bundle的版本号。

Bundle-Activator

该属性头给出了本Bundle中使用的监听器类名字，这个属性值是可选的。监听器将对Activator中的start()和stop()方法监听。在程序清单2中，该属性头的值为com.javaworld.sample.helloworld.Activator。

Bundle-Vendor

该属性头是对本Bundle发行商的表述。

Bundle-Localization

该属性头包含了本Bundle的本地化文件所在的位置，我们的HelloWorld Bundle中并没有本地化文件，但Eclipse IDE仍自动产生这个属性头

Import-Package

该属性头定义了本Bundle中引入的Java包，我将在本文后面的依赖性管理小节中详细讲解这个问题。现在，HelloWorld Bundle已经准备就绪，让我们来运行并看看它的输出结果。

3.2. 运行Bundle

我在前面提到，Eclipse IDE中有一个内嵌的EquinoxOSGi容器，您可以利用它来执行或调试OSGi Bundle。请按照下面步骤执行刚才的HelloWorld Bundle:

1 ) 单击RunàRun… 菜单(译者注，在Eclipse3.3中，请单击RunàOpen Run Diglog…菜单)；

2) Eclipse会打开“Create,manage and run configuration(新建、管理和运行配置)”对话框，请双击”EquinoxOSGi Framework”按钮，Eclipse将打开运行时配置对话框；

3) 在上面的对话框中，将Name(名称)输入框的值改为HelloWorld Bundle；

4) 您会注意到在Workspace插件目录下，有一个名为com.javaworld.sample.HelloWorld的插件，请选中它；在TargetPlatform(目标平台)下，请确保org.eclipse.osgi插件被选中。您的Run(运行)对话框应该看起来如图1所示：

图1. HelloWorld Bundle的运行配置

5) 现在，请单击Run(运行)按钮，您应该看到控制台视图上打印出“HelloWorld”。其实，Eclipse是在控制台视图中打开OSGi控制台。

3.2.1. OSGi控制台

OSGi控制台是OSGi容器的命令行界面，您可以在这个控制台上启动、停止、安装、更新和删除Bundles。在EclipseIDE中，请点击该控制台视图获得焦点，然后按回车键，这时您可以看到OSGi提示符，如图2所示：(译者注，在Eclipse3.3中，如果您没有看到OSGi提示符，请在图1的运行配置中，点击Arguments标签，然后在ProgramArguments(程序参数)输入框中键入“-console”，然后再次运行该Bundle)。

图2. OSGi控制台和HelloWorldActivator.java

下面是几个经常使用的OSGi命令，您可以使用这些命令与OSGi容器进行交互。

1. ss: 该命令显示所有已安装的Bundles及它们的状态，它将显示Bundle ID，Bundle的简短名称及Bundle状态；
2. start<bundleid>: 该命令将启动一个Bundle；
3. stop<bundleid>: 该命令将停止一个Bundle；
4. update<bundleid>: 该命令使用新的JAR文件更新一个Bundle；
5. install<bundleid>: 该命令将一个新的Bundle安装到OSGi容器；
6. uninstall<bundleid>: 从OSGi容器中卸载一个已安装的Bundle。

请注意，这些命令是OSGi规范中规定的，因此，您可以使用它们和任何OSGi容器交互。

读到这里，希望您对OSGi Bundle的开发有了一个大致的了解。