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

MVCレンダリングコマンド

MVCレンダーコマンドは、レンダリングするページを処理するクラスです。 これらは、MVCPortletレンダーURLとリクエストによって呼び出されます。 レンダリングロジックが単純な場合は、 ポートレットクラス ですべてを実装できます。 レンダーロジックが複雑な場合、またはレンダーパスを明確に分離したい場合は、MVCレンダーコマンドを使用してください。

MVCレンダリングコマンドを呼び出す

ここでは、MVCレンダーコマンドを使用してビューをレンダリングするサンプルポートレットをデプロイします。

新しい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 に変更してください。

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

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

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

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

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

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

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

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

  5. ベイカーへ移動 をクリックして、MVC レンダリング コマンドを呼び出し、ベイカー ビューに移動します。 A4P1BakerMVCRenderCommand は、その render メソッドの呼び出しをログに記録し、Baker ビューをレンダリングします。

    [A4P1BakerMVCRenderCommand:26] #render(RenderRequest, RenderResponse) を呼び出しています
    

    ベイカービューをレンダリングしています。

  6. 他の MVC レンダリング コマンドを呼び出し、 Go to Able をクリックして Able ビューに戻ります。 A4P1AbleMVCRenderCommand は、その render メソッドの呼び出しをログに記録し、Able ビューを再度レンダリングします。

    [A4P1AbleMVCRenderCommand:26] #render(RenderRequest, RenderResponse) を呼び出しています
    

あなたはMVCのレンダリングコマンドが実際に動作する様子をご覧になったことでしょう。 それでは、それらがどのように機能するのかを学びましょう。

ポートレットを調べる

A4P1Portlet は最小限の MVCPortlet です。

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

@Component javax.portlet.name プロパティはポートレットの名前を設定します。

"jakarta.portlet.name=com_acme_a4p1_web_internal_portlet_A4P1Portlet"

ポートレットはデフォルトで /a4p1/able.jsp をレンダリングします。

注記

MVCRenderCommandは、ポートレット名 (たとえば、ポートレット コンポーネント javax.portlet.name プロパティ値) によってポートレットにバインドされます。

次は、ポートレットのMVCレンダリングコマンドクラスです。

MVCRenderCommand クラスを調べます

MVC Render Command クラスは、 MVCRenderCommand を直接実装できます。 A4P1AbleMVCRenderCommand は、 MVCRenderCommand を直接実装します。 A4P1AbleMVCRenderCommand はこちらです。

@Component(
	property = {
		"jakarta.portlet.name=com_acme_a4p1_web_internal_portlet_A4P1Portlet",
		"mvc.command.name=/a4p1/able"
	},
	service = MVCRenderCommand.class
)
public class A4P1AbleMVCRenderCommand implements MVCRenderCommand {

	@Override
	public String render(
		RenderRequest renderRequest, RenderResponse renderResponse) {

		if (_log.isInfoEnabled()) {
			_log.info("Invoking #render(RenderRequest, RenderResponse)");
		}

		return "/a4p1/able.jsp";
	}

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

}

A4P1AbleMVCRenderCommand は、 コンポーネント であり、 MVCRenderCommand サービスを提供します。 コンポーネントのプロパティは、 A4P1AbleMVCRenderCommand を com_acme_a4p1_web_internal_portlet_A4P1Portlet という名前のポートレットに適用し、 A4P1AbleMVCRenderCommand を MVC コマンド名 /a4p1/able にマッピングします。

注記

各ポートレットごとに個別のjavax.portlet.nameプロパティを宣言することで、MVCRenderCommandコンポーネントを複数のポートレットに関連付けることができます:

@Component(
    property = {
        "javax.portlet.name=com_acme_a4p1_web_internal_portlet_A4P1Portlet",
        "javax.portlet.name=com_acme_a4p1_web_internal_portlet_A4P2Portlet",
        "mvc.command.name=/a4p1/download"
    },
    service = MVCRenderCommand.class
)

ポートレットが、MVC コマンド名 /a4p1/ableを指定するリクエスト パラメータを受け取ると、 A4P1AbleMVCRenderCommandの render メソッドが実行されます。 この render メソッドは、自身を識別するメッセージをログに出力し、レンダリングするビューのパスを返します。

A4P1BakerMVCRenderCommand は A4P1AbleMVCRenderCommand と似ていますが、MVC コマンド名は /a4p1/baker であり、レンダリング メソッドはビュー パス /a4p1/baker.jsp を返します。

これらのMVCレンダリングコマンドの例は、デモンストレーション目的でごく簡単な機能を提供するものです。 ビューをレンダリングするために必要なロジックを使用して、MVC Render Command の render メソッドを実装します。

例のURLはMVCレンダリングコマンドをトリガーします。

ポートレットレンダリングURLを確認する

able.jsp と baker.jsp ファイルは、ポートレットレンダリング URL を使用して間接的に相互にリンクしています。 able.jsp はこちらです。

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

<h4>A4P1 Portlet</h4>

<h5>Able</h5>

<portlet:renderURL var="bakerURL">
	<portlet:param name="mvcRenderCommandName" value="/a4p1/baker" />
</portlet:renderURL>

<a href="<%= bakerURL %>">パン屋へ行く</a>

portlet:renderURL タグはポートレットタグライブラリから利用可能で、プレフィックス ポートレット が割り当てられています。 このレンダリング URL は、 mvcRenderCommandName ポートレット パラメータ値 /a4p1/baker—これは A4P1AbleMVCRenderCommandの MVC コマンド名であると宣言します。 変数 bakerURL はこのレンダリング URL を参照します。

ハイパーリンク <a href="<%= bakerURL %>">Baker へ移動</a> は、レンダリング URL をアクションにバインドします。 ユーザーがハイパーリンクをクリックすると、ポートレットは RenderRequest を A4P1BakerMVCRenderCommand に送信します。これは、 mvc.command.name コンポーネントプロパティ値 /a4p1/baker が と一致するためです。 mvcRenderCommandName パラメーター値。

baker.jsp は able.jsp と似ていますが、ポートレットレンダリング URL mvcRenderCommandName パラメータの値は /a4p1/able です。 各 JSP の portlet:renderURL タグは、MVC レンダリング コマンドの mvc.command.name プロパティ値をタグの mvcRenderCommandName ポートレット パラメーターに割り当てることにより、MVC レンダリング コマンドにマッピングされます。

able.jspポートレットレンダーURLパラメーターA4P1BakerMVCRenderCommandコンポーネントプロパティ
<portlet:param name="mvcRenderCommandName" value="/a4p1/baker" />mvc.command.name=/a4p1/baker
baker.jspポートレットレンダーURLパラメーターA4P1AbleMVCRenderCommandコンポーネントプロパティ
<portlet:param name="mvcRenderCommandName" value="/a4p1/able" />mvc.command.name=/a4p1/able

次は?

これで、MVCのレンダーコマンドクラスにレンダリングロジックを実装する方法がわかりました。 次に、 MVC リソース コマンド クラスを使用して、ファイルなどのリソースを操作できます。