每日一得--开发一个简单的 OSGi Web 应用实例

开发一个简单的 OSGi Web 应用实例

一个简单的 Web 应用

我们写一个简单的 Web 应用 compute.html ：计算两个数字的和或乘积。如下图所示：

图 1. 一个简单例子

为了体现 OSGi bundle 的动态部署能力，我们写两个 service bundle，其中一个计算两个数字的和（称为 add bundle），另外一个计算两个数字的积（称为 multiply bundle）。当我们点击“Compute”按钮的时候，如果此时 add bundle 被部署，则页面将返回两个数字的和，否则如果此时 multiply bundle 被部署，则页面将返回两个数字的积。

开发环境准备

下载 Eclipse 3.4
获取所有 OSGi, Equinox 和 Spring 的插件, 如下图所示:

图 2. 相关插件列表

打开 Eclipse, 设置 target platform 为上述插件集合

基本模块设计

该应用主要包含两个层次: 服务层和 Web 层。Web 层基于 Spring-MVC 实现，包含处理 Web访问相关的 bundle（本例中只有一个）。服务层包含处理数字计算的 bundle，本例中包含一个声明服务接口的 compute interface bundle 和两个实现该服务接口的 bundle ：add bundle 和 multiply bundle。基本模块结构如下图所示：

图 3. 基本框架

模块程序实现

Step 1 ：实现 Service Layer

服务层的三个 OSGi bundle 实现完毕之后如下图所示：

图 4. 服务层

服务层.bmp

其中 com.zxn.example.service.compute 是声明服务接口的 bundle。com.zxn.example.service.compute.add和com.zxn.example.service.compute.multiply 是实现了服务接口的两个 bundle。

com.zxn.example.service.compute

声明一个 Compute 接口，其中包含一个接口方法 computeNums（），如下图所示：

图 5. 服务层接口 bundle

com.zxn.example.service.compute.add

bundle com.zxn.example.service.compute.add 的基本程序结构如下图所示：

图 6. 接口实现 bundle ：add

在该 add bundle 中，添加一个 Add 类，实现 Compute 接口，如下图所示：

图 7. 接口实现代码：Add 类

注意到我们在 META-INF 下建了一个 spring 目录，并且添加了一个 computeAdd-context.xml 文件。系统启动时，Spring 将利用该 xml 文件创建一个 bean 实例，并把该 bean 输出为一个 OSGi service，如下图所示：

图 8. Spring 声明文件：computeAdd-context.xml

该xml文件中，osgi : service是 Spring-DM 输出 OSGi service 的标记，其中的 interface属性标明了该 service 实现的服务接口。

com.zxn.example.service.compute.multiply

按照与 add bundle 同样的方法，实现 multiply bundle，如下图所示：

图 9. 接口实现代码：Multiply 类

接口实现代码-Multiply类.bmp

类似的，添加一个 computeMultiply-context.xml 输出 OSGi service，如下图所示：

图 10. Spring 声明文件：computeMultiply-context.xml

Step 2 ：实现 Web Layer

Web 层只包含一个 bundle：com.zxn.example.web，采用 Spring-MVC 和 OSGi 构建，基本程序结构如下图所示：

图 11. Web Layer 程序结构

ComputeControler.java

该JAVA类实现了 org.springframework.web.servlet.mvc.Controller，是本 web应用中核心的 servlet，负责接受并处理 web 请求。该类调用 ComputeServiceRef 的方法实现业务逻辑。该类关键的方法是 handleRequest(…), 如下图所示：

图 12. 核心 servlet 类

ComputeServiceRef.java

该 JAVA 类负责引用部署的 service bundle 完成最终计算，其中的 computeService 由 Spring 根据 OSGi 中实际部署的 service 进行注入。本例中，实际部署的 service 可能是 add bundle 或者 multiply bundle。

需要特别注意的是，此处体现了 Spring-DM 的动态特性。OSGi 的动态部署能力使得 Spring 的动态服务注入成为可能。

图 13. 服务消费类

HTTPContextResgistry.java

该 JAVA 类负责在 OSGi 环境中配置和注册 HTTP 服务，其关键方法为 bean 初始化时调用的 init( ) 方法。

图 14. 在 OSGi 环境中注册 HTTP 服务

该 init 方法中，第六行的 getHTTPService(…) 调用 OSGi 的 ServiceTracker 来获取 OSGi环境中注册的 HTTP 服务的引用，如下图所示：

图 15. 使用 ServiceTracker 获取 HTTP 服务

computeWeb-context.xml

该 xml 文件主要用于配置 HTTPContextResgistry bean 类，以及导入对 Compute 服务接口的引用。标记 osgi : reference 用于声明要导入的服务接口，其 interface 属性标明了该接口的定义，本例中为 com.zxn.example.service.compute.Compute 接口。