より優れたコードを記述するためのデバッグ手法とツール

[アーティクル]
06/13/2023

適用対象:Visual Studio Visual Studio for Mac Visual Studio Code

コード内のバグとエラーの修正は、時間がかかり、場合によっては面倒な作業になることがあります。効率的なデバッグ方法について学習するには時間がかかりますが、Visual Studio のような強力な IDE を使用すると、仕事がはるかに簡単になります。 IDE を使用すると、エラーの修正やコードのデバッグをより迅速に行うことができます。それだけでなく、より適切なコードを記述してバグを減らすこともできます。この記事の目的は、"バグ修正" プロセスの全体像を示すことであり、コードアナライザーを使用するタイミング、デバッガーを使用するタイミング、例外を修正する方法、意図したようにコーディングする方法を知ることができます。デバッガーを使用する必要があることが既にわかっている場合は、「デバッガーでのはじめに」を参照してください。

この記事では、IDE を利用してコーディングセッションの生産性を高める方法について説明します。ここでは、次のようないくつかのタスクについて説明します。

IDE のコードアナライザーを利用して、デバッグ用にコードを準備する
例外を修正する方法 (実行時エラー)
意図したコーディングでバグを最小化する方法 (アサートの使用)
どのようなときにデバッガーを使用するか

これらのタスクをデモンストレーションするために、アプリをデバッグするときに発生する最も一般的な種類のエラーとバグをいくつか示します。サンプルコードは C# ですが、概念情報は一般に、C++、Visual Basic、JavaScript、Visual Studio でサポートされているその他の言語にも適用されます (特別な記載のない限り)。スクリーンショットは C# になっています。

バグやエラーが含まれるサンプルアプリを作成する

次のコードには、Visual Studio IDE を使用して修正できるいくつかのバグがあります。ここでのアプリは、ある操作からの JSON データの取得、データのオブジェクトへの逆シリアル化、新しいデータでの簡単なリストの更新をシミュレートするシンプルなアプリです。

アプリを作成するには:

Visual Studio および .NET デスクトップ開発ワークロードをインストールしている必要があります。

Visual Studio をまだインストールしていない場合は、Visual Studio のダウンロードページに移動し、無料試用版をインストールしてください。

Visual Studio は既にインストールされていて、ワークロードだけをインストールする必要がある場合は、 [ツール]>[ツールと機能を取得] の順にクリックします。 Visual Studio インストーラーが起動します。 .NET デスクトップ開発ワークロードを選択し、 [変更] を選択します。
Visual Studio を開きます。

スタートウィンドウで、 [新しいプロジェクトの作成] を選択します。検索ボックスに「コンソール」と入力し、.NET 用の [コンソールアプリ] のいずれかを選択します。 [次へ] を選択します。「Console_Parse_JSON」のようなプロジェクト名を入力し、 [次へ] または [作成] をクリックします。いずれかのオプションを使用できます。

推奨されるターゲットフレームワークまたは .NET 6 を選択し、 [作成] を選択します。

.NET プロジェクトテンプレート用の [コンソールアプリ] が表示されない場合は、[ツール]>[ツールと機能を取得] に移動して、Visual Studio インストーラーを開きます。 .NET デスクトップ開発ワークロードを選択し、 [変更] を選択します。

Visual Studio によってコンソールプロジェクトが作成され、ソリューションエクスプローラーの右側のウィンドウに表示されます。
プロジェクトの Program.cs ファイルの既定のコードを、次のサンプルコードに置き換えます。

using System;
using System.Collections.Generic;
using System.Runtime.Serialization.Json;
using System.Runtime.Serialization;
using System.IO;

namespace Console_Parse_JSON
{
    class Program
    {
        static void Main(string[] args)
        {
            var localDB = LoadRecords();
            string data = GetJsonData();

            User[] users = ReadToObject(data);

            UpdateRecords(localDB, users);

            for (int i = 0; i < users.Length; i++)
            {
                List<User> result = localDB.FindAll(delegate (User u) {
                    return u.lastname == users[i].lastname;
                    });
                foreach (var item in result)
                {
                    Console.WriteLine($"Matching Record, got name={item.firstname}, lastname={item.lastname}, age={item.totalpoints}");
                }
            }

            Console.ReadKey();
        }

