Service Builder Basics
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

ローカルでサービスを呼び出す

DXP/Portalにデプロイされたサービスビルダーサービスは、同じJVM内の他のクラスから呼び出すことができます。 これらのサービスは、各クラスに固有のものです。

サービスビルダーサービスは、宣言型サービス(DS)コンポーネントです。つまり、コンテナで管理されます。 コンシューマはコンテナにコンポーネントを要求し、コンテナは一致するコンポーネントインスタンスを提供します。

クラスをDSコンポーネントとして実装する利点は、クラスが依存する他のコンポーネントが使用可能でなければ、そのクラスが有効にならない点です。 コンポーネントの依存関係が満たされていないためにコンポーネントをアクティブ化できない場合、ランタイムフレームワークがその問題を報告します。

ここでは、 ポートレット DS コンポーネントから Service Builder サービスを呼び出します。 新しいエントリーを追加するためのフォームがあるポートレットアプリケーションの例を使用します。 フォームはJavaServer Page(JSP)にあります。 フォームを送信すると、ポートレットがトリガーされ、エントリを作成して永続化するためのサービスが呼び出されます。

ポートレットからサービスを呼び出す

Liferay DXP の新しいインスタンスを起動するには、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2026.q1.9-lts

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

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

  1. サンプルをダウンロードして解凍してください。

    curl https://resources.learn.liferay.com/examples/liferay-t2p5.zip -O
    
    unzip liferay-t2p5.zip
    
  2. サンプルをビルドしてデプロイします。

    cd liferay-t2p5
    
    ./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
    
    注記

    このコマンドは、モジュール JAR を Docker コンテナ上の /opt/liferay/osgi/modules にコピーすることと同じです。

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

    com.acme.t2p5.api_1.0.0 が起動しました
    com.acme.t2p5.service_1.0.0 が起動しました
    com.acme.t2p5.web_1.0.0 が起動しました
    
  4. T2P5 ポートレット ウィジェットを サンプル カテゴリからウィジェットページに追加します。 T2P5ポートレットが表示されます。

    T2P5ポートレットをページに追加しました。

  5. テキストフィールドにエントリー名と説明を入力し、 送信 をクリックします。 例えば、

    名前: 生垣を刈り込む

    説明: 生垣用剪定ばさみを使って、生垣をきれいな形に刈り込みます。

T2P5ポートレットをページに追加しました。

名前と説明付きの新しいエントリが T2P5 エントリ リストに表示されます。

ポートレットからService Builderサービスを呼び出しました。 サービスAPIから始めて、その仕組みを学びましょう。

サービスAPIを調べる

t2p5-api モジュールプロジェクトの T2P5EntryLocalService クラスには、 addT2P5Entry(String description, String name) というメソッドがあります。

addT2P5Entry メソッドは、指定された説明と名前を持つ T2P5Entry を作成し、エントリを永続化します。

注記

t2p5-service モジュールプロジェクトの T2P5EntryLocalServiceImpl クラスは、 T2P5EntryLocalService インターフェースを実装します。

t2p5-api モジュールの bnd.bnd ファイルは、 com.acme.t2p5.service パッケージ、 com.acme.t2p5.model パッケージ、およびコンシューマーが使用するその他のパッケージのエクスポートを宣言します。 bnd.bnd ファイルはこちらです:

Bundle-Name: Acme T2P5 API
Bundle-SymbolicName: com.acme.t2p5.api
Bundle-Version: 1.0.0
Export-Package:\
	com.acme.t2p5.exception,\
	com.acme.t2p5.model,\
	com.acme.t2p5.service,\
	com.acme.t2p5.service.persistence

t2p5-web モジュールのポートレットアプリケーションは、 T2P5EntryLocalService クラスに依存します。 ウェブモジュールの build.gradle ファイルは、 t2p5-api プロジェクトへの依存関係を宣言しています。

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

アーティファクトの検索と依存関係の指定に関する情報については、 依存関係の設定 を参照してください。

ポートレットを調べる

t2p5-web モジュールの T2P5Portlet クラスは、 T2P5Entry インスタンスを追加するリクエストを処理します。 T2P5Portlet クラスはこちらです。

@Component(
	property = {
		"com.liferay.portlet.display-category=category.sample",
		"jakarta.portlet.display-name=T2P5 Portlet",
		"jakarta.portlet.init-param.view-template=/view.jsp"
	},
	service = Portlet.class
)
public class T2P5Portlet extends MVCPortlet {

