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

カスタムチェックアウトステップの実装

このチュートリアルでは、 CommerceCheckoutStep インターフェイスを実装してカスタムチェックアウトステップを追加する方法を説明します。

チェックアウトステップは、お客様のチェックアウトプロセスを1つの画面で示します。 Liferay Commerce には、支払い方法ステップや注文確認ステップなどの重要なステップを含む、すぐに使用できるチェックアウトステップがいくつか用意されています。

すぐに使えるチェックアウトステップ

サンプルをデプロイする

このセクションでは、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に変更します。

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

Acme Commerce Checkout Stepをダウンロードして解凍します。

curl https://resources.learn.liferay.com/commerce/latest/en/developer-guide/sales/liferay-n8n6.zip -O

unzip liferay-n8n6.zip

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

このコマンドは、デプロイされたjarをDockerコンテナ上の /opt/liferay/osgi/modules にコピーするのと同じです。
Dockerコンテナコンソールでデプロイを確認します。
```
STARTED com.acme.n8n6.web_1.0.0
```
サンプルのチェックアウトステップが追加されたことを確認します。ブラウザーでhttps://localhost:8080を開き、Liferay Commerceサイトのカタログに移動します。カートにアイテムを追加し、カートを表示して、［チェックアウト］をクリックします。新しい「N8N6 コマースチェックアウトステップ」がチェックアウトステップのリストに表示されます。

新しいチェックアウトステップ

これで、CommerceCheckoutStepを実装する新しいチェックアウトステップのビルドとデプロイが完了しました。

次に、詳細をさらに詳しく見ていきましょう。

サンプルの説明

このセクションでは、デプロイした例を確認します。まず、OSGi 登録用のクラスにアノテーションを付けます。次に、 CommerceCheckoutStep インターフェースを確認します。 3 番目に、 CommerceCheckoutStepの実装を完了します。

注

CommerceCheckoutStepの実装を簡素化するために、基本機能として BaseCommerceCheckoutStep を拡張します。

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

@Component(
   property = {
   "commerce.checkout.step.name=n8n6",
   "commerce.checkout.step.order:Integer=21"
   },
   service = CommerceCheckoutStep.class
)
public class N8N6CommerceCheckoutStep extends BaseCommerceCheckoutStep {

Liferay Commerceがこのチェックアウトステップを既存のチェックアウトステップと区別できるように、チェックアウトステップ名は一意の値である必要があります。

commerce.checkout.step.order 値は、チェックアウトプロセスのどの段階でチェックアウトステップが表示されるかを示します。たとえば、配送方法のチェックアウトステップの値は20です。チェックアウトステップに 21 の値を指定すると、配送方法のステップの直後に表示されるようになります。

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

基本クラスを拡張することに加えて、次のメソッドを実装します。

public String getName();

このメソッドは、チェックアウトステップの名前を返します。この名前は、UI に表示される名前に対応する言語キーになります。

public void processAction(
      ActionRequest actionRequest, ActionResponse actionResponse)
   throws Exception;

バックエンド処理が必要な場合は、processActionメソッドを使用して、ActionRequestを介して渡された情報でビジネスロジックを実装できます。

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

ここで、チェックアウト手順用のカスタマイズされた画面をレンダリングするためのコードを追加します。

チェックアウトステップを完了する

チェックアウトステップは、カスタム画面と入力を処理するバックエンドロジックで構成されます。以下を行います。

モジュールにServletContextを構成する。
renderメソッドを実装します。
ビジネスロジックをprocessActionに追加する。
JSPを追加して、カスタム画面をレンダリングする。
言語キーをLanguage.propertiesに追加する。

モジュールに`ServletContext`を構成する

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

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

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

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

`render`メソッドを実装する

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

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

@Reference
private JSPRenderer _jspRenderer;

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

JSPRenderer を使用して、チェックアウト手順の JSP をレンダリングします (この場合、 liferay-n8n6.zip/n8n6-web/src/main/resources/META-INF/resources内の terms_and_conditions.jsp )。作成した JSP を見つけるために、 ServletContext をパラメーターとして指定します。

n8n6-commerce-checkout-step=N8N6 Commerce Checkout Step

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

さいごに

　これで、CommerceCheckoutStepインターフェイスを実装するための基本を理解し、Liferay Commerceに新しいチェックアウトステップを追加しました。

Capability:

Commerce

Resource Type:

Official Documentation

Feature:

Java Development

Order Processing

Payment

Deployment Approach:

Liferay PaaS

Liferay Self-Hosted