        // Deserialize a JSON stream to a User object.
        public static User[] ReadToObject(string json)
        {
            User deserializedUser = new User();
            User[] users = { };
            MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(json));
            DataContractJsonSerializer ser = new DataContractJsonSerializer(users.GetType());

            users = ser.ReadObject(ms) as User[];

            ms.Close();
            return users;
        }

        // Simulated operation that returns JSON data.
        public static string GetJsonData()
        {
            string str = "[{ \"points\":4o,\"firstname\":\"Fred\",\"lastname\":\"Smith\"},{\"lastName\":\"Jackson\"}]";
            return str;
        }

        public static List<User> LoadRecords()
        {
            var db = new List<User> { };
            User user1 = new User();
            user1.firstname = "Joe";
            user1.lastname = "Smith";
            user1.totalpoints = 41;

            db.Add(user1);

            User user2 = new User();
            user2.firstname = "Pete";
            user2.lastname = "Peterson";
            user2.totalpoints = 30;

            db.Add(user2);

            return db;
        }
        public static void UpdateRecords(List<User> db, User[] users)
        {
            bool existingUser = false;

            for (int i = 0; i < users.Length; i++)
            {
                foreach (var item in db)
                {
                    if (item.lastname == users[i].lastname && item.firstname == users[i].firstname)
                    {
                        existingUser = true;
                        item.totalpoints += users[i].points;

                    }
                }
                if (existingUser == false)
                {
                    User user = new User();
                    user.firstname = users[i].firstname;
                    user.lastname = users[i].lastname;
                    user.totalpoints = users[i].points;

                    db.Add(user);
                }
            }
        }
    }

    [DataContract]
    internal class User
    {
        [DataMember]
        internal string firstname;

        [DataMember]
        internal string lastname;

        [DataMember]
        // internal double points;
        internal string points;

        [DataMember]
        internal int totalpoints;
    }
}

赤と緑の波線を探します。

サンプルアプリを起動してデバッガーを実行する前に、コードエディターのコードで赤と緑の波線を確認します。これらは、IDE のコードアナライザーによって識別されたエラーと警告を表します。赤い波線はコンパイル時エラーであり、コードを実行する前に修正する必要があります。緑の波線は警告です。多くの場合、警告を修正せずにアプリを実行できますが、バグの原因となる場合があり、多くの場合、警告を調査することによって時間を節約し問題を減らすことができます。リストビューの方がよければ、これらの警告とエラーは [エラー一覧] ウィンドウにも表示されます。

サンプルアプリでは、修正が必要ないくつかの赤い波線と、1 つの緑の波線が表示されます。 1 つ目のエラーは次のとおりです。

Error showing as a red squiggle

このエラーを修正するには、電球アイコンによって表される IDE の別の機能を使用します。

電球を確認する

最初の赤い波線は、コンパイル時のエラーを表します。それをポイントすると、The name `Encoding` does not exist in the current context というメッセージが表示されます。

このエラーの左下に電球アイコンが表示されることに注意してください。ドライバーアイコンと共に、電球アイコンは、コードをインラインで修正またはリファクタリングするのに役立つクイックアクションを表します。電球は、修正する "必要がある" 問題を表します。ドライバーは、修正することができる問題を示します。左側の using System.Text をクリックし、最初の修正候補を使用してこのエラーを解決します。

Use the light bulb to fix code

この項目をクリックすると、Visual Studio によって using System.Text ステートメントが Program.cs ファイルの先頭に追加され、赤い波線が表示されなくなります。 (修正候補の効果がわからない場合は、修正を適用する前に、右側の [変更のプレビュー] リンクを選択します)。

