Documentation

OSGiサービスのオーバーライドをする

LiferayのOSGiコンテナは、必要に応じてサービスを追加、削除、またはオーバーライドできる動的な環境です。 このフレームワークは、LiferayコンポーネントをOSGiサービスレジストリに登録します。各コンポーネントには、独自の可用性、ランキング、および属性があります。 これらの詳細が合わさって、コンポーネントが参照するサービスにどのようにバインドするかが決まります。

OSGiサービスをオーバーライドするには、次の手順に従います。

  1. オーバーライドするサービスと、それを参照するコンポーネントを特定します。

  2. 次のサービスの詳細を収集します。

    • サービスタイプ :オーバーライドするサービスによって実装されるインターフェイス

    • サービスのクラス名 :既存のサービスのフルネーム

  3. 該当する場合は、サービスを参照するコンポーネントについて次の詳細を収集します。

    • コンポーネント名 :オーバーライドするサービスを参照するコンポーネントのフルネーム

    • 参照名 :ターゲットサービスを参照するフィールド名

    • 参照ポリシー :参照がstaticdynamic

    • 参照ポリシーオプションpolicy-optiongreedyreluctant

    • カーディナリティ :参照がバインドできるまたはバインドする必要があるサービスインスタンスの数。

    サービスの 参照ポリシー参照ポリシーオプション 、および カーディナリティ が一緒になって、新しいサービスを採用するためのコンポーネントの条件を決定します。

  4. オーバーライドするサービスによって実装されたものと同じインターフェイスを使用する新しいサービスを作成します。

  5. オーバーライドしているサービスよりも高いランクを自分のサービスに指定します。

  6. (オプション)必要に応じて、自分のサービスでオーバーライドするサービスを参照して呼び出します。

サンプルモジュールは、OSGiサービスをオーバーライドする方法を示しています。 これらのモジュールには、新しいOSGiサービスタイプを定義するためのAPI、そのタイプの初期実装、および初期実装を参照する汎用ポートレットが含まれています。 また、初期実装をオーバーライドする方法を示すためのAPIの代替実装も含まれています。

オーバーライドするサンプルモジュールをデプロイする

新しいLiferay インスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.29-ga29。

http://localhost:8080でLiferayへのサインインします。 メールアドレス_test@liferay.com_とパスワード_test_を使用してください。 プロンプトが表示されたら、パスワードを _learn_に変更します。

次に、以下の手順に従います。

  1. サンプルモジュールをダウンロードして解凍します。

    curl https://learn.liferay.com/dxp/latest/ja/liferay-internals/extending-liferay/liferay-s1j6.zip -O
    
    unzip liferay-s1j6.zip
    
  2. s1j6-apis1j6-able-impl、およびs1j6-webサブフォルダから次のgradlewコマンドを実行して、各モジュールをビルドして新しいDockerコンテナに個別にデプロイします。

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

    各モジュールのJARは、そのbuild/libsフォルダ(例:s1j6-api/build/libs/com.acme.s1j6.api-1.0.0.jar)に生成されます。

    ログメッセージは、Liferayが処理を開始し、各モジュールを正常に開始したことを示します。 これらのログには、各サービスのバンドルIDも提供されています。

    STARTED com.acme.s1j6.api_1.0.0 [1356]
    STARTED com.acme.s1j6.able.impl_1.0.0 [1357]
    STARTED com.acme.s1j6.web_1.0.0 [1358]
    
  3. モジュールがGogoシェルを介して正常にデプロイされたことを確認します。

    lb | grep -i "s1j6"
    

    成功した場合、出力は次のようになります。

    1356|Active     |   15|Acme S1J6 API (1.0.0)|1.0.0
    1357|Active     |   15|Acme S1J6 Able Implementation (1.0.0)|1.0.0
    1358|Active     |   15|Acme S1J6 Web (1.0.0)|1.0.0
    true
    

提供されたapiは、able.implモジュールによって実装されるOSGiサービスタイプを定義します。このタイプは、提供されたportletによって使用されます。 すべてがデプロイされたので、オーバーライドがどのように機能するかを試すことができます。

OSGiサービスとリファレンスの詳細を収集する

