チュートリアル: Visual Basic でのビジュアライザーの記述

このチュートリアルでは、Visual Basic を使用して単純なビジュアライザーを記述する方法について説明します。 このチュートリアルで作成するビジュアライザーは、Windows フォーム メッセージ ボックスを使用して文字列の内容を表示します。 この単純な文字列ビジュアライザーは、プロジェクトに適用できる他のデータ型のビジュアライザーを作成する方法を示す基本的な例です。

ビジュアライザー コードは、デバッガーによって読み取られる DLL に配置する必要があります。 最初の手順では、DLL のクラス ライブラリ プロジェクトを作成します。

クラス ライブラリ プロジェクトの作成と準備

クラス ライブラリ プロジェクトを作成するには

1. 新しいクラス ライブラリ プロジェクトを作成します。

   Esc キーを押してスタート ウィンドウを閉じます。 Ctrl + Q キーを押して検索ボックス、タイプ クラス ライブラリを開き、Visual Basic クラス ライブラリ (.NET Framework) を選択します。

   Esc キーを押してスタート ウィンドウを閉じます。 Ctrl + Q キーを押して検索ボックスを開き、「visual basic」と入力し、[テンプレート] を選択してから、[新しいクラス ライブラリの作成 (.NET Framework)] を選択します。

2. クラス ライブラリの適切な名前 ( MyFirstVisualizerなど) を入力し、[ 作成 ] または [OK] をクリックします。

   クラス ライブラリを作成したら、そこで定義されているクラスを使用できるように、Microsoft.VisualStudio.DebuggerVisualizers.DLLへの参照を追加する必要があります。 ただし、最初にプロジェクトにわかりやすい名前を付けます。

Class1.vbの名前を変更し、Microsoft.VisualStudio.DebuggerVisualizers を追加するには

1. ソリューション エクスプローラーでClass1.vbを右クリックし、ショートカット メニューの [名前の変更] をクリックします。

2. 名前を Class1.vb から意味のあるもの (DebuggerSide.vb など) に変更します。

   注

   Visual Studio では、新しいファイル名と一致するように、DebuggerSide.vbのクラス宣言が自動的に変更されます。

3. ソリューション エクスプローラーで、[My First Visualizer] を右クリックし、ショートカット メニューの [参照の追加] をクリックします。

4. [ 参照の追加 ] ダイアログ ボックスの [ 参照 ] タブで[ 参照 ] を選択し、Microsoft.VisualStudio.DebuggerVisualizers.DLLを見つけます。

   DLL は、Visual Studio のインストール ディレクトリの <Visual Studio インストール ディレクトリ>\Common7\IDE\PublicAssemblies サブディレクトリにあります。

5. OK をクリックします。

6. DebuggerSide.vbで、次のステートメントを Imports ステートメントに追加します。

   Imports Microsoft.VisualStudio.DebuggerVisualizers
   

デバッガー側コードを追加する

これで、デバッガー側のコードを作成する準備ができました。 これは、視覚化する情報を表示するためにデバッガー内で実行されるコードです。 最初に、基底クラスのDialogDebuggerVisualizerから継承するように、DebuggerSide オブジェクトの宣言を変更する必要があります。

DialogDebuggerVisualizer から継承するには

1. DebuggerSide.vbで、次のコード行に移動します。

   Public Class DebuggerSide
   

2. 次のようにコードを編集します。

   Public Class DebuggerSide
   Inherits DialogDebuggerVisualizer
   

   注

   DialogDebuggerVisualizer では、コンストラクターに FormatterPolicy 引数が必要です。 ただし、Visual Studio 2022 バージョン 17.11 以降では、 .NET 5.0 以降のデバッガー側の特別な考慮事項で説明されているセキュリティの問題により、ビジュアライザーは Legacy フォーマッタ ポリシーを指定できません。

   DialogDebuggerVisualizer には、オーバーライドする必要がある 1 つの抽象メソッド ( Show) があります。

DialogDebuggerVisualizer.Show メソッドをオーバーライドするには

• public class DebuggerSideで、次のメソッドを追加します。

  Protected Overrides Sub Show(ByVal windowService As Microsoft.VisualStudio.DebuggerVisualizers.IDialogVisualizerService, ByVal objectProvider As Microsoft.VisualStudio.DebuggerVisualizers.IVisualizerObjectProvider)
  
      End Sub
  

  Show メソッドには、ビジュアライザー ダイアログ ボックスまたはその他のユーザー インターフェイスを実際に作成し、デバッガーからビジュアライザーに渡された情報を表示するコードが含まれています。 ダイアログ ボックスを作成し、情報を表示するコードを追加する必要があります。 このチュートリアルでは、Windows フォーム のメッセージ ボックスを使用してこれを行います。 最初に、System.Windows.Formsの参照とImportsステートメントを追加する必要があります。

System.Windows.Forms を追加するには

1. ソリューション エクスプローラーで [参照] を右クリックし、ショートカット メニューの [参照の追加] をクリックします。

2. [ 参照の追加 ] ダイアログ ボックスの [ 参照 ] タブで[ 参照] を選択し、System.Windows.Forms.DLLを見つけます。

   DLL は C:\Windows\Microsoft.NET\Framework\v4.0.30319 にあります。

3. OK をクリックします。

4. DebuggerSide.csで、次のステートメントを Imports ステートメントに追加します。

   Imports System.Windows.Forms
   

ビジュアライザーのユーザー インターフェイスを作成する

次に、ビジュアライザーのユーザー インターフェイスを作成して表示するコードをいくつか追加します。 これは初めてのビジュアライザーであるため、ユーザー インターフェイスをシンプルにし、メッセージ ボックスを使用します。

ダイアログ ボックスにビジュアライザーの出力を表示するには

