既存のサービスの代わりにカスタムサービスを作成して挿入するには、次の3つのことが必要です。
- サービスインターフェイスの理解
- 既存のサービス
- サービスへの参照
カスタムサービスは、サービスインターフェイスを実装し、必要な参照と一致させる必要があり、場合によっては既存のサービスを呼び出す必要があります。
コンポーネントにカスタムサービスをすぐに採用させるには、サービスへの参照を再構成する必要があります。ここでは、これらの決定を行うためにサービスの詳細を具体化します。
サービスに関する情報の収集
-
コンポーネントサービスの参照は拡張ポイントであるため、チュートリアルFinding Extension Pointsに従って、オーバーライドするサービスとそのサービスを使用するコンポーネントを特定することから始めます。
-
サービスとそのサービスを使用するコンポーネントがわかったら、Gogo ShellのService Component Runtime（SCR）を使用してコンポーネントを検査し、サービスと参照の詳細を取得します。Gogo Shellコマンド
scr:info [componentName]は、コンポーネントの属性とサービス参照をリストします。
次に、コンポーネントoverride.my.service.reference.OverrideMyServiceReference（サンプルモジュールoverride-my-service-referenceより）およびそのタイプのサービスへの参照override.my.service.reference.service.api.SomeServiceを記述するscr:infoコマンドと結果（...で略記）の例を示します。
> scr:info override.my.service.reference.OverrideMyServiceReference
...
Component Description:
Name: override.my.service.reference.portlet.OverrideMyServiceReferencePortlet
...
Reference: _someService
Interface Name: override.my.service.reference.service.api.SomeService
Cardinality: 1..1
Policy: static
Policy option: reluctant
Reference Scope: bundle
...
Component Configuration:
ComponentId: 2399
State: active
SatisfiedReference: _someService
Target: null
Bound to: 6840
Properties:
component.id = 2400
component.name = override.my.service.reference.service.impl.SomeServiceImpl
objectClass = [override.my.service.reference.service.api.SomeService]
service.bundleid = 524
service.id = 6840
service.scope = bundle
...
上記の内容と同様に、scr:info結果には、カスタムサービスの挿入に関連する情報が含まれています。この情報を使用して、次のことを行います。
サービスインターフェイスから始めます。
ステップ1：サービスインターフェイス名をコピーする
参照のインターフェイス名は、サービスインターフェイスの完全修飾名です。
...
Reference: _someService
Interface Name: override.my.service.reference.service.api.SomeService
...
**インターフェイス名をコピーして保存します。**これは、カスタムサービスが実装する必要があるタイプです。
Liferay DXPサービスインターフェイスのJavadocは次の場所にあります。
ステップ2：既存のサービス名をコピーする
カスタムサービスとともに既存のサービスを呼び出す場合は、既存のサービス名を取得します。
src:info結果のコンポーネントの構成セクションには、既存のサービスの完全修飾名がリストされます。たとえば、OverrideMyServiceReferencePortletコンポーネントの参照_someServiceは、完全修飾名がoverride.my.service.reference.service.impl.SomeServiceImplのサービスコンポーネントにバインドされます。
Component Configuration:
...
SatisfiedReference: _someService
...
Bound to: 6840
Properties:
...
component.name = override.my.service.reference.service.impl.SomeServiceImpl
component.nameをコピーして、カスタムサービスでサービスを参照できるようにします。
上記のサービスを参照する例を次に示します。
@Reference (
target = "(component.name=override.my.service.reference.service.impl.SomeServiceImpl)"
)
private SomeService _defaultService;
ステップ3：参照構成の詳細を収集する（再構成が必要な場合）
サービス参照のポリシーとポリシーオプションによって、特定のサービスを採用するためのコンポーネントの条件が決まります。
-
参照のポリシーオプションが
greedyの場合、一致する最高ランクのサービスにすぐにバインドされます。サービスを採用するために参照を再構成する必要はありません。 -
ただし、ポリシーが
staticで、ポリシーオプションがreluctantの場合は、使用するサービスを現在参照している既存のサービスから、一致する最高ランクのサービスに切り替える（つまり、カスタムサービスを最高ランクに位置付ける）ために、コンポーネントに次のいずれかの条件が必要です。- コンポーネントを再アクティブ化する
- コンポーネントの既存の参照サービスを利用不可にする
- コンポーネントの参照を、既存のサービスとは一致しないが新しいサービスとは一致するように変更する
参照の再構成は、コンポーネントが新しいサービスを採用する最も迅速な方法です。
次の詳細を収集します。
-
コンポーネント名： Component Description → Nameにあります。例：
Component Description: Name: override.my.service.reference.portlet.OverrideMyServiceReferencePortlet ... -
参照名： 参照値（例：
Reference: _someService）。 -
カーディナリティ：参照がバインドできるサービスインスタンスの数。
注：Declarative Servicesは、OSGiの[Configuration Admin]を介してすべてのコンポーネントを構成可能にします。ソースコード内の各@Referenceアノテーションには、アノテーションで明示的に設定されるか、またはアノテーションが使用されるメンバーの名前から暗黙的に派生する名前プロパティがあります。
- 参照名プロパティが使用されておらず、
@Referenceがフィールドにある場合、参照名はフィールド名です。たとえば、@Referenceが_someServiceというフィールドにある場合、参照名は_someServiceとなります。 @Referenceがメソッド上にある場合、ヒューリスティックスにより参照名が導き出されます。メソッド名のサフィックスが使用され、set、add、putのようなプレフィックスは無視されます。たとえば、@ReferenceがsetSearchEngine(SearchEngine se)というメソッド上にある場合、参照名はSearchEngineとなります。
カスタムサービスを作成した後（次のステップ）、ここで収集した詳細を使用して、カスタムサービスを使用するようにコンポーネントを構成します。
OSGiサービスをオーバーライドするために必要な詳細を取得できました。
関連トピック
OSGi Services and Dependency Injection with Declarative Services