フィードバックを送信

カスタム注文ルールの実装

Liferayでは、特定の条件を満たした注文に対して注文ルールを設定することができます。 最少注文金額のルールは、すぐに利用可能です。 特定の値以下の注文のチェックアウトを防ぐことができます。 新しい注文ルールを追加するには、 COREntryType インターフェースを実装する必要があります。 詳しくは、 コマースの注文ルール をご覧ください。

カスタム注文ルールのデプロイと言語キーの追加

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q2.11。

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

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

  1. Acme Commerce Order Ruleをダウンロードし、解凍します。

    curl https://resources.learn.liferay.com/commerce/latest/en/developer-guide/order-management/liferay-x9k1.zip

unzip liferay-x9k1.zip

  2. サンプルをビルドしてデプロイします。

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

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

  3. Dockerコンテナコンソールでデプロイを確認します。

    STARTED com.acme.x9k1.impl_1.0.0

  4. 管理者としてログインし、 グローバルメニュー(Applications Menu icon) を開き、 ［コントロールパネル］ → ［言語オーバーライド］ をクリックしてください。 追加 ボタン(Add icon)をクリックし、以下のキーを追加します。

    言語キー値
    x9k1-minimum-order-quantityX9K1 最小注文数
    minimum-quantity最小数
    important

    Liferay DXP 7.4 U4以降、またはLiferay Portal 7.4 GA8以降の言語オーバーライドツールで言語キーを追加することができます。 以前のバージョンでは、ビルドとデプロイの前に、 /src/main/resources/content/の下にLanguage.propertiesファイルを追加し、キーを指定する必要があります。

  5. グローバルメニュー(Applications Menu icon) を開き、 ［commerce］ → ［注文ルール］ をクリックしてください。

  6. 追加 ボタン(Add icon)をクリックし、以下の情報を入力します。

    名前： Minimum Order Quantity - 3

    ［Description］： Testing minimum order quantity of 3 items

    ［Type］： X9K1 Minimum Order Quantity

    カスタム注文ルールの名前、説明、タイプを入力します。

  7. ［Submit］ をクリックします 。

  8. ［Configuration］ セクションで、 ［Minimum Quantity］ を 3 に設定します。

  9. 新しい注文ルールを有効にするには、［アクティブ］トグルをクリックします。

    最小数を3に設定し、有効トグルを使用して新しい注文ルールを有効にします。

  10. ［Publish］ をクリックします。

  11. グローバルメニュー(Applications Menu icon) を開き、 ［コントロールパネル］ → ［サイト］ をクリックし、新しいMiniumデモサイトを追加してください。

  12. バイヤーとしてログインし、商品をカートに追加します。 Submit をクリックしてチェックアウトします。

注文数が3個以下の場合、警告メッセージが表示されます。 この条件を満たすまで、チェックアウトはできません。

注文数が3個以下の場合、警告メッセージが表示されます。

important

注文ルールを有効にすると、すべてのアカウント、アカウントグループ、注文タイプ、チャネルに適用されます。 適合性をコントロールするには、注文ルールの*［適合性］*タブをクリックし、適切なオプションを選択します。

カスタム注文ルールの仕組み

この例では、主に9つの手順を示します。

  1. OSGi登録用に注文ルールに注釈を付ける
  2. COREntryTypeインターフェイスを確認する
  3. COREntryTypeの実装を完了する
  4. ディスプレイコンテキストを追加する
  5. 最小数値を取得するユーティリティクラスを追加する
  6. OSGi登録用のJSPコントリビュータに注釈を付ける
  7. COREntryTypeJSPContributorインターフェイスを確認する
  8. JSPコントリビューターの実装を完了する
  9. 注文ルールの設定をレンダリングするJSPを追加する

OSGi登録用に注文ルールに注釈を付ける

import java.util.Locale;

import org.osgi.service.component.annotations.Component;

