OSGiサービスの使用

LiferayのAPIは、OSGiサービスとしてすぐに利用可能です。 サービスにアクセスするには、そのサービスタイプのフィールドを作成し、そのフィールドに @Referenceという注釈を付けます。例:

@Reference
BlogsEntryService _blogsEntryService;

上記の_blogsEntryServiceフィールドは、BlogsEntryService OSGiサービスにアクセスします。

すべてのDeclarative Servicesコンポーネント（@Componentでアノテーションが付けられたクラス）は、この方法でOSGiサービスにアクセスできます。 ランタイムフレームワークは、コンポーネントの@Referenceのアノテーションが付いたフィールドにサービスタイプを挿入します。

次の例は、Greeterと呼ばれるOSGiサービスの使用を示しています。 3 つのモジュールは、OSGi サービスで使用される API プロバイダー - コンシューマー パターンを示しています。

• API モジュールは、 Greeter サービス タイプを定義します。
• 実装モジュール は グリーター サービスを提供します。
• このサンプルモジュールは、Greeterサービスを利用しています。

サンプルモジュールクラスは、Greeterサービスを使用してパーソナライズされた挨拶を返すGogo シェルコマンドを作成します。 この例をOSGiサービスの「Hello World」と考えてください。

OSGiサービスは任意のJavaクラスで使用できます。

LiferayサービスのJavadocはこちらから入手できます。

注記

OSGi サービスの作成方法については、 API を OSGi サービスとして利用する を参照してください。

Gogo Shellコマンドの例をデプロイする

Liferay の新しいインスタンスを起動するには、次のコマンドを実行します。

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.132-ga132

http://localhost:8080 で Liferay にサインインしてください。 メールアドレス [e-mail] とパスワード test を使用してください。 プロンプトが表示されたら、パスワードを learn に変更してください。

次に、以下の手順に従ってください。

1. liferay-j1h1.zip をダウンロードして解凍します。

   curl https://resources.learn.liferay.com/examples/liferay-j1h1.zip -O
   

   unzip liferay-j1h1.zip
   

2. サンプルモジュールをデプロイします。

   cd liferay-j1h1
   

   ./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
   

3. Dockerコンテナコンソールでデプロイメントを確認してください。

   com.acme.j1h1.api_1.0.0 が起動しました
   com.acme.j1h1.impl_1.0.0 が起動しました
   com.acme.j1h1.osgi.commands_1.0.0 が起動しました
   

4. Gogo Shell を開きます。

5. Gogo Shell コマンド フィールドに j1h1:greet コマンドを入力して挨拶を生成します。

   j1h1:greet "キャプテン・カーク"
   

6. 出力結果を確認してください。

   こんにちは、カーク船長！
   

このサンプルモジュールは、API モジュールと実装モジュールを利用して、 j1h1:greet Gogo Shell コマンドから返されるコンテンツを生成します。

OSGiサービスの使い方

• ビジネスロジックを記述する
• 外部サービスリファレンスの注釈
• クラスをコンポーネントにする

ビジネスロジックを記述する

授業では、必要なOSGiサービスを使用してビジネスロジックを実装してください。

1. サービスをインポートします。

import com.acme.j1h1.Greeter;

1. サービスを利用してください。

public void greet(String name) {
	_greeter.greet(name);
}

private Greeter _greeter;

上記のメソッドは、 Greeterの greet メソッドを呼び出します。 com.acme.j1h1.Greeter は、実装モジュールが登録する OSGi サービス タイプです。 クラスは、OSGi サービスレジストリから Greeter インスタンスを取得する必要があります。

外部サービス参照に注釈を付ける

レジストリから OSGi サービスを取得するには、そのサービス タイプのフィールドに @Reference アノテーションを追加する必要があります。 サービスフィールドに @Reference を追加します。

@Reference
private Greeter _greeter;

J1H1OSGiCommands クラスには、上記のプライベート Greeter フィールドがあり、 _greeter と呼ばれています。 @Reference アノテーションは、OSGi ランタイムにレジストリから Greeter サービスをフィールドに挿入するように指示します。 J1H1Greeter がレジストリ内で最も一致する Greeter サービス コンポーネントである場合 (この例では一致するのはこれだけです)、ランタイムは _greeter に J1H1Greeter を挿入します。

クラスをコンポーネントにする

@Reference アノテーションを使用できるのは、宣言型サービス コンポーネントのみです。 クラスに @Component アノテーションを追加し、 service 属性を使用して、コンポーネントが特定のサービスを実装することを宣言します。

@Component(
	property = {"osgi.command.function=greet", "osgi.command.scope=j1h1"},
	service = J1H1OSGiCommands.class
)
public class J1H1OSGiCommands {

J1H1OSGiCommands クラスは、独自のタイプの OSGi サービスを提供します。 これら 2 つのプロパティは、 greet というコマンド関数を持つ Gogo シェル コマンドを、 j1h1 というスコープで定義します。 デプロイされたJ1H1OSGiCommandsコンポーネントは、String型を入力として受け取る Gogo Shell コマンド「j1h1:greet」を提供します。

APIへの依存関係を追加する

お客様のコンシューマーモジュールはAPIに依存しています。 build.gradle ファイルに、API を依存関係に追加します。 j1h1-osgi-commands モジュールの build.gradle ファイルは以下のとおりです。

dependencies {
	compileOnly group: "com.liferay.portal", name: "release.dxp.api"
	compileOnly project(":j1h1-api")
}

release.dxp.api アーティファクトは、現在の Liferay 製品リリースからモジュールが必要とする Liferay、Bnd、および OSGi サービスを提供します。 liferay.workspace.product はリリースを指定します。 [プロジェクト ルート]/gradle.properties ファイル内。

ローカルプロジェクト j1h1-api は Greeter サービスを提供するので、 j1h1-osgi-commands はアーティファクトではなくプロジェクトとして依存できます。 外部アーティファクトへの依存関係を指定するのも簡単です。

結論

API モジュールと Impl モジュールは、それぞれ グリーター サービスを定義し、提供しました。 例の j1h1-osgi-commands モジュールは、サービスを使用してシンプルな Gogo Shell コマンドを作成します。 APIプロバイダーとコンシューマー間の契約は疎結合を促進し、ソフトウェアの管理、拡張、およびサポートを容易にします。

近隣プロジェクトのOSGiサービスの使い方に慣れてきたら、外部アーティファクトのOSGiサービスの使い方を調べてみましょう。 依存関係の設定 は、モジュールを見つけて依存関係として設定する方法を示します。

関連トピック

• パッケージのインポート
• パッケージのエクスポート
• セマンティックバージョニング
• 依存関係の構成