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

Rendering Views with MVC Portlet

ユーザーがポートレットのビューにアクセスできるようにする場合は、ビューへのナビゲーションを実装する必要があります。ポートレットレンダーURLは、このような場合に役立ちます。

ここでは、ポートレットレンダーURLを使用するサンプルアプリケーションをデプロイします。ポートレットが、MVCポートレットのmvcPathパラメーターを使用してビューパスを設定するURLを作成する方法を見ていきます。

サンプルポートレットには2つのビューがあります。ビュー1にはその名前とビュー2へのリンクが表示され、その逆も同様です。

これがビュー1です。

複数のビューを持つMVCポートレットをデプロイする

サンプルポートレットをデプロイし、そのビュー間を移動する方法は次のとおりです。学習の目的で、ポートレットはmvcPathパラメーター値をログに記録します。

新しい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に変更します。

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

サンプルをダウンロードして解凍します。

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

unzip liferay-c8m3.zip

サンプルをビルドしてデプロイします。
```
cd liferay-c8m3
```
```
./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
```
注

このコマンドは、モジュールJARをDockerコンテナ上の /opt/liferay/osgi/modules にコピーするのと同じです。
Dockerコンテナコンソールでデプロイを確認します。
```
STARTED com.acme.c8m3.web_1.0.0
```
［C8M3ポートレット］ウィジェットを［サンプル］カテゴリからウィジェットページに追加します。 ビュー1（ポートレットのデフォルトビュー）が表示されます。

次のメッセージがログに出力されます。
```
MVC path null
```
レンダーリクエストには、MVCパスパラメーターがまだ含まれていません。これは予想通りです。ポートレットは、デフォルトでポートレットクラス（後述）を使用してビュー1をレンダリングします。次のステップでは、MVCパスパラメーターを使用します。
[ビュー2に移動]をクリックします。ビュー2が表示されます。

ログメッセージには、MVC パス値 /view_2.jsp—View 2 テンプレートへのパスが表示されます。
```
MVC path /view_2.jsp
```
[ビュー 1 に移動]をクリックします。ビュー1が再び表示されます。

ログメッセージには、MVCパス/view_1.jspが出力されます。
```
MVC path /view_1.jsp
```

ポートレットビュー間を往復しました。次に、ポートレットがデフォルトのビューを設定し、レンダーURLとMVCパスリクエストパラメータを使用してビューへのパスを設定する方法を学習します。

デフォルトビューの設定

ポートレットのデフォルトビューは、ユーザーが最初にポートレットのページにアクセスしたときにレンダリングされます。ポートレットクラスの初期化パラメーターは、デフォルトビューを設定します。 C8M3Portlet.java サンプルクラスは、 @Component アノテーションで既定のビューを設定します。

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

@Component プロパティ "javax.portlet.init-param.view-template=/view1.jsp" は、デフォルトのビューテンプレートとして /view1.jsp を指定します。テンプレートパスは、ポートレットのsrc/main/resources/META-INF/resourcesフォルダへの相対パスです。

次に、ビュー1がビュー2にリンクする方法を学習します。

ポートレットレンダーURLを使用したビューへのリンク

ビュー1には、［View 1］という見出しと、［Go to View 2］というラベルの付いたリンクしかありません。 view1.jspコードは次のとおりです。

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

<h4>C8M3 Portlet</h4>

<h5>View 1</h5>

<portlet:renderURL var="view2URL">
	<portlet:param name="mvcPath" value="/view_2.jsp" />
</portlet:renderURL>

<a href="<%= view2URL %>">Go to View 2</a>

portlet:renderURLタグはポートレットtaglibから取得され、プレフィックスportletが割り当てられます。上記のレンダーURLは、変数view2URLに割り当てられています。レンダーURLは、mvcPathという名前のportlet:paramに値/view_2.jspを宣言します。ポートレットがレンダリングされると、 mvcPath パラメータがポートレットの RenderRequest オブジェクトに追加されます。ポートレットリクエストを処理する際に、 MVCPortlet は mvcPathに割り当てられたテンプレートをレンダリングします。

ポートレットがURLを使用するためには、レンダーURLがハイパーリンクやボタンなどのUIコンポーネントにバインドされている必要があります。ハイパーリンク <a href="<%= view2URL %>">ビュー 2 に移動</a> は、レンダリング URL を UI コンポーネントにバインドします。

ユーザーが［Go to View 2］ハイパーリンクをクリックすると、mvcPathパラメーターを含むポートレットリクエストがポートレットクラスに送信されます。

mvcPathポートレットパラメーターの処理

ポートレットがリクエストオブジェクトを受信すると、リクエストオブジェクトのパラメーターに応答できます。 C8M3Portletのrenderメソッドは、レンダーリクエストに応答します。

@Override
public void render(
		RenderRequest renderRequest, RenderResponse renderResponse)
	throws IOException, PortletException {

	if (_log.isInfoEnabled()) {
		String mvcPath = renderRequest.getParameter("mvcPath");

		_log.info("MVC path " + mvcPath);
	}

	super.render(renderRequest, renderResponse);
}

private static final Log _log = LogFactoryUtil.getLog(C8M3Portlet.class);

C8M3Portletのrenderメソッドは、mvcPathパラメーター値をログに記録してから、ポートレットのレンダリングをスーパークラスMVCPortletに委任します。 MVCPortlet は、 mvcPath ポートレット要求パラメータに割り当てられたビューをレンダリングします。

注

mvcPath リクエストパラメータがない場合、 MVCPortlet はデフォルトのテンプレート（つまり、 javax.portlet.init-param.view-template コンポーネントプロパティが指定するテンプレート）を表示します。

ビュー2のテンプレートview2.jspは、ポートレットレンダーURLも使用してview1.jspにマップし直します。

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

<h4>C8M3 Portlet</h4>

<h5>View 2</h5>

<portlet:renderURL var="view1URL">
	<portlet:param name="mvcPath" value="/view_1.jsp" />
</portlet:renderURL>

<a href="<%= view1URL %>">Go to View 1</a>

ビュー1に戻るラウンドトリップを実装します。