@Component(
	property = {
		"commerce.order.rule.entry.type.key=x9k1-minimum-quantity-order-rule",
		"commerce.order.rule.entry.type.order:Integer=1"
	},

Liferay Commerceが注文ルールレジストリの他のものと区別できるように、注文ルールに個別のキーを指定する必要があります。 すでに使用されているキーを指定すると、既存の関連付けられているタイプが上書きされます。 順番は、ドロップダウンでのソート順で決まります。 この場合、順序は1であり、ドロップダウンの2番目の項目として表示されます。

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

以下のメソッドを実装します。

public boolean evaluate(COREntry corEntry, CommerceOrder commerceOrder) throws PortalException;

このメソッドは、注文ルールを評価し、条件が満たされるかどうかによって、trueまたはfalseを返します。

public String getErrorMessage(COREntry corEntry, CommerceOrder commerceOrder, Locale locale)  throws PortalException;

評価されたメソッドがfalseを返した場合、このメソッドはユーザーに警告を表示するエラーメッセージを含む文字列を返します。

public String getKey();

このメソッドは、注文ルールの一意のキーを返します。 既存のキーを使用すると、その注文ルールが上書きされます。

public String getLabel(Locale locale);

このメソッドは、UIに表示される注文ルールの名前を返します。 これは、言語キーまたは文字列です。

COREntryTypeの実装を完了する

)
public class X9K1MinimumQuantityCOREntryTypeImpl implements COREntryType {

@Override
public boolean evaluate(COREntry corEntry, CommerceOrder commerceOrder)
	throws PortalException {

	if (BigDecimalUtil.gt(
			BigDecimal.valueOf(_getMinimumQuantity(corEntry)),
			_getOrderQuantity(commerceOrder))) {

		return false;
	}

	return true;
}

@Override
public boolean evaluate(
	COREntry corEntry, List<COREntryTypeItem> corEntryTypeItems) {

	throw new UnsupportedOperationException();
}

@Override
public String getErrorMessage(
		COREntry corEntry, CommerceOrder commerceOrder, Locale locale)
	throws PortalException {

	StringBundler sb = new StringBundler();

	sb.append("Order quantity is less than the minimum quantity ");

	Double minimumQuantity = _getMinimumQuantity(corEntry);

	sb.append(minimumQuantity);

	sb.append(". Add ");

	Double delta = BigDecimalUtil.subtract(
		BigDecimal.valueOf(minimumQuantity),
		_getOrderQuantity(commerceOrder));

	sb.append(delta);

	sb.append(" more item");

	if (delta > 1) {
		sb.append("s");
	}

	sb.append(" to continue.");

	return sb.toString();
}

@Override
public String getKey() {
	return "x9k1-minimum-quantity-order-rule";
}

@Override
public String getLabel(Locale locale) {
	return LanguageUtil.get(locale, "x9k1-minimum-order-quantity");
}

@Override

オーダールールを完了するには、上記のメソッドを実装する必要があります。 注文ルールで設定された注文数と最小数を取得するための2つのユーティリティメソッドが追加されました。 最初に上書きされるメソッドは evaluate()で、現在の注文が注文ルールをパスするかどうかをチェックします。 そうであればtrueを、そうでなければfalseを返します。

2番目のメソッドは、注文ルールを満たさない注文のエラーメッセージを取得します。 すべての用語を含むStringBuilderから変換された Stringを返します。 3番目のメソッドはユニークキーを返し、最後のメソッドはUIに表示されるラベルを返します。

注文ルールの最小数と合計注文数を取得するための2つのメソッドが追加されています。 最初のメソッドは、ユーティリティクラス X9K1MinimumQuantityUtilにあります。 2 つ目のメソッドは _getOrderQuantity(CommerceOrder commerceOrder)です。 注文に含まれる個々の商品の数量の合計として、合計注文数を返します。

ディスプレイコンテキストを追加する

public class X9K1MinimumQuantityDisplayContext {

	public X9K1MinimumQuantityDisplayContext(COREntry corEntry) {
		_corEntry = corEntry;
	}

	public Double getMinimumQuantity() {
		return X9K1MinimumQuantityUtil.getMinimumQuantity(_corEntry);
	}

	private final COREntry _corEntry;

}

このコードは、 COREntry というタイプの単一のフィールドを含む表示コンテキストから、注文ルール用に設定された最小数の値を取得し、作成された注文ルールを使って設定されます。 表示コンテキストには、オーダールールに設定された最小数を取得するためのメソッドが1つあり、以下の詳細なユーティリティクラスを使用します。

最小数値を取得するユーティリティクラスを追加する

public class X9K1MinimumQuantityUtil {

