OSGI –模塊化您的應用程序

由于我是模塊化，低耦合，高凝聚力等的大力擁護者，所以……
我相信這項技術是我們使用Java平臺創建應用程序的突破。使用OSGi，創建高度可擴展的應用程序非常簡單，例如參見Eclipse IDE。我的目的不是要深入展示該技術的工作原理，而是要舉例說明其某些優勢。該示例包含一個用于發送消息的系統。用戶在TextField中鍵入消息，然后可以通過多種方式發送此消息，例如Email或SMS。但是，在此示例中，我們有四個模塊。圖形用戶界面，域，電子郵件的發件人以及通過SMS的發件人。

遵循OSGi的術語，每個模塊都是一個捆綁包。捆綁包不過是一個“罐子”，其中包含MANIFEST.MF的一些附加信息。此信息由OSGi框架使用。就像Java中的幾乎所有內容一樣，OSGi技術是一種規范，因此有不同的實現方式可供選擇。其中包括最著名的Equinox（Eclipse項目），Felix（Apache）和Knopflerfish。在本文中，我們將使用Equinox。

下載Equinox。對于本文，我們只需要jar。運行jar來訪問Equinox的控制臺。

C:\osgi>java -jar org.eclipse.osgi_3.5.1.R35x_v20090827.jar –console

要查看已安裝的捆綁包，只需鍵入命令ss。

C:\osgi>java -jar org.eclipse.osgi_3.5.1.R35x_v20090827.jar – console
osgi> ss

框架啟動。

id State Bundle<
0 ACTIVE org.eclipse.osgi_3.5.1.R35x_v20090827
osgi> _

正如我們現在所看到的，我們僅安裝了一個捆綁軟件。春分包。
現在，我們將創建捆綁包并將其添加到Equinox。創建捆綁包非常簡單。使用以下類創建一個簡單的項目：

package br.com.luiscm.helloworld;import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;public class Activator implements BundleActivator {/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)*/public void start(BundleContext context) throws Exception {System.out.println("Hello World!");}/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)*/public void stop(BundleContext context) throws Exception {System.out.println("Good Bye World!");}
}

此類是我們捆綁軟件的激活器。 OSGi框架使用Activator來啟動或停止捆綁軟件。在第一個示例中，激活器僅在啟動和停止時才打印消息。現在，我們需要修改jar的清單以使其成為OSGi捆綁包。

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: LuisCM Plug-in
Bundle-SymbolicName: br.com.luiscm.helloworld
Bundle-Version: 1.0.0
Bundle-Activator: br.com.luiscm.helloworld.Activator
Bundle-ActivationPolicy: lazy
Bundle-RequiredExcutionEnvironment: JavaSE-1.6
Import-Package: org.osgi.framework;version=”1.3.0?

請參閱傳遞給OSGi捆綁軟件的清單，以了解我們的一些信息。其中包括束的名稱（SymbolicName）和Activator類。現在，讓我們在Equinox中安裝此捆綁包。生成項目的jar并將其安裝在Equinox中很簡單：

install file:.jar
osgi> install file:bundle.jar
Bundle id is 1
osgi>

要驗證捆綁軟件是否已正確安裝，只需運行命令ss：

osgi> ss
Framework is launched.
id State Bundle
0 ACTIVE org.eclipse.osgi_3.5.1.R35x_v20090827
1 INSTALLED br.com.luiscm.helloworld_1.0.0
osgi> _

該捆綁軟件已正確安裝，您現在就可以啟動它：

start
osgi> start 1
Hello World!
osgi>

要停止捆綁包：

osgi> stop 1
Goodbye World!
osgi>

現在我們知道如何創建捆綁包，讓我們開始示例。在示例中，我們有四個捆綁包。

*域：顧名思義，它在我們的示例中存儲域類。我們將有兩個類：Message和IMessageSender。
* SenderSMS：通過短信發送消息的IMessageSender實現。
* SenderEmail：通過電子郵件發送消息的IMessageSender實現。 * UI：GUI示例

捆綁用戶界面

我們將從UI捆綁包開始。激活器將僅構建框架供用戶輸入消息。

package br.com.luiscm.helloworld;import java.awt.BorderLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JTextField;import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;import br.com.luiscm.helloworld.core.service.Message;public class Activator implements BundleActivator {private Message message;private JFrame frame;/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)*/public void start(BundleContext context) throws Exception {buildInterface();}/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)*/public void stop(BundleContext context) throws Exception {destroyInterface();}private void destroyInterface() {frame.setVisible(false);frame.dispose();}private void buildInterface() {frame = new JFrame("Hello");frame.setSize(200, 80);frame.getContentPane().setLayout(new BorderLayout());final JTextField textField = new JTextField();final JButton button = new JButton("Send");button.addActionListener(new ActionListener() {@Overridepublic void actionPerformed(ActionEvent event) {message.send(textField.getText());}});frame.getContentPane().add(textField, BorderLayout.NORTH);frame.getContentPane().add(button, BorderLayout.SOUTH);frame.setVisible(true);}
}