前述のエラーは、コードに新しい using ステートメントを追加することによって通常は修正される、一般的なエラーです。このエラーには、共通の類似するエラーがいくつかあります (The type or namespace `Name` cannot be found. など)。この種のエラーでは、アセンブリ参照が存在しないこと (プロジェクトを右クリックして [追加]>[参照] を選択)、名前のスペルミス、または追加する必要のある足りないライブラリ (C# の場合は、プロジェクトを右クリックして [NuGet パッケージの管理] を選択) が示されている場合があります。

残りのエラーと警告を修正する

このコードには、調べる必要のある波線がさらにいくつかあります。ここでは、一般的な型変換エラーを見ます。波線をポイントすると、コードで string から int への変換が試みられていることがわかります。これは、変換を行う明示的なコードを追加しない限り、サポートされていません。

Type conversion error

コードアナライザーでは意図を推測できないため、今度は役に立つ電球は表示されません。このエラーを修正するには、コードの意図を理解する必要があります。この例では、totalpoints に points を追加しようとしているため、points が数値 (整数) でなければならないことは簡単にわかります。

このエラーを修正するには、User クラスの points メンバーを変更します。変更前は次のようになっています。

[DataMember]
internal string points;

変更後は次のようになります。

[DataMember]
internal int points;

コードエディターの赤い波線が消えます。

次に、points データメンバーの宣言で緑色の波線をポイントします。コードアナライザーで、変数に値が割り当てられていないことが示されます。

Warning message for unassigned variable

通常、これは修正する必要がある問題を表します。ただし、サンプルアプリでは、逆シリアル化プロセスの間に points 変数にデータを格納し、その値を totalpoints データメンバーに追加しています。この例では、コードの意図がわかっていて、警告を無視しても問題ありません。ただし、警告を除去したい場合は、次のコードを置き換えることができます。

item.totalpoints = users[i].points;

以下に置き換えます。

item.points = users[i].points;
item.totalpoints += users[i].points;

緑の波線が消えます。

例外を修正する

すべての赤い波線を修正し、すべての緑の波線を解決するか、少なくとも調査したら、デバッガーを起動してアプリを実行できる状態になります。

F5 キー ([デバッグ] > [デバッグの開始]) を押すか、デバッグツールバーの [デバッグの開始] ボタン Start Debugging を選択します。

この時点で、サンプルアプリからは SerializationException 例外 (実行時エラー) がスローされます。つまり、アプリは、シリアル化しようとしているデータで止まっています。デバッグモード (デバッガーがアタッチされた状態) でアプリを起動したため、デバッガーの例外ヘルパーにより、例外をスローしたコードに直接移動し、役に立つエラーメッセージが表示されます。

A SerializationException occurs

このエラーメッセージでは、値 4o を整数として解析できないことが示されています。したがって、この例では、データが不適切であることがわかります。4o を 40 にする必要があります。ただし、実際のシナリオでデータを制御できない場合 (web サービスから取得する場合など) は、どうすればよいでしょうか。これをどのように解決すればよいでしょう。

例外が発生した場合は、いくつかの質問に答える必要があります。

この例外は、修正できる単なるバグか。または
この例外は、ユーザーが遭遇する可能性があるものか。

前者の場合は、バグを修正します。 (サンプルアプリでは、不適切なデータを修正することを意味します)。後者の場合は、try/catch ブロックを使用して、コードで例外を処理することが必要になる場合があります (次のセクションでは、他の可能な戦略について説明します)。サンプルアプリでは、次のコードを置き換えます。

users = ser.ReadObject(ms) as User[];

を、次のコードで置換します。

try
{
    users = ser.ReadObject(ms) as User[];
}
catch (SerializationException)
{
    Console.WriteLine("Give user some info or instructions, if necessary");
    // Take appropriate action for your app
}

try/catch ブロックにはパフォーマンスコストがあるため、どうしても必要なときにのみ使用します。つまり、(a) アプリのリリースバージョンで発生する可能性があり、(b) メソッドのドキュメントで例外をチェックする必要があることが示されている場合です (ドキュメントが完全であるものとして)。多くの場合は、例外を適切に処理することができ、ユーザーはそのことを知る必要はありません。

例外処理のいくつかの重要なヒントを次に示します。

catch (Exception) {} のような空の catch ブロックは使わないようにします。エラーを公開または処理するための適切なアクションが実行されません。空または情報のない catch ブロックを使用すると、例外が隠され、コードのデバッグが容易になるのではなく、困難になる可能性があります。
例外をスローする特定の関数 (サンプルアプリでは ReadObject) に対して try/catch ブロックを使用します。コードの大きなチャンクに対して使用すると、エラーの場所がわからなくなります。たとえば、次に示すような、親関数 ReadToObject の呼び出しに対して try/catch ブロックを使用しないでください。使用すると、例外が発生した場所を正確に把握できなくなります。
```
// Don't do this
try
{
    User[] users = ReadToObject(data);
}
catch (SerializationException)
{
}
```
アプリによく知らない関数が含まれる場合は (特に、Web 要求など、外部データと対話するもの)、ドキュメントを調べて、関数でスローされる可能性がある例外を確認します。これは、適切なエラー処理とアプリのデバッグのために不可欠な情報です。

サンプルアプリの場合、4o を 40 に変更することで、GetJsonData メソッドの SerializationException を修正します。

アサートを使用してコードの意図を明確にする

デバッグツールバーの [再起動] Restart App ボタンをクリックします (Ctrl + Shift + F5)。これにより、アプリがより少い手順で再起動されます。コンソールウィンドウに次の出力が表示されます。

Null value in output

この出力には何か問題があることがわかります。 3 番目のレコードの name と lastname が空白です。

これは、関数内で assert ステートメントを使用するという、あまり利用されていない、役に立つコーディング手法について説明するよい機会です。次のコードを追加することで、firstname と lastname が null ではないことを確認する実行時チェックを組み込みます。 UpdateRecords メソッドの次のコードを置き換えます。

if (existingUser == false)
{
    User user = new User();
    user.firstname = users[i].firstname;
    user.lastname = users[i].lastname;

以下に置き換えます。

// Also, add a using statement for System.Diagnostics at the start of the file.
Debug.Assert(users[i].firstname != null);
Debug.Assert(users[i].lastname != null);
if (existingUser == false)
{
    User user = new User();
    user.firstname = users[i].firstname;
    user.lastname = users[i].lastname;

開発プロセス中にこのような assert ステートメントを関数に追加することで、コードの意図を指定することができます。前の例では、次のことを指定しています。

名には有効な文字列が必要です
姓には有効な文字列が必要です

この方法で意図を指定することにより、要件を適用します。これは、開発中にバグを明らかにするために使用できる簡単で便利な方法です。 (assert ステートメントは、単体テストのメイン要素としても使用されます)。

デバッグツールバーの [再起動] Restart App ボタンをクリックします (Ctrl + Shift + F5)。

Note

assert コードは、デバッグビルドでのみアクティブになります。

再起動すると、式 users[i].firstname != null が true ではなく false と評価されるため、デバッガーは assert ステートメントで一時停止します。

Assert resolves to false

assert エラーは、調べる必要がある問題があることを示しています。 assert を使用すると、必ずしも例外が表示されない多くのシナリオに対応できます。この例では、ユーザーには例外が表示されず、レコードの一覧に firstname として null 値が追加されます。これにより、後で (コンソール出力に表示されるような) 問題が発生し、デバッグが困難になる場合があります。

Note

null 値に対してメソッドを呼び出すと、結果は NullReferenceException になります。通常は、一般的な例外 (特定のライブラリ関数に関連付けられていない例外) には、try/catch ブロックを使用しません。任意のオブジェクトで NullReferenceException がスローされる可能性があります。不明な場合は、ライブラリ関数のドキュメントを確認してください。

デバッグプロセスの間は、実際のコード修正に置き換える必要があることがわかるまで、特定の assert ステートメントを残しておくのがよい方法です。たとえば、アプリのリリースビルドでユーザーに対して例外が発生する可能性があることがわかったとします。その場合は、アプリで致命的な例外がスローされたり、他のエラーが発生したりしないように、コードをリファクターする必要があります。このコードを修正するには、次のコードを置き換えます。

if (existingUser == false)
{
    User user = new User();

を、次のコードで置換します。

if (existingUser == false && users[i].firstname != null && users[i].lastname != null)
{
    User user = new User();

このコードを使用すると、コードの要件を満たしながら、firstname または lastname の値が null であるレコードがデータに追加されないようにすることができます。

この例では、2 つの assert ステートメントをループ内に追加しました。通常、assert を使用するときは、関数またはメソッドのエントリポイント (先頭) に assert ステートメントを追加することをお勧めします。現在、サンプルアプリの UpdateRecords メソッドを見ています。このメソッドでは、メソッドのいずれかの引数が null の場合に問題が発生することがわかっているため、関数のエントリポイントで assert ステートメントを使用して両方を確認します。

public static void UpdateRecords(List<User> db, User[] users)
{
    Debug.Assert(db != null);
    Debug.Assert(users != null);

上記のステートメントの意図は、何かを更新する前に、既存のデータ (db) を読み込み、新しいデータ (users) を取得することです。

assert は、true または false として解決される任意の種類の式で使用できます。たとえば、次のような assert ステートメントを追加できます。

Debug.Assert(users[0].points > 0);

上記のコードは、ユーザーのレコードを更新するにはゼロ (0) より大きい新しいポイント値が必要である、という意図を指定する場合に便利です。

デバッガーでコードを検査する

サンプルアプリの重要な問題をすべて修正したので、他の重要な事柄に移ることができます。

デバッガーの例外ヘルパーを紹介しましたが、デバッガーははるかに強力なツールであり、コードのステップ実行や変数の検査など、他の操作も実行できます。これらの強力な機能は、特に次のような多くのシナリオで役立ちます。

コード内の実行時のバグを究明しようとしていますが、これまでに説明された手法とツールを使用したのでは実行できません。
コードを検証する必要があります。つまり、実行中にコードを監視して、期待どおりに動作し、意図したことが行われていることを確認します。

実行しながらコードを監視することをお勧めします。このようにするとコードに関する詳細がわかり、明らかな症状を示す前にバグを識別できることがよくあります。

デバッガーの重要な機能を使用する方法については、「入門者向けのデバッグ」を参照してください。

パフォーマンスの問題を修正

別の種類のバグには、アプリの実行速度の低下や、メモリの過剰使用の原因になる、非効率的なコードが含まれます。一般に、パフォーマンスの最適化は、アプリ開発の最後の方で行います。ただし、早い段階でもパフォーマンスの問題が発生する可能性があり (たとえば、アプリの一部分の実行が遅いことがわかった場合など)、早期にプロファイリングツールでアプリをテストすることが必要になる場合があります。 CPU 使用率ツールやメモリアナライザーなどのプロファイリングツールの詳細については、プロファイリングツールの概要に関する記事を参照してください。

次の手順

この記事では、コード内の多くの一般的なバグを回避して修正する方法と、デバッガーを使用する状況について説明しました。次に、Visual Studio のデバッガーを使用してバグを修正する方法の詳細について説明します。

入門者向けのデバッグ

より優れたコードを記述するためのデバッグ手法とツール

バグやエラーが含まれるサンプルアプリを作成する

赤と緑の波線を探します。

電球を確認する

残りのエラーと警告を修正する

例外を修正する

アサートを使用してコードの意図を明確にする

デバッガーでコードを検査する

パフォーマンスの問題を修正

次の手順

その他のリソース

その他のリソース

より優れたコードを記述するためのデバッグ手法とツール

バグやエラーが含まれるサンプル アプリを作成する

赤と緑の波線を探します。

電球を確認する

残りのエラーと警告を修正する

例外を修正する

アサートを使用してコードの意図を明確にする

デバッガーでコードを検査する

パフォーマンスの問題を修正

次の手順

その他のリソース

その他のリソース

バグやエラーが含まれるサンプルアプリを作成する