	public static Double getMinimumQuantity(COREntry corEntry) {
		UnicodeProperties typeSettingsUnicodeProperties =
			UnicodePropertiesBuilder.fastLoad(
				corEntry.getTypeSettings()
			).build();

		return GetterUtil.getDouble(
			typeSettingsUnicodeProperties.getProperty("minimum-quantity"));
	}

}

X9K1MinimumQuantityUtilクラスは、注文ルールに設定された最小量を取得します。 JSPkeyで設定されたプロパティ名で値を取得します。

OSGi登録用のJSPコントリビュータに注釈を付ける

@Component(
	property = "commerce.order.rule.entry.type.jsp.contributor.key=x9k1-minimum-quantity-order-rule",
	service = COREntryTypeJSPContributor.class
)
public class X9K1MinimumQuantityCOREntryTypeJSPContributor
	implements COREntryTypeJSPContributor {

commerce.order.rule.entry.type.jsp.contributor.key プロパティは、JSPコントリビュータが実装される注文ルールを決定します。

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

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

COREntryTypeJSPContributorインターフェースは、JSPをレンダリングするメソッドを1つ含んでいます。 このメソッドは、引数として注文ルールのIDと、 HTTPServletRequestおよびHTTPServletResponse型のオブジェクトを要求します。

JSPコントリビューターの実装を完了する

public void render(
		long corEntryId, HttpServletRequest httpServletRequest,
		HttpServletResponse httpServletResponse)
	throws Exception {

	COREntry corEntry = _corEntryLocalService.getCOREntry(corEntryId);

	X9K1MinimumQuantityDisplayContext x9k1MinimumQuantityDisplayContext =
		new X9K1MinimumQuantityDisplayContext(corEntry);

	httpServletRequest.setAttribute(
		WebKeys.PORTLET_DISPLAY_CONTEXT, x9k1MinimumQuantityDisplayContext);

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

@Reference
private COREntryLocalService _corEntryLocalService;

@Reference
private JSPRenderer _jspRenderer;

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

JSPコントリビューターを完了させるには、render() メソッドを実装する必要があります。 _corEntryLocalServiceとcorEntryIdを用いて、 COREntryを取得します。 次に、取得したcorEntryを使用して、 X9K1MinimumQuantityDisplayContext型の新しい表示コンテキストを作成します。 このコンテキストには、httpServletRequestが設定されます。 servletContextは、bnd.bndファイルから Bundle-Symbolic-Nameを参照します。 JSPRendererはrenderJSP()メソッドでJSPファイルをレンダリングします。 引数として、JSPの相対パス、servletContext、 httpServletRequest、httpServletResponseを許可します。

注文ルールの設定をレンダリングするJSPを追加する

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

<%@ page import="com.acme.x9k1.internal.commerce.order.rule.web.display.context.X9K1MinimumQuantityDisplayContext" %>

<%@ page import="com.liferay.portal.kernel.util.WebKeys" %>

<%
X9K1MinimumQuantityDisplayContext x9k1MinimumQuantityDisplayContext = (X9K1MinimumQuantityDisplayContext)request.getAttribute(WebKeys.PORTLET_DISPLAY_CONTEXT);
%>

<div class="row">
	<div class="col">
		<commerce-ui:panel
			bodyClasses="flex-fill"
			title="Configuration"
		>
			<div class="row">
				<div class="col">
					<aui:input label="minimum-quantity" name="type--settings--minimum-quantity--" required="<%= true %>" type="text" value="<%= x9k1MinimumQuantityDisplayContext.getMinimumQuantity() %>">
						<aui:validator name="number" />
					</aui:input>
				</div>
			</div>
		</commerce-ui:panel>
	</div>
</div>

JSPには、注文ルールの最小数を許可する入力フィールドが1つあります。 これは、表示コンテキストを通じて取得され、カスタム注文ルール内で評価されます。 表示コンテキストはユーティリティクラスを使用し、タイプ設定コンフィギュレーションから最小量の名前を使用してフィールドを取得します。 getMinimumQuantity()メソッドは、既存の値がある場合はそれを取得します。

まとめ

　 これでCOREntryTypeインターフェースの実装の基本がわかり、Liferay Commerceに新しい注文ルールが追加されました。

Capability:
Commerce
Resource Type:
Official Documentation
Feature:
Java Development
Orders and Fulfillment
Deployment Approach:
Liferay PaaS
Liferay Self-Hosted

Capabilities

Product

Education

Contact Us

Connect

Powered by Liferay
© 2024 Liferay Inc. All Rights Reserved • Privacy Policy