プロジェクトのビルドおよびデバッグ

[アーティクル]
03/08/2023

このチュートリアルでは、フリート管理アプリケーションでコードを分析してデバッグするために Visual Studio でのツールの使用について確認します。ブレークポイントを設定し、あるコードを変更し、その結果を構築する、単純な開発者のシナリオを検討します。

必要条件

コードおよび Visual Studio の以前の経験は、このチュートリアルを完全に活用するのに役立ちます。このチュートリアルでは、リモートデスクトップを使用して環境にアクセスし、インスタンスの管理者としてプロビジョニングする必要があります。

重要な概念

Visual Studio のデバッガーは、プロジェクトのコードの分析とデバッグに使用されます。
Visual Studio デバッガーの標準機能は、実行中のアプリケーションを調べているときに使用することができます。これらの機能には、変数の値の変更、ブレークポイントの設定などが含まれます。
IntelliSense および Visual Studio の他の機能は、効率的なコード編集および理解に不可欠です。
開発は反復的なプロセスです。コードを変更すると、プロジェクトが作成され、変更をテストできます。

シナリオ

レンタル会社は、顧客が有効期限を過ぎているクレジットカードを使用して車を借りているときに、不幸な出来事に見舞われました。開発者は、この状況の阻止を支援するために、アプリケーションを修正する責任を負います。 Visual Studio のデバッガーを使用して、問題を特定します。問題識別された後は、修正を実装するためにいくつかのコードを編集します。最後に、プロジェクトを構築し、修正プログラムが成功したことを検証します。

ブレークポイントまで実行

デスクトップで、Visual Studio ショートカットをダブルクリックして、開発環境を開きます。
FleetManagement ソリューションを開きます。 ファイルメニューで、開くをポイントし、プロジェクト/ソリューションをクリックします。
デスクトップを参照し、次に FleetManagement フォルダーを開きます。ソリューションファイルが自分のコンピューターにない場合、作成手順はフリート管理サンプルアプリケーションのエンドアンドエンドのシナリオに記載されています。
FleetManagement という名前のファイルを選択します。表示されるファイルタイプは SLN ファイルです。
開くをクリックします。ソリューションの読み込みには時間がかかる場合があります。
FleetManagement プロジェクトをスタートアッププロジェクトにします。 ソリューションエクスプローラー で、フリート管理 プロジェクトを右クリックして、コンテキストメニューで スタートアッププロジェクトとして設定 を選択します。
ソリューションエクスプローラー で、フリート管理 プロジェクトをダブルクリックして内容を表示します。
フリート管理プロジェクトのクラス フォルダーをダブルクリックします。 FMRentalCheckoutProcessor クラスを検索します。このクラスを右クリックしてから、開くをクリックします。または、ソリューションエクスプローラーウィンドウの上部にあるソリューションエクスプローラーの検索バーを使用できます。検索バーに名前を入力すると、ソリューションエクスプローラーで選択された対応するコンポーネントが表示されます。クラスで X++ コードを表示できるようになりました。このクラスには FinalizeRentalCheckout という名前のメソッドがあります。
最初のコメントの次の行にあるこのメソッドにブレークポイントを配置します。これを行うには、デバッガで実行を一時停止するコード行の左側の余白をクリックします。また、コード行の任意の場所をクリックして、F9 を押すことができます。次の図はブレークポイントを示しています。ブレークポイントは余白に赤で塗りつぶされた円として表示されます。

