OSGi neboli Open Service Gateway

OSGi neboli Open Service Gateway initiative je specifikace dynamického modulárního systému pro programovací jazyk Java. V tomto článku si povíme něco o historii OSGi, ukážeme si jednoduchou aplikaci napsanou pomocí OSGi a podíváme se na přidávání a odebírání modulů z aplikace.

Historie

Práce na OSGi specifikaci začala v roce 1999. Původně byla cílena na síťová zařízení a vestavěné systémy a zde se také prosadila a začala využívat. V roce 2003 se vývojářský tým platformy Eclipse rozhodl vyměnit proprietární modulární systém za vlastní implementaci OSGi s názvem Equinox. Dnes už většina aplikačních serverů podporuje nebo plánuje podporu OSGi. OSGi se tak na poli enterprise aplikací stává alternativou k zatím rozšířenější Javě EE. K dalším populárním implementacím OSGi kromě Equinoxu patří také Apache Felix nebo Knopflerfish.

Využití

Hlavní výhoda OSGi při jeho použití k vývoji aplikace je právě modulárnost. Umožňuje nám to za běhu naší aplikace přidávat a odebírat její součásti. Zlepšuje se nám tak udržovatelnost aplikace, například můžeme aktualizovat jednu část aplikace, aniž bychom museli zbylé komponenty této aplikace odpojit z provozu. Mezi další výhody patří také možnost mít zavedeno více verzí jednoho modulu. Pokud máme dvě části aplikace, které závisí na různých verzích jedné knihovny, OSGi nám umožní běh obou verzí zároveň. Každé komponentě bude umožněn přístup pouze ke správné verzi této knihovny.

Dále se budeme věnovat ukázce základní práce s OSGi. Pro demonstraci budeme používat právě výše zmíněný Equinox, který je dodávaný v jednom balíku spolu s Eclipse IDE. Stáhnout si ho můžete třeba z oficiálních stránek. Pro vytvoření nového OSGi modulu si vytvoříme tzv. Plug-In Project.

Bundle

V OSGi se každý jednotlivý modul aplikace označuje jako tzv. bundle, což je obyčejný jar archiv s přidaným hlavičkovým souborem MANIFEST.MF. Při práci s moduly používáme právě tento soubor a nadefinujeme si zde, jaké balíčky importujeme a exportujeme.

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: HelloService
Bundle-SymbolicName: com.bcvsolutions.sample.HelloService
Bundle-Version: 1.0.0.qualifier
Bundle-Activator: com.bcvsolutions.sample.service.impl.HelloServiceActivator
Bundle-Vendor: BCVSOLUTIONS
Bundle-RequiredExecutionEnvironment: JavaSE-1.7
Import-Package: org.osgi.framework;version="1.3.0"
Export-Package: com.bcvsolutions.javaworld.sample.service

Tento soubor obsahuje několik důležitých hlaviček. Mezi pro nás nejdůležitější patří Bundle-Activator, Import-Package a Export-Package. Bundle-Activator označuje tzv. activator třídu. Ta definuje dvě základní metody každého OSGi bundlu start a stop. Tyto metody spouští a ukončují náš bundle. Import-Package nám definuje balíčky, které náš bundle potřebuje. Pokud není bundle obsahující daný balíček přítomný v OSGi kontejneru, není možné náš bundle spustit. Export-Package nám zase definuje balíčky, které dáváme k dispozici jiným bundlům.

Activator třída pak může vypadat například takto.

package com.bcvsolutions.sample.helloservice;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

public class Activator implements BundleActivator {

	public void start(BundleContext context) throws Exception {
		System.out.println("Hello World!!");
	}
	
	public void stop(BundleContext context) throws Exception {
		System.out.println("Goodbye World!!");
	}

}

OSGi kontejner zavolá metodu start při spouštění bundlu. BundleContext je objekt umožnující interakci s frameworkem. Metoda stop je volaná při ukončování bundlu, je vhodné v této metodě provést čistící operace např. odpojení od databáze.

Správa bundlů

Ke správě bundlů v kontejneru nám dobře poslouží OSGi konzole. Můžeme v ní instalovat a odinstalovat bundle, spustit a zastavit bundle nebo si třeba zobrazit všechny bundly dostupné v kontejneru.

osgi> ss
"Framework is launched."


id	State       Bundle
0	ACTIVE      org.eclipse.osgi_3.10.1.v20140909-1633
	            Fragments=603
...
841	RESOLVED    com.bcvsolutions.sample.HelloWorld_1.0.0.qualifier
843	ACTIVE      com.bcvsolutions.sample.HelloService_1.0.0.qualifier

Po vypsání bundlů příkazem ss můžeme vidět dva námi připravené bundly. HelloService je bundle, který exportuje jednu ze svých služeb (viz MANIFEST.MF výše). Zároveň vidíme, že je ve stavu active, což znamená, že je spuštěný v kontejneru. Druhý bundle HelloWorld, který má importovaný balíček z bundlu HelloService, je ve stavu resolved, což značí, že je připraven na spuštění a má vyřešeny veškeré závislosti. Nyní ho můžeme spustit příkazem start.

osgi> start 841
Hello World!!
Inside HelloServiceImple.sayHello()
Say Hello
osgi> stop 841
Goodbye World!!

Vidíme, že balíček byl spuštěn a také, že využívá jedné ze služeb balíčku HelloService. Nakonec jsme bundle zase ukončili příkazem stop.

Životní cyklus bundlu

Životní cyklus OSGi bundlu

Balíček po dobu své funkce projde několika stavy. Po instalaci do frameworku se dostává do stavu installed. Jakmile jsou uspokojeny jeho závislosti přechází do stavu resolved a čeká na spuštění. Při spouštění se dostává do fáze starting, z níž po navrácení metody start přejde do stavu active. Během ukončování je ve stavu stopping a po návratu metody stop se balíček opět navrátí do stavu resolved. Po odinstalaci balíčku se dostává do stavu uninstalled.

Závěr

V tomto příspěvku jsme si ukázali základní práci s OSGi bundly, exportování a importování jednotlivých modulů a základ správy osgi bundlů pomocí konzole.
V případě dotazů mě neváhejte kontaktovat na info@bcvsolutions.eu.