オーバーライドするサービスを特定したら、scr:info Gogo シェルコマンドを使用して、その重要なサービスとリファレンスの詳細を収集します。 この例では、able.implサービスをオーバーライドします。

サービスの詳細を収集するには、次のコマンドを実行します。

scr:info com.acme.s1j6.able.internal.S1J6AbleImpl
Component Description: com.acme.s1j6.able.internal.S1J6AbleImpl
===============================================================
Class:         com.acme.s1j6.able.internal.S1J6AbleImpl
Bundle:        1357 (com.acme.s1j6.able.impl:1.0.0)
[...]

Component Configuration Id: 8337
--------------------------------
State:        ACTIVE
Service:      17776 [com.acme.s1j6.S1J6]
    Used by bundle 1358 (com.acme.s1j6.web:1.0.0)
Config Props: (2 entries)
  component.id = 8337
  component.name = com.acme.s1j6.able.internal.S1J6AbleImpl
References:   (total 0)

この簡略化された出力には、S1J6AbleImplの次のサービスの詳細がリストされています。

  • サービスタイプS1J6AbleImplは、S1J6インターフェースcom.acme.s1j6.S1J6を実装します。

  • サービスのクラス名 :サービスのフルネームはcom.acme.s1j6.able.internal.S1J6AbleImplです。

また、サービスがcom.acme.s1j6.web:1.0.0バンドル内のコンポーネントによって使用されていることも示されます。 コンポーネントの参照構成の詳細を表示するには、コンポーネントのフルネームを指定してscr:infoコマンドを実行します。

scr:info com.acme.s1j6.web.internal.portlet.S1J6Portlet
Component Description: com.acme.s1j6.web.internal.portlet.S1J6Portlet
=====================================================================
Class:         com.acme.s1j6.web.internal.portlet.S1J6Portlet
Bundle:        1358 (com.acme.s1j6.web:1.0.0)
[...]

Component Configuration Id: 8338
--------------------------------
[...]
References:   (total 1)
  - _s1j6: com.acme.s1j6.S1J6 SATISFIED 1..1 static+greedy
    target=(*) scope=bundle (1 binding):
    * Bound to [17776] from bundle 1357 (com.acme.s1j6.able.impl:1.0.0)

この簡略化された出力には、次の参照構成の詳細がリストされています。

参照名S1J6AbleImplサービスを参照するフィールドの名前は_s1j6です。

参照ポリシー :コンポーネントのポリシーはstaticです(デフォルト)。

参照ポリシーオプション :コンポーネントのポリシーオプションは greedyです。

カーディナリティ :そのカーディナリティは必須であり、単項です(つまり、1..1)。

一部の参照構成は、新しいサービスまたは上位のサービスに自動的にバインドされますが、サーバーの再起動が必要なものもあります。 S1J6Portletの参照構成は静的で、欲張りで、必須であり、単項であるため、サーバーを新しい上位のサービスにバインドする前に、サーバーを再起動する必要はありません。 新しいサービスまたは上位のサービスが利用可能になったときに、さまざまな参照構成がコンポーネントの動作にどのように影響するかについて詳しくは、 OSGiのドキュメンテーション を参照してください。

収集した詳細でOSGiサービスを作成する

必要なサービスと参照の詳細を収集したら、それらを使用して、ターゲットサービスをオーバーライドして呼び出すためのカスタムサービスを作成できます。

  1. @Componentアノテーションを使用して、サービスをOSGiフレームワーク内のコンポーネントとして宣言します。

  2. ターゲットのOSGiサービスと同じインターフェースを実装し、@Componentアノテーション内でそのserviceタイプを識別します。

  3. インターフェースのメソッドをオーバーライドします。

  4. @Componentアノテーション内にservice.ranking:Integerプロパティを含めます。 そのランキングが既存のサービスよりも高いことを確認してください。

  5. (オプション)既存のサービスのcomponent.nameを参照して呼び出します。

サンプルのS1J6BakerImplモジュールは、S1J6AbleImplをオーバーライドするために提供されています。

@Component(property = "service.ranking:Integer=100", service = S1J6.class)
public class S1J6BakerImpl implements S1J6 {

	@Override
	public String doSomething() {
		return _s1j6.doSomething() +
			"<br />This is the S1J6 Baker implementation.";
	}