FinalizeRentalCheckout メソッドは、レンタルトランザクションが保存されるときに呼び出されます。このメソッドは、RentalTransactionAboutTobeFinalizedEvent という名前のデリゲートを呼び出します。このデリゲートで呼び出される、イベントハンドラーメソッドを実装することができます。デリゲートを呼び出すメソッドは、RentalConfirmation という名前のパラメーターを渡します。このパラメーターには、レンタルを許可するかブロックするかを示す値が含まれています。レンタルが許可されている場合、値に true が含まれ、ブロックされている場合は、値に false が含まれます。イベントハンドラーは、開発者がコード内で実装するために選択するテストに基づいてこの値を変更できます。この場合、クレジットカードの有効期限をテストするコードを変更します。
F5 を押してアプリケーションをデバッグのために起動するか、デバッグ メニューで デバッグ開始 をクリックします。これらの方法のいずれかでアプリケーションを開始することが重要です。しない場合は、Visual Studio デバッガーは起動されないため、設定されたブレークポイントのいずれかはヒットされません。注記: デバッガーは、コードの位置をソースの位置に関連付ける必要があります。アセンブリおよび net モジュールに沿って生成された PDB ファイルの消費を通じて実行されます。デバッガーは、グローバルツール設定の設定に示すように、PDBファイルから記号を読み込みます。読み込むシンボルを制御する設定を含むオプションページを開くには、ツール メニューで オプション を選択します。 Microsoft Dynamics 365 Finance グループで、デバッグ ページを選択します。このオプションが選択されている場合、システムは、現在のソリューションのコンポーネントに関連する PDB ファイルのみから記号を読み込みます。これにより起動時間が大幅に短縮されるため、このラボでは必ずそれを選択してください。このオプションを選択すると、現在のソリューションの外部にあるエンティティからソースコードを確認することはできません。数分後、ブラウザーが起動し、プロジェクトで選択されたスタートアップオブジェクトを表示します。
現在のレンタル ページが開きます。
1. アクションウィンドウで、編集をクリックします。
2. ページが表示されたら、表示/非表示 リストで リストの表示 をクリックします (または Ctrl+F8 を押します)。
既存のレンタルに変更を加えます。たとえば、編集をクリックして、レンタル期間が開始した時刻を変更します。
レンタルレコードを強制的に検証するには、保存をクリックします。ブレークポイントを配置するメソッドが呼び出されます。実行は、ブレークポイントを含むコード行で一時停止します。

アプリケーションがブレークポイントで一時停止している間に、アプリケーションの状態を調べることができます。通常 Visual Studio で開発するアプリケーションと同じ方法を使用します。たとえば、ツールヒントでその値を表示する変数またはパラメーターにカーソルを置きます。
Visual Studio の他のデバッグツールも利用することができます。たとえば、ローカルウィンドウは、実行が停止した場所のすべてのローカル変数を表示します。 Visual Studio の下部にある ローカル タブをクリックし、fmrentalrecord 変数を展開します。レコード内のすべてのフィールドの値を示す、レコードの内部状態が表示されます。

fmrentalrecord 変数の車両プロパティの値に注目してください。このプロパティは、FMRental テーブルの外部キーフィールドです。デバッガーを使用すると、FMVehicle テーブルの関連するレコードを調べることができます。 AutoIdentification フィールドグループに属する値を示します。
ブレークポイント ウィンドウには、設定されているすべてのブレークポイントが一覧表示されます。 ブレークポイント タブをクリックし、コンテンツを表示します。
F10 キーを数回押してコードを 1 行ずつ実行し、デバッガー機能の完全な補完を使用します。 ローカル ウィンドウが、実行される各ステートメントですぐに変数の値を更新することに注意します。
ツールバーで、続行をクリックするか、F5 を押します。
Microsoft Edge を閉じ、Fleet Management アプリケーションを閉じます。 Visual Studio はデバッグモードを終了します。代替はデバッグの停止をデバッグメニューから選択します。これにより、Microsoft Edge は開いたままになり、次のデバッグセッションをより早く開始することができます。

検証コードの追加

FinalizeRentalCheckout メソッドでは、開発者がコードを追加してレンタルの有効性を決定するために使用されるデリゲートを呼び出したことを確認します。期限切れのクレジットカードの問題を解決するには、クレジットカードが期限切れではないことを確認するために使用するイベントハンドラーを追加します。ラボを簡素化するために、ハンドラはデリゲートを含む同じファイルに追加されます。インスピレーションとして、次のコードを使用します。コードをコピーして貼り付けるのではなく、手動で入力して IntelliSense 機能の動作を参照してください。これらの機能により、Visual Studio ユーザーは高い生産性を期待することができます。