1. Show メソッドで、次のコード行を追加します。

   MessageBox.Show(objectProvider.GetObject().ToString())
   

   このコード例には、エラー処理は含まれません。 実際のビジュアライザーやその他の種類のアプリケーションにエラー処理を含める必要があります。

2. [ ビルド ] メニューの [ Build MyFirstVisualizer] をクリックします。 プロジェクトが正常に構築されるはずです。 続行する前に、ビルド エラーを修正してください。

必要な属性を追加する

これがデバッガー側のコードの末尾です。 ただし、もう 1 つの手順があります。デバッグ対象側に、ビジュアライザーを構成するクラスのコレクションを示す属性です。

デバッグ対象側のコードを視覚化するための型を追加するには

デバッガー側のコードでは、 DebuggerVisualizerAttribute 属性を使用して、デバッグ対象の視覚化する型 (オブジェクト ソース) を指定します。 Target プロパティは、視覚化する型を設定します。

1. Imports ステートメントの後、namespace MyFirstVisualizerの前に、次の属性コードをDebuggerSide.vbに追加します。

   <Assembly: System.Diagnostics.DebuggerVisualizer(GetType(MyFirstVisualizer.DebuggerSide), GetType(VisualizerObjectSource), Target:=GetType(System.String), Description:="My First Visualizer")>
   

2. [ ビルド ] メニューの [ Build MyFirstVisualizer] をクリックします。 プロジェクトが正常に構築されるはずです。 続行する前に、ビルド エラーを修正してください。

テスト ハーネスを作成する

この時点で、最初のビジュアライザーが完成します。 手順に正しく従っている場合は、ビジュアライザーをビルドして Visual Studio にインストールできます。 ただし、Visual Studio にビジュアライザーをインストールする前に、それをテストして正しく動作することを確認する必要があります。 次に、Visual Studio にビジュアライザーをインストールせずに実行するテスト ハーネスを作成します。

ビジュアライザーを表示するテスト メソッドを追加するには

1. クラス public DebuggerSideに次のメソッドを追加します。

   Shared Public Sub TestShowVisualizer(ByVal objectToVisualize As Object)
       Dim visualizerHost As New VisualizerDevelopmentHost(objectToVisualize, GetType(DebuggerSide))
   visualizerHost.ShowVisualizer()
   End Sub
   

2. [ ビルド ] メニューの [ Build MyFirstVisualizer] をクリックします。 プロジェクトは正常に構築されるはずです。 続行する前に、ビルド エラーを修正してください。

   次に、ビジュアライザー DLL を呼び出す実行可能プロジェクトを作成する必要があります。 わかりやすくするために、コンソール アプリケーション プロジェクトを使用します。

コンソール アプリケーション プロジェクトをソリューションに追加するには

1. ソリューション エクスプローラーで、ソリューションを右クリックし、[ 追加] を選択し、[ 新しいプロジェクト] をクリックします。

   [検索] ボックスに 「visual basic」と入力し、[ テンプレート] を選択し、[ 新しいコンソール アプリの作成 (.NET Framework)] を選択します。 表示されたダイアログボックスで、を選び、を作成します。

2. クラス ライブラリの適切な名前 ( MyTestConsoleなど) を入力し、[ 作成 ] または [OK] をクリックします。

   ここで、MyTestConsole が MyFirstVisualizer を呼び出すことができるように、必要な参照を追加する必要があります。

MyTestConsole に必要な参照を追加するには

1. ソリューション エクスプローラーでMyTestConsole を右クリックし、ショートカット メニューの [参照の追加] をクリックします。

2. [ 参照の追加 ] ダイアログ ボックスの [ 参照 ] タブで、[Microsoft.VisualStudio.DebuggerVisualizers] をクリックします。

3. OK をクリックします。

4. MyTestConsole を右クリックし、もう一度 [参照の追加] をクリックします。

5. [ 参照の追加 ] ダイアログ ボックスで、[ プロジェクト ] タブをクリックし、[MyFirstVisualizer] を選択します。

6. OK をクリックします。

テスト ハーネスを完成させ、ビジュアライザーをテストする

次に、テスト ハーネスを終了するコードを追加します。

MyTestConsole にコードを追加するには

1. ソリューション エクスプローラーでProgram.vbを右クリックし、ショートカット メニューの [名前の変更] をクリックします。

2. 名前をModule1.vbから適切なもの ( TestConsole.vbなど) に編集します。

   Visual Studio によって、新しいファイル名と一致するようにTestConsole.vbのクラス宣言が自動的に変更されます。

3. TestConsole内で。 vb、次の Imports ステートメントを追加します。

   Imports MyFirstVisualizer
   

4. メソッド Mainで、次のコードを追加します。

   Dim myString As String = "Hello, World"
   DebuggerSide.TestShowVisualizer(myString)
   

   これで、最初のビジュアライザーをテストする準備ができました。

ビジュアライザーをテストするには

1. ソリューション エクスプローラーでMyTestConsole を右クリックし、ショートカット メニューの [スタートアップ プロジェクトとして設定] をクリックします。

2. [デバッグ] メニューの [開始] をクリックします。

   コンソール アプリケーションが起動します。 ビジュアライザーが表示され、文字列 "Hello, World" が表示されます。

   お疲れさまでした。 最初のビジュアライザーをビルドしてテストしました。

   単にテスト ハーネスから呼び出すのではなく、Visual Studio でビジュアライザーを使用する場合は、インストールする必要があります。 詳細については、「 方法: ビジュアライザーをインストールする」を参照してください。

関連コンテンツ

• ビジュアライザーのアーキテクチャ
• 方法: ビジュアライザーをインストールする
• カスタム ビジュアライザーを作成する