OSGiサービスとしてのAPI
モジュール とは何か、そしてそれをデプロイする方法を学んだら、モジュールを使用して API を定義し、実装することができます。 Liferay API は OSGi サービスであり、Java インターフェースによって定義され、具体的な Java クラスによって実装されます。
Liferayは、API、実装、およびクライアントをコンポーネントとして公開します。 OSGi Declarative Service(DS)アノテーションは、コンポーネントとそれらの関係を定義します。
@ProviderTypeは、コンポーネントが提供(実装)または消費できるインターフェースを定義します。@Componentは、クラスをコンポーネントとして宣言し、特定の機能を提供します。@Referenceは、別のコンポーネントをクラスメンバー (通常はフィールド) に接続します。
APIと実装に関する懸念事項を異なるモジュールに分離することができます。
- API モジュール は、Java インターフェースを使用して 機能を定義します。 モジュールはインターフェースパッケージをエクスポートします。
- 実装 モジュール は、具体的な Java クラスを使用して 機能を提供します。
ここでは、単純なgreeter OSGiサービスを作成するAPIと実装モジュールをデプロイします。 また、実装モジュールとそのJARを調べて、実装することでgreeterサービス機能がどのように提供されるかを学習します。 次のチュートリアルでは、UI で呼び出すことができるクライアント—を作成します。
シンプルなAPIと実装をデプロイする
新しいLiferay インスタンスを起動し、以下を実行します。
docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.132-ga132
http://localhost:8080 で Liferay にサインインしてください。 メールアドレス test@liferay.com とパスワード test を使用してください。 プロンプトが表示されたら、パスワードを learn に変更してください。
次に、以下の手順に従ってサンプルモジュールを起動してください。
-
liferay-p9g2.zipをダウンロードして解凍します。curl https://resources.learn.liferay.com/examples/liferay-p9g2.zip -Ounzip liferay-p9g2.zip -
プロジェクトのルートフォルダからモジュールをデプロイします。
cd liferay-p9g2./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq) -
Dockerコンテナコンソールでモジュールの起動を確認してください。
com.acme.p9g2.api_1.0.0 を開始しました com.acme.p9g2.impl_1.0.0 を開始しました -
http://localhost:8080にアクセスしてサインインしてください。 -
Gogo Shell へ移動してください。
-
lbGogo Shell コマンドを使用してモジュール ID を取得します。う! lb | grep -i "Acme P9G2"出力:
1150|アクティブ | 15|Acme P9G2 API (1.0.0)|1.0.0 1151|アクティブ | 15|Acme P9G2 実装 (1.0.0)|1.0.0 -
以下のコマンドを実行し、数値をモジュールのIDに置き換えて、実装モジュールのサービス機能を一覧表示します。
う! 検査機能サービス 1195出力:
com.acme.p9g2.impl_1.0.0 [1151] は以下を提供します: ----------------------------------------- サービス; com.acme.p9g2.Greeter プロパティ: service.id = 22933 service.bundleid = 1151 service.scope = bundle component.name = com.acme.p9g2.internal.P9G2Greeter component.id = 8462
Acme P9G2実装モジュールは、1つのサービスを提供します: com.acme.p9g2.Greeter。 component.name プロパティは、モジュールの com.acme.p9g2.internal.P9G2Greeter コンポーネントがサービスを実装していることを示します。
P9G2Greeter コンポーネントが Greeter サービスを提供することを確認しました。
次に、APIモジュールがどのようにグリーター機能を定義し、実装モジュールがどのようにグリーター機能をOSGiサービスとして提供するかを学びます。 まずはAPIの作成から始めましょう。
APIを作成する
APIはたった2つのステップで作成できます。
機能を定義する
サンプル API モジュール Greeter クラスは Java インターフェースです。
@ProviderType
public interface Greeter {
@ProviderType アノテーションは、コンポーネントが実装または使用できる型として Greeter を登録します。
greet メソッドは、名前 文字列 を入力として受け取ります。
public void greet(String name);
グリーター 機能が定義されました。
インターフェースパッケージをエクスポートする
API モジュール bnd.bnd ファイルはモジュールを記述し、 com.acme.p9g2 インターフェース パッケージをエクスポートします。
バンドル名: Acme P9G2 API
バンドルシンボル名: com.acme.p9g2.api
バンドルバージョン: 1.0.0
エクスポートパッケージ: com.acme.p9g2
パッケージエクスポート は、 Greeter インターフェースを他のモジュールと共有します。
グリーター サービスタイプは実装および使用できます。
実装を作成する
サンプル実装モジュールには、 グリーター 機能を提供する具体的な Java クラスが含まれています。 以下に実装手順を示します。
コンポーネント注釈を追加する
P9G2Greeter クラスは、 Greeter インターフェースを実装します。
@Component(service = Greeter.class)
public class P9G2Greeter implements Greeter {
@Component アノテーションとその service = Greeter.class 属性により、 P9G2Greeter クラスは Greeter サービス プロバイダになります。
インターフェースを実装する
Greeter インターフェースは、 greet(String) メソッドを定義し、 void 戻り値を持ちます。
@Override
public void greet(String name) {
System.out.println("Hello " + name + "!");
}
例 greet メソッドは、指定された名前を使用して熱烈な挨拶を出力します。
APIへの依存関係を追加する
ここに実装モジュール build.gradle ファイルがあります。
dependencies {
compileOnly group: "com.liferay.portal", name: "release.dxp.api"
compileOnly project(":p9g2-api")
}
コンパイル時に p9g2-api モジュール プロジェクトへの依存関係が含まれます。これは、モジュールの Greeter クラスを必要とするためです。
モジュールJARを調べます
p9g2-impl/build/libs/com.acme.p9g2.impl-1.0.0.jar 実装モジュール JAR をビルドすると、 Bnd によって JAR の /META-INF/MANIFEST.MF ファイルが生成されます。
以下は、Bndがマニフェストに生成する主要なサービス関連ヘッダーです。
Import-Package: com.acme.p9g2;version="[1.0,2)"
Import-Package ヘッダーは、 Greeter サービス定義を含む API モジュールのパブリック パッケージをインポートします。
Provide-Capability: osgi.service;objectClass:List<String>="com.acme.p9
g2.Greeter";uses:="com.acme.p9g2"
Provide-Capability ヘッダーは、 P9G2Greeter コンポーネント サービスを構成します。
サービスコンポーネント: OSGI-INF/com.acme.p9g2.internal.P9G2Greeter.xml
Service-Component ヘッダーには、モジュールの各サービス コンポーネントの構成ファイル (.xml) がリストされています。
モジュールをデプロイすると、サービス コンポーネント ランタイムは、 P9G2Greeter サービス コンポーネントを Greeter サービスを提供するものとして登録します。
結論
Greeterというサービス機能を定義し、P9G2Greeterというサービスコンポーネントで提供しました。 グリーター サービスが開始されました。 顧客はどのようにしてサービスにアクセスし、利用するのですか? これは OSGi サービスの使用 で実証されています。