新しいCommerceプラグインプロジェクトを作成するためのベストプラクティス

定数値の定義

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

カスタムプラグインでは、定数文字列の使用が必要な場合があります。たとえば、クラスでPipelineDisplayName属性を使用してパイプラインブロックに名前を割り当てる場合は、定数値を定義する必要があります。

新しいプラグインで定数値を定義するときは、次のベストプラクティスに従ってください。

カスタムプラグインにクラスを1つ作成して、すべての定数値を格納します。
定数値を定義する新しいクラスには、FunctionalAreaConstantsという命名規則を使用します。たとえば、PaymentsBraintreeConstants.csのようになります。
定数値を定義するクラスをプラグインプロジェクトフォルダのルートに配置します。
各定数をパブリック定数文字列 (public const string) として宣言します。
目的または各定数文字列について簡単に説明します。

サンプルプラグインプロジェクトPlugin.Sample.Payments.Braintree(Commerce Engine SDK内)のPaymentsBraintreeConstants.csクラスは、定数定義クラスの良い例を提供します。

namespace Plugin.Sample.Payments.Braintree
{
    /// <summary>
    /// The payments constants.
    /// </summary>
    public static class PaymentsBraintreeConstants
    {
        /// <summary>
        /// The get client token block name.
        /// </summary>
        public const string GetClientTokenBlock = "PaymentsBraintree.block.getclienttoken";

        /// <summary>
        /// The add federated payment block
        /// </summary>
        public const string UpdateFederatedPaymentBlock = "PaymentsBraintree.block.updatefederatedpayment";

        /// <summary>
        /// The update order after federated payment settlement block name
        /// </summary>
        public const string UpdateOrderAfterFederatedPaymentSettlementBlock = "PaymentsBraintree.block.UpdateOrderAfterFederatedPaymentSettlement";

        /// <summary>
        /// The create federated payment block
        /// </summary>
        public const string CreateFederatedPaymentBlock = "PaymentsBraintree.block.createfederatedpayment";

        /// <summary>
        /// The settle federated payment block name
        /// </summary>
        public const string SettleFederatedPaymentBlock = "PaymentsBraintree.block.SettleFederatedPayment";

        /// <summary>
        /// The void cancel order federated payment block
        /// </summary>
        public const string VoidCancelOrderFederatedPaymentBlock = "PaymentsBraintree.block.voidcancelorderfederatedpayment";

        /// <summary>
        /// The refund federated payment block
        /// </summary>
        public const string RefundFederatedPaymentBlock = "PaymentsBraintree.block.refundfederatedpayment";

        /// <summary>
        /// The registered plugin block name.
        /// </summary>
        public const string RegisteredPluginBlock = "PaymentsBraintree.block.RegisteredPlugin";

        /// <summary>
        /// Settle order sales activities block name.
        /// </summary>
        public const string SettleOrderSalesActivitiesBlock = "PaymentsBraintree.block.SettleOrderSalesActivities";
    }
}

この記事を改善するための提案がある場合は、お知らせください!