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

カスタム製品コンテンツレンダラーの実装

このチュートリアルでは、 CPContentRendererインターフェースを実装することで、カスタム製品コンテンツレンダラーを追加する方法を説明します。

商品コンテンツレンダラーは、商品を表示できるさまざまなウィジェットで、特定の商品タイプの商品詳細を表示するスタイルを提供します。 Liferay Commerceは、Simple製品用のSimpleCPContentRendererなど、標準搭載の各製品タイプに対応した製品コンテンツレンダラーを提供しています。

すぐに使える商品コンテンツレンダラー

概要

  1. サンプルをデプロイする
  2. サンプルの説明

サンプルをデプロイする

このセクションでは、Liferay Commerce インスタンス上で、サンプルとなる製品コンテンツレンダラーを起動して実行する方法を説明します。

新しい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. Acme Commerce Product Content Rendererをダウンロードして解凍してください。

    curl https://resources.learn.liferay.com/examples/liferay-q4f7.zip -O
    
    unzip liferay-q4f7.zip
    
  2. liferay-q4f7にアクセスしてください。

    cd liferay-q4f7
    
  3. サンプルをビルドしてデプロイします。

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

    このコマンドは、デプロイされたjarファイルをDockerコンテナの/opt/liferay/osgi/modulesにコピーするのと同じです。

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

    STARTED com.acme.q4f7.web_1.0.0
    
  5. サンプル製品コンテンツレンダラーが追加されていることを確認してください。ブラウザでhttps://localhost:8080を開き、Liferay Commerce の製品カタログにアクセスしてください。商品をクリックすると商品詳細ウィジェットが表示されます。次に、ウィジェットの設定をクリックします。

    「カスタムレンダラー」セクションで「シンプル」を選択します。 「Simple Commerce Product Type Renderer Key」ドロップダウンメニューの下にある新しいレンダラー(「Q4F7 Commerce Product Content Renderer」)を選択します。

    新製品コンテンツレンダラー

  6. 商品を選択すると、新しいレンダリング画面には商品のSKU、価格、在庫状況、在庫数量のみが表示されます。

    新しいレンダラーを使用して表示した製品の詳細を以下に示します。

おめでとうございます。CPContentRenderer CPContentRenderer実装する新しいカスタム製品コンテンツレンダラーの構築とデプロイに成功しました。

次に、さらに深く掘り下げて詳しく見ていきましょう。

例題を順を追って見ていきましょう

このセクションでは、私たちが展開した例を確認します。まず、OSGi登録のためにクラスに注釈を付けます。次に、 CPContentRendererインターフェースを確認してください。そして3つ目は、 CPContentRendererの実装を完了することです。

OSGi登録のためにクラスに注釈を付ける