請注意，該捆綁包取決于一個稱為Message的類。此類是我們的領域，因此不屬于捆綁包。這是OSGi的另一個細節。通過服務捆綁進行通信。我們可以將此模型視為VM中的SOA。服務包UI將使用包核心。讓我們看一下MANIFEST包UI。

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: UI Plug-in
Bundle-SymbolicName: br.com.luiscm.helloworld.ui<
Bundle-Version: 1.0.0
Bundle-Activator: br.com.luiscm.helloworld.ui.Activator
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: br.com.luiscm.helloworld.core.service,
javax.swing,
org.osgi.framework;version=”1.3.0?,
org.osgi.util.tracker;version=”1.3.6?

請參閱Import-Package語句。我們正在導入軟件包捆綁包核心。此程序包中包含我們領域提供的服務。還要導入javax.swing包。

現在我們需要創建服務。

捆綁核心

核心捆綁包有兩個域類。發件人的界面和“消息”字段。

接口：

package br.com.luiscm.helloworld.core.service;public interface IMessageSender {void send(String message);
}

域：

package br.com.luiscm.helloworld.core.service;import java.util.ArrayList;
import java.util.List;public class Message {private final List services = new ArrayList();public void addService(final IMessageSender messageSender) {services.add(messageSender);}public void removeService(final IMessageSender messageSender) {services.remove(messageSender);}public void send(final String message) {for (final IMessageSender messageSender : services) {messageSender.send(message);}}
}

請參閱Message類，其中包含服務列表。這些服務是要使用的消息的發送者。請注意，send方法僅在郵件列表消息上交互。到目前為止，一切都非常簡單。現在，我們需要將Message類導出為核心服務包。 UI模塊將直接與此服務交互以發送消息。

首先，我們需要告訴它將OSGi捆綁包導出到其他捆綁包。參見清單：

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Helloworld Plugin
Bundle-SymbolicName: br.com.luiscm.helloworld.core
Bundle-Version: 1.0.0
Bundle-Activator: br.com.luiscm.helloworld.core.Activator
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: org.osgi.framework;version=”1.3.0?,
org.osgi.util.tracker;version=”1.3.6?
Export-Package: br.com.luiscm.helloworld.core.service

請參閱信息導出包。為了使一個類對于另一個捆綁包可見，必須將其導出到包中。在本例中，UI需要捆綁Message類，因此我們需要將包導出到該類所在的位置。請記住，UI導入了捆綁包。

消息要將組件注冊為服務，我們需要直接與OSGi API進行交互。啟動核心捆綁包后，我們將在OSGi上下文中注冊服務。代碼很簡單：

package br.com.luiscm.helloworld.core;import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;public class Activator implements BundleActivator {/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)*/public void start(BundleContext context) throws Exception {context.registerService(Message.class.getName(), messageService, null);}/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)*/public void stop(BundleContext context) throws Exception {messageService = null;}
}

方法registerService期望參數為服務名稱（建議使用類名稱），服務本身以及一些其他設置。

現在，我們需要更改UI以使用捆綁消息服務。在bundle activator UI中，只需使用您的名字（類名）進行查找服務即可：

private Message message;private JFrame frame;private ServiceTracker serviceTracker;/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)*/public void start(BundleContext context) throws Exception {serviceTracker = new ServiceTracker(context, Message.class.getName(), null);serviceTracker.open();message = (Message)serviceTracker.getService();buildInterface();}/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)*/public void stop(BundleContext context) throws Exception {destroyInterface();serviceTracker.close();}
}

如果將兩個捆綁軟件添加到Equinox中，則會看到兩個捆綁軟件正在通信。現在，我們需要創建實際發送消息的包。

捆綁發件人電子郵件和短信

通過電子郵件和SMS的運輸服務將是我們系統中的新服務。因此，我們為每個創建一個包。這樣我們可以分別控制它們。例如，我們可以通過發送短信來停止服務，而只留下電子郵件，而不會影響系統運行。這兩個捆綁包實際上具有相同的結構，因此我將在此處保存一些行。

發件人只有一個實現接口的捆綁軟件類和IMessageSender Activator類。該界面位于核心捆綁包中，因此我們需要以與捆綁包UI中相同的方式導入包。

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-name: SMS Plug-in
Bundle-SymbolicName: br.com.luiscm.helloworld.sms.Activator<
Bundle-Version: 1.0.0
Bundle-Activator: br.com.luiscm.helloworld.sms.Activator
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: br.com.luiscm.helloworld.core.service,
org.osgi.framework;version=”1.3.0?

Sender唯一的類實現我們的接口：