	public void addT2P5Entry(
			ActionRequest actionRequest, ActionResponse actionResponse)
		throws PortalException {

		_t2p5EntryLocalService.addT2P5Entry(
			ParamUtil.getString(actionRequest, "説明"),
			ParamUtil.getString(actionRequest, "名前"));
	}

	@Reference
	private T2P5EntryLocalService _t2p5EntryLocalService;

}

T2P5Portlet は MVCPortlet です。 これには、 T2P5EntryLocalService というフィールド _t2p5EntryLocalService と、 addT2P5Entry というアクション処理メソッドがあります。

_t2p5EntryLocalService フィールドの @Reference アノテーションは、ランタイム フレームワークに T2P5EntryLocalService コンポーネント インスタンスをフィールドに挿入するように指示します。

注記

@Reference アノテーションの使用方法と、その他の方法でサービスにアクセスする方法の詳細については、 依存性注入 を コアフレームワーク で参照してください。

addT2P5Entry メソッドは、 T2P5EntryLocalServiceの addT2P5Entry メソッドを呼び出し、 ActionRequest から取得した description および name パラメータを渡します。

ポートレットの view.jsp テンプレート (次) は ActionRequestを T2P5Portlet に送信します。

JSPを検証する

view.jsp はエントリを追加するためのフォームを提供し、現在のエントリをすべて表示します。

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>

<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>

<%@ taglib uri="http://liferay.com/tld/aui" prefix="aui" %>

<%@ ページインポート="com.acme.t2p5.model.T2P5Entry" %><%@
ページインポート="com.acme.t2p5.service.T2P5EntryLocalServiceUtil" %>

<%@ ページインポート="java.util.List" %>

<portlet:defineObjects />

<h4>T2P5 ポートレット</h4>

<hr />

<h5>T2P5エントリを追加</h5>

<portlet:actionURL name="addT2P5Entry" var="addT2P5EntryURL" />

<aui:form action="<%= addT2P5EntryURL %>">
	<aui:input name="name" type="text" />

	<aui:input name="description" type="text" />

	<aui:button type="submit" value="submit" />
</aui:form>

<hr />

<h5>T2P5 エントリー</h5>

<%
リスト<T2P5Entry> t2p5Entries = T2P5EntryLocalServiceUtil.getT2P5Entries(-1, -1);
%>

<c:choose>
	<c:when test="<%= t2p5Entries.size() > 0 %>">
		<table>
			<tbody>
				<c:forEach items="<%= t2p5Entries %>" var="エントリ">
					<tr>
						<td>${entry}</td>
					</tr>
				</c:forEach>
			</tbody>
		</table>
	</c:when>
	<c:otherwise>
		<em>T2P5 のエントリはありません。</em>
	</c:otherwise>
</c:choose>

JSPは、以下のタグライブラリのタグを使用します。

  • コアJSTL
  • ポートレット
  • LiferayのAlloy UI(aui)

以下のクラスをインポートします。

  • T2P5Entry
  • T2P5EntryLocalServiceUtil
  • java.util.List

ページの T2P5 エントリの追加 セクションには、エントリを追加するためのフォームがあります。 <portlet:defineObjects /> タグを使用すると、標準のポートレット オブジェクトをテンプレートで使用できるようになります。 aui タグはこれらのオブジェクトを使用します。

<portlet:actionURL name="addT2P5Entry" var="addT2P5EntryURL" /> タグは、 addT2P5EntryURL 変数を addT2P5Entry という名前のポートレットアクションにマッピングします。 このactionURLを使用してActionRequestを送信すると、このactionURL がアクション名「addT2P5Entry」にマッピングされているため、ポートレットのメソッドaddT2P5Entryが呼び出されます。

<aui:form> は、エントリの名前と説明のテキスト フィールドを表示します。 フォームを送信すると、その値は ActionRequest とともにポートレットメソッドに渡されます。

注記

ポートレットアクションの詳細については、 MVC ポートレットを使用したアクションの呼び出し を参照してください。

ページの エントリ セクションには、すべてのエントリが一覧表示されます。 すべてのエントリを取得するには、 T2P5EntryLocalServiceUtil.getT2P5Entries(-1, -1) を呼び出します。 -1 最小値と最大値の範囲値は、メソッドにすべてのエントリを返すように指示します。

ポートレットアプリケーションからService Builderサービスを呼び出しました。 これらのサービスはMVCポートレットで簡単に利用できます。

次は?

Service Builder の基本を理解したので、 エンティティの定義 を探索して、エンティティ間の関係を作成したり、エンティティをローカライズしたり、クエリをサポートしたりすることができます。 または、 サービスビルダーを使用したビジネスロジック を詳しく見ていくこともできます。