データアクションのフック

2023-03-08

重要

データアクションのフック機能は廃止されました。パフォーマンスの問題を避けるために、データアクション層のビジネスロジックを変更する場合は、データアクションの上書きを使用することを強く推奨します。

この記事では、事前および事後のデータアクションイベントにフックし、必要に応じてさらにデータを処理する方法について説明します。

Dynamics 365 Commerce ソフトウェア開発キット (SDK) に含まれるモジュールは、既存のアクションを使用して、使用するモジュールのデータを取り込みます。データアクションレイヤーのビジネスロジックのいくつかを変更するシナリオがある場合があります。データアクションのオーバーライドのサポートに加えて、Commerce プラットフォームには、事前および事後のデータアクションイベントにフックする機能もあります。

サポートされているデータアクションのフックイベント

次のデータアクションのフックイベントがサポートされています。

preHook: データアクション入力を変更できるように、アクションが開始される前に実行する。このイベントは、キャッシュされていないデータアクションにのみ適用されます。
preReadOnlyHook: アクションが開始される前に実行するが、データアクション入力を変更することはできない。このイベントは、キャッシュされたデータアクションとキャッシュされていないデータアクションの両方に適用できます。
postHook: データアクションが完了した後に実行し、データアクション出力を変更することができる。このイベントは、キャッシュされていないデータアクションにのみ適用されます。
postReadOnlyHook: データアクションが完了した後に実行するが、データアクション出力を変更することはできない。このイベントは、キャッシュされたデータアクションとキャッシュされていないデータアクションの両方でサポートされています。

データアクションのフックを使用する

データアクションのフックを使用するために、add-data-action コマンドラインインターフェイス (CLI) を活用し、ファイルを作成することができます。次の例では、"\src\actions" ディレクトリに、"get-address-hook.action.ts" という名前のデータアクションファイルを作成しています。

yarn msdyn365 add-data-action get-address-hook

次に、データアクションファイルのコードを次のテンプレートコードで置き換え、必要なイベントに適切なコードを追加します。

import { createDataActionHook, IActionInput } from '@msdyn365-commerce/core';
// import { Cart } from '@msdyn365-commerce/retail-proxy';

const beforeCart = async (inputs: IActionInput | IActionInput[]) => {
    // tslint:disable-next-line: no-console
    console.info('Pre Hook');
};

const afterCart = async (_inputs: IActionInput | IActionInput[], cartName: string | string[]) => {
    // tslint:disable-next-line: no-console
    console.info('Post Hook');
};

const preReadOnlyCart = async (inputs: IActionInput | IActionInput[]) => {
    // tslint:disable-next-line: no-console
    console.info('Pre ReadOnly Hook');
};

const postReadOnlyCart = async (_inputs: IActionInput | IActionInput[], cartName: string | string[]) => {
    // tslint:disable-next-line: no-console
    console.info('Post ReadOnly Hook');
};

createDataActionHook({
    actionId: 'Action_ID',
    postHook: afterCart,
    preHook: beforeCart,
    preReadonlyHook: preReadOnlyCart,
    postReadonlyHook: postReadOnlyCart
});

メモ

Action_ID をイベントフックを追加するデータアクション ID に変更する必要があります。データアクションのモジュールライブラリの一覧は、SDK のディレクトリの …\Msdyn365.Commerce.Online\node_modules@msdyn365-commerce-modules\retail-actions\dist\lib にあります。