package br.com.luiscm.helloworld.sms;import br.com.luiscm.helloworld.core.service.IMessageSender;public class MessageSenderSMS implements IMessageSender {@Overridepublic void send(final String message) {System.out.println("Sending by SMS : " + message);}
}

通過短信發送是我們系統的一項服務。因此，我們必須在OSGi上下文中注冊它：

public class Activator implements BundleActivator {private IMessageSender service;/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)*/public void start(BundleContext context) throws Exception {service = new MessageSenderSMS();context.registerService(IMessageSender.class.getName(), service, null);}/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)*/public void stop(BundleContext context) throws Exception {service = null;}
}

郵件束實際上是相同的代碼。唯一的區別是System.out上的消息。

請注意，已使用接口名稱注冊了該服務。因此，現在我們有兩個具有相同名稱的服務。每當我們要求使用接口名稱的服務上下文時，他都會執行邏輯優先級以僅返回一個實現。

現在我們有兩個用于發送消息的服務，我們需要更改我們的包核心以使用它們。為了實現此目標，請使用ServiceTrackerCustomizer。

ServiceTrackerCustomizer和ServiceTracker

如我們所見，我們曾經做Servicetrack查找服務。但是，對于發送者，我們需要知道何時有新的發送者服務可用或何時刪除發送者。此信息對于在Message對象中提供服務列表很重要。

要訪問此信息，我們使用ServiceTrackerCustomizer。代碼很簡單：

package br.com.luiscm.helloworld.core;import org.osgi.framework.BundleContext;public class MessageSenderServiceTracker implements ServiceTrackerCustomizer {private final BundleContext context;private final Message message;public MessageSenderServiceTracker(final BundleContext context, final Message message) {this.context = context;this.message = message;}@Overridepublic Object addingService(final ServiceReference serviceReference) {final IMessageSender sender = (IMessageSender)context.getService(serviceReference);message.addService(sender);System.out.println("tracker : " + sender.getClass().getName());return sender;}@Overridepublic void removedService(final ServiceReference serviceReference, Object service) {final IMessageSender sender = (IMessageSender)context.getService(serviceReference);message.removeService(sender);}
}

只需實現接口，并在添加，修改或刪除服務時根據需要編寫ServiceTrackerCustomizer代碼即可。簡單！

在我們的情況下，我們將在Message對象的服務列表中添加或刪除服務。也有一條“日志”消息，以幫助我們進行測試。

現在，我們需要對bundle核心激活器進行另一項較小的更改。我們必須將ServiceTrackerCustomizer注冊為諸如IMessageSender之類的服務的偵聽器。

public class Activator implements BundleActivator {public Message messageService = new Message();private ServiceTracker messageSenderServiceTracker;/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)*/public void start(BundleContext context) throws Exception {context.registerService(Message.class.getName(), messageService, null);final MessageSenderServiceTracker serviceTracker = new MessageSenderServiceTracker(context, messageService);messageSenderServiceTracker = new ServiceTracker(context, IMessageSender.class.getName(), serviceTracker);messageSenderServiceTracker.open();}/** (non-Javadoc)* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)*/public void stop(BundleContext context) throws Exception {messageSenderServiceTracker.close();messageService = null;}
}

我們將ServiceTrackerCustomizer與ServiceTtracker一起使用。在添加，修改或刪除服務的地方，將調用我們的組件。

測試應用程序

現在我們進行編碼，我們測試應用程序。

創建四個罐子：

* bundleCore.jar
* bundleUI.jar
* bundleSenderEmail.jar * bundleSenderSMS.jar

在Equinox中安裝四個捆綁包：

框架啟動。

id State Bundle
0 ACTIVE org.eclipse.osgi_3.5.1.R35x_20090827.jar
osgi> install file:bundleCore.jar
Bundle id is 5
osgi> install file:bundleUI.jar
Bundle id is 6
osgi> install file:bundleSenderEmail.jar
Bundle id is 7
osgi> install file:bundleSenderSMS.jar
Bundle id is 8
osgi> ss

框架啟動。

0 ACTIVE org.eclipse.osgi._3.5.1.R35x_v20090827.jar
5 INSTALLED br.com.luiscm.helloworld.core_1.0.0
6 INSTALLED br.com.luiscm.helloworld.ui_1.0.0
7 INSTALLED br.com.luiscm.helloworld.email_1.0.0
8 INSTALLED br.com.luiscm.helloworld.sms_1.0.0

啟動捆綁包并測試應用程序。

C:\osgi>java -jar org.eclipse.osgi._3.5.1.R35x_v20090827.jar -console
osgi> tracker: br.com.luiscm.heloworld.sms.SenderSMStracker: br.com.luiscm.helloworld.email.SenderEmail

查看通過電子郵件和SMS發送的消息。在控制臺Equinox中，暫停服務電子郵件：