[SubscribesTo(classstr(FMRentalCheckoutProcessor), 
    delegatestr(FMRentalCheckoutProcessor, RentalTransactionAboutTobeFinalizedEvent))]
public static void RentalFinalizedEventHandler(FMRental rentalrecord, Struct rentalConfirmation)
{
    FMPaymentInformation paymentInfo;
    date ccExpiryDate, lastDayOfExpiryMonth;
    str s;

    select firstonly * from paymentInfo where paymentinfo.RecId == rentalRecord.PaymentInformationId;

    if (paymentInfo)
    {
        // Check if the payment info is valid
        // For now, we will check if the credit card is expired
        // Credit cards expire on the last day of the month indicated
        ccExpiryDate = mkdate(1, str2int(paymentInfo.ExpirationMonth), paymentInfo.ExpirationYear);
        lastDayOfExpiryMonth = endmth(ccExpiryDate);

        if (lastDayOfExpiryMonth < today())
        {
            rentalConfirmation.value('OktoRent', false);
            s = "Credit card validation failed for rental ";
        }
        else
        {
            s = "Credit card validation succeeded for rental ";
        }

        info (s + rentalrecord.RentalId);
    }
    else
    {
        rentalConfirmation.value('OktoRent', false);
        info ("No Credit card available for " + rentalrecord.RentalId);
    }
}

上記のコードはわかりやすいです。このメソッドは、SubscribesTo 属性を使用して、関連するデリゲートのハンドラーとしてマークされています (図参照) コードでは、顧客レコードが取得されてから、クレジットカードの日付が今日の日付と比較されます。クレジットカードの有効期限が過ぎている場合は、RentalConfirmation 構造でイベントハンドラーの値を設定し、顧客が車両の貸し出しの対象ではないことを通知します。これは、任意の数のハンドラーがデリゲートにサブスクライブできるようにするためです。ハンドラーでレンタルを続行しないと決定した場合、OkToRent フラグを設定します。優れた実装では、OkToRent フラグがすでに false に設定されていると判断した場合、分析を行わないことがあります。

FMRentalCheckoutProcessor.xpp ファイルで作業していることを確認します。新しいイベントハンドラー定義を FMRentalCheckoutProcessor クラスに追加することによって開始します。クラス定義の終了を示す波括弧 (}) のすぐ上の空の明細行に次のコードを追加します。
```
public static void RentalFinalizedEventHandler(FMRental rentalrecord, Struct rentalConfirmation)
{

}
```

イベントハンドラーの先頭に、属性を追加します。これらの属性は、イベントハンドラーがどのデリゲートに加入しているかを示します。

    [SubscribesTo(classstr(FMRentalCheckoutProcessor),
        delegatestr(FMRentalCheckoutProcessor, RentalTransactionAboutTobeFinalizedEvent))]
        public static void RentalFinalizedEventHandler(FMRental rentalrecord, Struct 
                                                                       RentalConfirmation)
    {

    }

ここで、クレジットカードの有効期限の値を確認するコードを追加します。完了したメソッドは、次のコードのようになります。

[SubscribesTo(classstr(FMRentalCheckoutProcessor), 
    delegatestr(FMRentalCheckoutProcessor, RentalTransactionAboutTobeFinalizedEvent))]
public static void RentalFinalizedEventHandler(FMRental rentalrecord, Struct rentalConfirmation)
{
    FMPaymentInformation paymentInfo;
    date ccExpiryDate, lastDayOfExpiryMonth;
    str s;

    select firstonly * from PaymentInfo where paymentinfo.RecId == rentalRecord.PaymentInformationId;

    if (paymentInfo)
    {
        // Check if the payment info is valid
        // For now we will check if the credit card is expired
        // Credit cards expire on the last day of the month indicated
        ccExpiryDate = mkdate(1, str2int(paymentInfo.ExpirationMonth), paymentInfo.ExpirationYear);
        lastDayOfExpiryMonth = endmth(ccExpiryDate);

        if (lastDayOfExpiryMonth < today())
        {
            rentalConfirmation.value('OktoRent', false);
            s = "Credit card validation failed for rental ";
        }
        else
        {
            s = "Credit card validation succeeded for rental ";
        }

        info (s + rentalrecord.RentalId);
    }
    else
    {
        rentalConfirmation.value('OktoRent', false);
        info ("No Credit card available for " + rentalrecord.RentalId);
    }
}

