カスタム通知タイプの実装
Liferay Commerceは、ストアの様々なイベントトリガーに対してメール通知を送信するように設定することができます。ニーズに合う、すぐに使える通知トリガーがない場合、自分で実装することができます。
新しい通知タイプを追加するには、CommerceNotificationTypeインターフェイスを実装する必要があります。通知テンプレートの設定方法や、利用可能な標準テンプレートの種類については、 「メールの送信」を参照してください。
このチュートリアルでは、Miniumデモサイトの初期化ツールを使用します。
通知タイプの概要
通知はチャネルに範囲設定されています。チャンネル設定の下に新しい通知テンプレートを作成することができ、通知タイプに基づいてトリガーされます。

上記の図は、G2F3 出荷作成通知テンプレートを示しています。これは、新しい出荷の作成のためにトリガーされます。出荷の作成中、通知テンプレートに記載されているように、受信者/受信者に通知が送信されます。テンプレートの宛先、件名、本文フィールドにワイルドカードを使用することができ、これらは送信前に解決されます。
通知タイプの展開と言語キーの追加
Liferay DXP の新しいインスタンスを起動するには、以下を実行します。
docker run -it -m 8g -p 8080:8080 liferay/dxp:2026.q1.9-lts
http://localhost:8080にアクセスし、メールアドレスtest@liferay.comとパスワードtestを使用して Liferay にサインインしてください。プロンプトが表示されたら、パスワードをlearnに変更してください。
次に、以下の手順に従ってください。
-
Acme Commerce Notification Typeをダウンロードして解凍してください。
curl https://resources.learn.liferay.com/examples/liferay-g2f3.zip -O unzip liferay-g2f3.zip -
liferay-g2f3にアクセスしてください。cd liferay-g2f3 -
サンプルをビルドしてデプロイします。
./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)注記このコマンドは、デプロイされたjarファイルをDockerコンテナの
/opt/liferay/osgi/modulesにコピーするのと同じです。 -
Dockerコンテナコンソールでデプロイを確認してください。
STARTED com.acme.g2f3.impl_1.0.0 -
管理者としてログインし、グローバルメニュー(
)を開き、コントロールパネル→サイトをクリックして、新しいMiniumデモサイトを追加します。 -
サイトを作成した後、グローバル メニュー(
) を再度開き、コントロール パネル→言語の上書きに移動します。「追加」 (
)をクリックして、次のキーを追加します。言語キー 価値 g2f3-出荷作成済み G2F3出荷が作成されました g2f3-出荷作成者名定義用語 注文を作成したアカウント名 g2f3-注文配送先住所の定義用語 お届け先の住所 g2f3-出荷ID定義用語 出荷ID g2f3-shipment-creator-email-definition-term 出荷を作成したユーザーのメールアドレス 重要Liferay DXP 7.4 U4+ または Liferay Portal 7.4 GA8+ の言語オーバーライドツールで言語キーを追加できます。以前のバージョンでは、ビルドとデプロイの前に
/src/main/resources/content/の下にキーを含むLanguage.propertiesファイルを追加する必要があります。 -
次に、グローバルメニュー(
)を開き、コマース→チャネルに移動します。 -
「Minium」を選択し、 「通知テンプレート」に進みます。
-
新しいテンプレートを作成するには、 「追加」 (
)をクリックします。名前:テスト用G2F3出荷が作成されました
タイプ: G2F3 出荷が作成されました
宛先: [%SHIPMENT_CREATOR_EMAIL%]
送信元アドレス: test@liferay.com
送信者名:管理者
件名:新規出荷作成 - 出荷ID:[%SHIPMENT_ID%]
体:
こんにちは、
[%SHIPMENT_CREATOR_NAME% ] によって新しい出荷が作成されました
配送先住所: [%ORDER_SHIPPING_ADDRESS%]
ありがとう、
管理者
-
「保存」をクリックしてください。
-
ログアウトして購入者としてログインし、ストアで新しい注文を行ってください。
-
ログアウトして管理者として再度ログインし、グローバルメニュー(
)を開き、コマース→注文に移動します。 -
注文を選択し、 「注文を承認する」をクリックしてください。次に「出荷を作成」をクリックします。
-
受信トレイに通知メールが届いているかご確認ください。
ローカル開発環境でこれらの通知をテストするには、MockMock(https://github.com/tweakers/MockMock)のような偽のSMTPサーバーを使用できます。 portal-ext.propertiesファイルに次の行を追加してください: mail.send.blacklist=noreply@liferay.com, noreply@domain.invalid, test@domain.invalid 。 java -jar MockMock.jarを使用してjarファイルを実行し、 localhost:8282で受信したメールを確認してください。
カスタム通知タイプの仕組み
この例は、主に6つのステップで構成されています。最初に、OSGi登録用にクラスに注釈を付ける必要があります。次に、 CommerceNotificationTypeインターフェースを確認してください。次に、カスタムCommerceNotificationTypeの実装を完了します。
その後、 CommerceShipmentクラスのModelListenerを作成します。次に、 CommerceDefinitionTermContributorインターフェースを確認してください。最後に、新しい通知のワイルドカードを解決するために、用語貢献者を実装します。
- OSGi登録用にクラスに注釈を付ける
- CommerceNotificationTypeインターフェースの確認
- 通知タイプの完了
- CommerceShipmentのModelListenerを作成します。
- CommerceDefinitionTermContributorインターフェースの確認
- 用語コントリビューターを完成する
OSGi登録のためにクラスに注釈を付ける
Liferay Commerceが通知ステータスレジストリ内の他の通知タイプと区別できるように、通知タイプごとに固有のキーを指定する必要があります。既に使われているキーを指定すると、既存の関連付けられた型が上書きされます。順序によって、ドロップダウンリストでの並び順が決まります。この場合、 「出荷待ち注文」通知タイプでは注文番号が50となり、 「一部出荷済み注文」通知タイプでは注文番号が60となります。ステータスをその2つの間に配置するには、順序がその2つの数字の間、この場合は51の間になければなりません。
CommerceNotificationTypeインターフェースを確認してください。
以下のメソッドを実装してください。
public String getClassName(Object object);
このメソッドは、通知タイプが実装されているクラスの名前を返します。
public long getClassPK(Object object);
このメソッドは、オブジェクトの主キーを返します。
public String getKey();
このメソッドは、通知タイプの固有キーを返します。既存のキーを使用すると、その通知タイプは上書きされます。
public String getLabel(Locale locale);
このメソッドは、UIに表示される通知タイプの名前を返します。この名前は、言語キーまたは文字列である可能性があります。
通知の種類を入力してください
@Override
public String getClassName(Object object) {
if (!(object instanceof CommerceShipment)) {
return null;
}
return CommerceShipment.class.getName();
}
@Override
public long getClassPK(Object object) {
if (!(object instanceof CommerceShipment)) {
return 0;
}
CommerceShipment commerceShipment = (CommerceShipment)object;
return commerceShipment.getPrimaryKey();
}
@Override
public String getKey() {
return "g2f3";
}
@Override
public String getLabel(Locale locale) {
return LanguageUtil.get(locale, "g2f3-shipment-created");
}
通知タイプの実装を完了するには、上記のメソッドを実装する必要があります。最初の方法では、オブジェクトがCommerceShipment型であるかどうかを確認し、そうであればそのクラス名を返します。 2番目の方法では、これを再度チェックし、条件が満たされていれば出荷の主キーを返します。 3番目のメソッドは一意のキーを返し、最後のメソッドはUIに表示されるラベルを返します。
CommerceShipment用のModelListenerを作成します
@Component(service = ModelListener.class)
public class G2F3CommerceShipmentModelListener
extends BaseModelListener<CommerceShipment> {
@Override
public void onAfterCreate(CommerceShipment commerceShipment)
throws ModelListenerException {
try {
_commerceNotificationHelper.sendNotifications(
commerceShipment.getGroupId(), commerceShipment.getUserId(),
"g2f3", commerceShipment);
}
catch (PortalException portalException) {
if (_log.isDebugEnabled()) {
_log.debug(portalException);
}
}
}
private static final Log _log = LogFactoryUtil.getLog(
G2F3CommerceShipmentModelListener.class);
@Reference
private CommerceNotificationHelper _commerceNotificationHelper;
}
出荷が作成されるたびに通知をトリガーするには、 ModelListenerインターフェースを実装するBaseModelListenerクラスを拡張する必要があります。このインターフェースには、エンティティの作成、更新、削除などのイベントでトリガーされるメソッドが含まれています。 onAfterCreate(T model)メソッドを使用すると、出荷が作成されたときに通知をトリガーできます。
CommerceDefinitionTermContributor インターフェースを確認してください。
以下のメソッドを実装してください。
public String getFilledTerm(String term, Object object, Locale locale) throws PortalException;
このメソッドは、ワイルドカードを適切な値に置き換え、それを文字列として返します。
public String getLabel(String term, Locale locale);
このメソッドは、UIに表示される用語の貢献者の名前を返します。この名前は、言語キーまたは文字列である可能性があります。
public List<String> getTerms();
このメソッドは、通知タイプで使用可能なすべての用語貢献者を返します。
学期貢献者を完了してください
用語の貢献者は、[宛先]、[件名]、[本文] フィールドに含まれるワイルドカードを解決します。この例では、2つの用語貢献者が実装されています。1つは件名と本文のフィールド用、もう1つは宛先フィールド用です。
本文と件名に対してgetFilledTermメソッドを実装する
@Override
public String getFilledTerm(String term, Object object, Locale locale)
throws PortalException {
if (!(object instanceof CommerceShipment)) {
return term;
}
CommerceShipment commerceShipment = (CommerceShipment)object;
if (term.equals(_SHIPMENT_CREATOR_NAME)) {
AccountEntry accountEntry = commerceShipment.getAccountEntry();
if (accountEntry.isPersonalAccount()) {
User user = _userLocalService.getUser(accountEntry.getUserId());
return user.getFullName(true, true);
}
return accountEntry.getName();
}
if (term.equals(_ORDER_SHIPPING_ADDRESS)) {
CommerceAddress commerceAddress =
commerceShipment.fetchCommerceAddress();
return commerceAddress.getStreet1() + ", " +
commerceAddress.getCity() + ", " + commerceAddress.getZip();
}
if (term.equals(_SHIPMENT_ID)) {
if (commerceShipment == null) {
return term;
}
return String.valueOf(commerceShipment.getCommerceShipmentId());
}
return term;
}
ワイルドカードを解決する前に、オブジェクトが null であるか、またはCommerceShipment型であるかどうかを確認するチェックがあります。そして、その用語にワイルドカードが含まれている場合、ワイルドカードは出荷作成者の名前、出荷先住所、または出荷IDに置き換えられます。出荷作成者の名前については、出荷に使用されたアカウント名が返されます。配送先住所は、番地、都市名、郵便番号を連結した文字列として返されます。出荷IDは出荷オブジェクトから直接返されます。
Recipient の getFilledTerm メソッドを実装します。
@Override
public String getFilledTerm(String term, Object object, Locale locale)
throws PortalException {
if (!(object instanceof CommerceShipment)) {
return term;
}
CommerceShipment commerceShipment = (CommerceShipment)object;
if (commerceShipment == null) {
return term;
}
if (term.equals(_SHIPMENT_CREATOR_EMAIL)) {
AccountEntry accountEntry = commerceShipment.getAccountEntry();
if (accountEntry.isPersonalAccount()) {
User user = _userLocalService.getUser(accountEntry.getUserId());
return String.valueOf(user.getUserId());
}
return String.valueOf(commerceShipment.getUserId());
}
return term;
}
ワイルドカードを解決する前に、オブジェクトが null であるか、またはCommerceShipment型であるかどうかを確認するチェックがあります。そして、検索語にワイルドカードが含まれている場合、ワイルドカードはアカウントのユーザーIDに置き換えられます。通知が送信される際、このIDを使用してユーザーのメールアドレスを特定します。
getLabelメソッドとgetTermsメソッドを実装する
getLabelメソッドは、UI に表示されている用語の名前を返します。これを行うには、言語キーを使用するか、直接文字列を返すことができます。
@Override
public String getLabel(String term, Locale locale) {
return LanguageUtil.get(locale, _languageKeys.get(term));
}
このメソッドは、通知タイプで使用可能なすべての用語貢献者を返します。これを行うには、言語キーを使用するか、UIに用語を表示するハードコードされた文字列を直接返すことができます。
@Override
public List<String> getTerms() {
return new ArrayList<>(_languageKeys.keySet());
}
結論
これで、 CommerceNotificationTypeインターフェースを実装するための基本が理解できました。また、通知の仕組みの基本と、 MessageListenerを使用して独自の通知タイプを送信する方法についても理解している必要があります。