	@Reference(
		target = "(component.name=com.acme.s1j6.able.internal.S1J6AbleImpl)"
	)
	private S1J6 _s1j6;

}

ここで、S1J6BakerImplは、S1J6AbleImplと同じサービスタイプ(つまり、com.acme.s1j6.S1J6)を実装し、必要な@Componentアノテーション、service属性、およびservice.rankingプロパティを含みます。 また、既存のサービス(つまり、component.name=com.acme.s1j6.able.internal.S1J6AbleImpl)を参照し、インターフェイスのメソッドをオーバーライドする一環としてサービスに委任します。 サンプルモジュールには、S1J6AbleImplをオーバーライドしてからS1J6BakerImplをオーバーライドするための2つの他のS1J6実装も含まれています。

合計すると、含まれている実装のランキングは次のとおりです。

  • S1J6AbleImpl:ランキングなし(デフォルトは0)

  • S1J6BakerImpl:100

  • S1J6CharlieImpl:101

  • S1J6DogImpl:101

デプロイされると、最高ランクのサービスが優先され、S1J6Portletにバインドされます。 複数のサービスのランキングが同じ場合は、最初に登録されたサービスが優先されます。 ランクの低いサービスは無視されます。

オーバーライドモジュールと構成ファイルをデプロイする

次の手順に従って、S1J6BakerImplS1J6CharlieImpl、およびS1J6DogImplをデプロイします。

  1. コンソールで s1j6-baker-impl フォルダを開き、以下の gradlew コマンドを実行してモジュールのJARファイルを構築しDockerコンテナにデプロイします。

    cd ../s1j6-baker-impl
    
    ../gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
    

    ログメッセージには、Liferayが処理を開始し、バンドルIDとともにモジュールを正常に開始したことが示されます。

    STARTED com.acme.s1j6.baker_1.0.0 [1359]
    
  2. S1J6BakerImplが正常にデプロイされ、Gogoシェルを介してインスタンスにバインドされたことを確認します。

    scr:info com.acme.s1j6.web.internal.portlet.S1J6Portlet
    

    成功した場合、S1J6PortletS1J6AbleImplよりランクが高いS1J6BakerImplにバインドされます。

    References:   (total 1)
      - _s1j6: com.acme.s1j6.S1J6 SATISFIED 1..1 static
        target=(*) scope=bundle (1 binding):
        * Bound to [3248] from bundle 1359 (com.acme.s1j6.baker.impl:1.0.0)
    
  3. S1J6CharlieImplS1J6DogImplを同時に s1j6-liferayからDockerコンテナにデプロイします。

    cd ..
    
    ../gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
    
    STARTED com.acme.s1j6.charlie_1.0.0 [1360]
    STARTED com.acme.s1j6.dog_1.0.0 [1361]
    
  4. S1J6CharlieImplS1J6DogImplの両方がGogoシェルを介してインスタンスに正常にデプロイされたことを確認します。

    lb -s | grep -i "s1j6"
    
    1356|Active     |   15|com.acme.s1j6.api (1.0.0)|1.0.0
    1357|Active     |   15|com.acme.s1j6.able.impl (1.0.0)|1.0.0
    1358|Active     |   15|com.acme.s1j6.web (1.0.0)|1.0.0
    1359|Active     |   15|com.acme.s1j6.baker.impl (1.0.0)|1.0.0
    1360|Active     |   15|com.acme.s1j6.charlie.impl (1.0.0)|1.0.0
    1361|Active     |   15|com.acme.s1j6.dog.impl (1.0.0)|1.0.0
    
  5. どのサービスがS1J6Portletにバインドされているかを確認します。

    scr:info com.acme.s1j6.web.internal.portlet.S1J6Portlet
    
    References:   (total 1)
      - _s1j6: com.acme.s1j6.S1J6 SATISFIED 1..1 static
        target=(*) scope=bundle (1 binding):
        * Bound to [3249] from bundle 1360 (com.acme.s1j6.charlie.impl:1.0.0)
    

    S1J6CharlieImplS1J6DogImplはどちらも同じランキングであるため、最初に登録されたサービスが優先されてS1J6Portletにバインドされます。