@Component(
   property = {
      "commerce.product.content.renderer.key=q4f7",
      "commerce.product.content.renderer.order=1",
      "commerce.product.content.renderer.type=" + SimpleCPTypeConstants.NAME
   },
   service = CPContentRenderer.class
)
public class Q4F7CPContentRenderer implements CPContentRenderer {

Liferay Commerce が新しいレンダラーを製品コンテンツレンダラーレジストリ内の他のレンダラーと区別できるように、製品コンテンツレンダラーに固有のキーを提供することが重要です。既に使われているキーを再利用すると、関連付けられている既存のレンダラーが上書きされます。

commerce.product.content.renderer.orderプロパティは、Commerce が UI にレンダラーを一覧表示するために使用する整数値です。レンダラーは昇順で表示されます。例えば、 SimpleCPContentRendererではこのプロパティが最小の整数値に設定されているため、Simple タイプの製品用の他のレンダラーはリスト内でその後に表示されます。

commerce.product.content.renderer.typeプロパティは、このレンダラーが使用できる製品の種類を決定します。この例では、シンプルタイプを使用しているため、レンダラーはUI上でシンプルカテゴリの下に表示されます。

CPContentRendererインターフェースを確認する

以下のメソッドを実装してください。

public String getKey();

この方法は、製品コンテンツレンダラーレジストリにおいて、製品コンテンツレンダラーの一意の識別子を提供します。このキーを使用すると、レジストリからレンダラーを取得できます。既に使われているキーを再利用すると、関連付けられている既存のレンダラーが上書きされます。

public String getLabel(Locale locale);

これは、製品コンテンツレンダラーを説明するテキストラベルを返します。言語キーを使用してラベルを取得する方法については、 liferay-q4f7.zip/q4f7-web/src/main/java/com/acme/q4f7/web/internal/commerce/product/content/renderer web/src/main/java/com/acme/q4f7/web/internal/commerce/product/content/renderer にある Q4F7CPContentRenderer.java クラスの実装を参照してください。

public void render(
      CPCatalogEntry cpCatalogEntry,
      HttpServletRequest httpServletRequest,
      HttpServletResponse httpServletResponse)
   throws Exception;

ここに、製品コンテンツレンダラー用にカスタマイズされたビューをレンダリングするためのコードを追加します。

ビューを定義する方法はいくつかあります。JSP、Freemarkerテンプレート、またはSoyテンプレートなどです。この例では、JSPを使用します。

製品コンテンツレンダラーを完成させる

製品コンテンツレンダラーは、当社が定義およびレンダリングするカスタムビューで構成されています。以下の手順を実行してください。

モジュールのServletContextを設定します

モジュール内のJSPを見つけられるように、バンドルのシンボル名を使用してServletContext定義します。

@Reference(target = "(osgi.web.symbolicname=com.acme.q4f7.web)")
private ServletContext _servletContext;

osgi.web.symbolicnameに設定した値は、 liferay-q4f7.zip/q4f7-web内のbnd.bndファイルにあるBundle-SymbolicNameの値と一致します。 ServletContextがJSPを見つけるためには、これらの値が一致している必要があります。

ServletContext正しく生成されるように、bnd.bndファイル内でWeb-ContextPathに一意の値を宣言する必要もあります。この例では、 Web-ContextPathは/q4f7-webに設定されています。これらの値の詳細については、 bnd.bndファイルを参照してください。

renderメソッドを実装する

@Override
public void render(
      CPCatalogEntry cpCatalogEntry,
      HttpServletRequest httpServletRequest,
      HttpServletResponse httpServletResponse)
   throws Exception {

   _jspRenderer.renderJSP(
      _servletContext, httpServletRequest, httpServletResponse,
      "/view.jsp");
}

製品コンテンツレンダラー用のJSPをレンダリングするには、 JSPRenderer使用します(この場合は、 liferay-q4f7.zip/q4f7-web/src/main/resources/META-INF/resources src/main/resources/META-INF/resourcesにあるview.jsp )。作成したJSPを見つけるために、 ServletContextパラメータとして指定します。

カスタムビュー用のJSPを追加する

<%
CPContentHelper cpContentHelper = (CPContentHelper)request.getAttribute(CPContentWebKeys.CP_CONTENT_HELPER);

CPSku cpSku = cpContentHelper.getDefaultCPSku(cpContentHelper.getCPCatalogEntry(request));
%>

CPContentHelperは、特定の製品に関する情報を取得するクラスです。

CPCatalogEntryは、表示されている製品そのものを表します。製品に関するより詳細な情報は、 CPSkuオブジェクトに含まれるデフォルトのSKUから取得できます。

<c:if test="<%= cpSku != null %>">
    SKU: <%= cpSku.getSku() %><br />
    Price: <%= cpSku.getPrice() %><br />
    Availability: <%= cpContentHelper.getAvailabilityLabel(request) %><br />
    Stock Quantity: <%= cpContentHelper.getStockQuantityLabel(request) %>
</c:if>

<liferay-util:dynamic-include key="com.liferay.commerce.product.content.web#/add_to_cart#" />

私たちは、Liferay Commerceのadd_to_cart_button.jspを使用して、「カートに追加」機能をビューに挿入します。

Language.propertiesに言語キーを追加します。

モジュール内のliferay-q4f7.zip/q4f7-web/src/main/resources/contentにあるLanguage.propertiesファイルに、言語キーとその値を追加します。

q4f7-commerce-product-content-renderer=Q4F7 Commerce Product Content Renderer

詳細については、 「アプリケーションのローカライズ」を参照してください。

結論

おめでとう!これで、 CPContentRendererインターフェースを実装するための基本を理解し、Liferay Commerceに新しい製品コンテンツレンダラーを追加することができました。