ハンドラーとデリゲートが 1 行の空白行で区切られていることを確認します。
Visual Studio のツールバーで、保存をクリックします。
コードに問題がなければ、フリート管理プロジェクトのコードをビルドします。これを行うには、ソリューションエクスプローラー で、FleetManagement プロジェクト名を右クリックし、Build をクリックします。コードが正しくない場合は、エラーまたは警告が表示される場合があります。その場合は、コードを修正し、再度ビルド警告やエラーが解決されるまでビルドを続行します。これで、リビジョンが意図したとおりに動作することを確認する準備が整いました。
デバッグメニューをクリックして、すべてのブレークポイントを削除します。
次のステートメントを含む明細行にあるイベントハンドラーメソッドに新しいブレークポイントを配置します。
```
if (lastDayOfExpiryMonth < today())
```
F5 キーを押してデバッグをアクティブにし、フリート管理サンプルを開始します。
前のセクションのステップ 11 で説明されているように現在のレンタル ページを参照してください。いずれかの予約を選択し、編集をクリックします。
顧客ドロップダウンリストで、一覧から Adrian Lannin を選択して保存をクリックします。実行は、イベントハンドラーメソッドで設定したブレークポイントで一時停止します。
F10 キーを 3 回押して、コードブロックを実行します。
F5 キーを押して続行します。その顧客が許可されていないことが表示されます。
同じレンタルで、顧客名を Phil Spencer に変更してから更新をクリックします。今回は、トランザクションが可能です。
Microsoft Edge を閉じます。
RentalFinalizedEventHandler メソッドで SubscribesTo をコメントにします。このステップでは、残りのチュートリアルで作業してもクレジットカードテストが実行されなくなります。

ベストプラクティス

このチュートリアルの前半では、プロジェクトにコードを追加し、変更を加えてソリューションをビルドする営業案件を得ました。ビルドプロセスが成功しなかったため、エラーウィンドウを参照する必要があります。このウィンドウを使用しているとき、エラーを説明する明細行をクリックすると、エラー状態になります。コンパイルエラーを表していないいくつかの診断メッセージが通知される場合があります。これらは、ベストプラクティス チェッカーからの診断です。このツールは、開発者が既知のベストプラクティスに違反したインスタンスをチェックして、違反が見つかったときに警告を表示します。ベストプラクティスルールは、コードの構成要素とメタデータの両方に適用されます。各ソフトウェアの開発組織は、実施するベストプラクティスのセットを持つ可能性が高いです。既存のベストプラクティスチェックの一部を無視する場合があります。これをサポートするために、報告されたベストプラクティスの診断セットを個々の開発者が変更することができます。これを実証するには、次の手順を実行します。

表示メニューで、エラーリストをクリックします。いくつかのベストプラクティス警告が表示されます。
Dynamics 365 メニューで、オプション をクリックします。 Dynamics 365 グループで、ベストプラクティス を選択します。
モデル ドロップダウンリストで、フリート管理モデルが選択されていることを確認します。ベストプラクティスルールは、特定のモデルに適用されます。
ベストプラクティスルールのセットの一部に対する選択内容をマークします。たとえば、CodeStyleRules のエントリを選択する場合、変数のベストプラクティスのガイドラインが検査されます。選択を更新した後、OK をクリックします。
プロジェクト名を右クリックして リビルド をクリックすることにより、フリート管理プロジェクトをリビルドします。指定したベストプラクティスルールの違反が エラー一覧 ウィンドウに表示されることがわかります。

次の方法で共有

プロジェクトのビルドおよびデバッグ

必要条件

重要な概念

シナリオ

ブレークポイントまで実行

検証コードの追加

ベストプラクティス

その他のリソース

次の方法で共有

プロジェクトのビルドおよびデバッグ

必要条件

重要な概念

シナリオ

ブレークポイントまで実行

検証コードの追加

ベスト プラクティス

その他のリソース

ベストプラクティス