C# Dictionary Trygetvalue (開発者向けの仕組み)

C#のDictionaryの基本を理解する

TryGetValue メソッドに入る前に、C#でのディクショナリの意味を理解することが重要です。 簡単に言えば、Dictionary はキー/値のペアのコレクションです。 たとえば、キーが学生の名前（文字列値）で、値が対応する年齢（整数値）である Dictionary を持つことができます。

Dictionary<string, int> studentAges = new Dictionary<string, int>
{
    {"Alice", 20},
    {"Bob", 22},
    {"Charlie", 19}
};

Dictionary<string, int> studentAges = new Dictionary<string, int>
{
    {"Alice", 20},
    {"Bob", 22},
    {"Charlie", 19}
};

Dim studentAges As New Dictionary(Of String, Integer) From {
	{"Alice", 20},
	{"Bob", 22},
	{"Charlie", 19}
}

Dictionary のキーは固有です。 キーにアクセスして対応する値を取得できるため、Dictionary は検索機能に非常に効率的です。

従来のアプローチ: ContainsKey メソッド

C# Dictionary を使用するとき、特定のキーに関連付けられた値を取得することが一般的なタスクです。 しかし、存在しないキーに直接アクセスするとKeyNotFoundExceptionが発生し、プログラムの流れが中断される可能性があります。 これを避けるために、指定されたキーが Dictionary 内に存在するかどうかを確認するのが一般的な方法です。 ここでContainsKey メソッドが役立ちます。

ContainsKey メソッドは、特定のキーがディクショナリに存在するかどうかを確認する、シンプルで直感的な関数です。 以下にContainsKey メソッドの基本構文を示します。

Dictionary<TKey, TValue>.ContainsKey(TKey key)

Dictionary<TKey, TValue>.ContainsKey(TKey key)

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'Dictionary<TKey, TValue>.ContainsKey(TKey key)

キーをパラメータとして受け取り、ブール値を返します。 キーがディクショナリに存在すれば、true を返します; 存在しない場合は、false を返します。

次の例を考えてみましょう。学生の名前をキーとし、それに対応する年齢を値とする Dictionary があります。

Dictionary<string, int> studentAges = new Dictionary<string, int>
{
    {"Alice", 20},
    {"Bob", 22},
    {"Charlie", 19}
};

Dictionary<string, int> studentAges = new Dictionary<string, int>
{
    {"Alice", 20},
    {"Bob", 22},
    {"Charlie", 19}
};

Dim studentAges As New Dictionary(Of String, Integer) From {
	{"Alice", 20},
	{"Bob", 22},
	{"Charlie", 19}
}

今、"Alice"という名前の学生の年齢を取得したい場合、最初に"Alice"がディクショナリのキーであるかどうかを確認するためにContainsKey メソッドを使用します。

string student = "Alice";
if (studentAges.ContainsKey(student))
{
    int age = studentAges[student];
    Console.WriteLine($"{student} is {age} years old.");
}
else
{
    Console.WriteLine($"{student} does not exist in the dictionary.");
}

string student = "Alice";
if (studentAges.ContainsKey(student))
{
    int age = studentAges[student];
    Console.WriteLine($"{student} is {age} years old.");
}
else
{
    Console.WriteLine($"{student} does not exist in the dictionary.");
}

Dim student As String = "Alice"
If studentAges.ContainsKey(student) Then
	Dim age As Integer = studentAges(student)
	Console.WriteLine($"{student} is {age} years old.")
Else
	Console.WriteLine($"{student} does not exist in the dictionary.")
End If

この場合、プログラムは"Alice is 20 years old."と出力します。存在しない学生の年齢を取得しようとした場合、ContainsKey メソッドはKeyNotFoundExceptionの発生を防ぎ、代わりにその学生が存在しないというメッセージを出力します。

しかし、ContainsKey メソッドは有用である一方で、常に最も効率的とは言えません。なぜならディクショナリに対して2回の検索操作が行われるからです: 一つはContainsKey メソッド用、一つは値を取得するためです。 特に大規模な Dictionary を扱う際には、これは時間がかかる可能性があります。

ContainsKey メソッドは、指定されたキーがディクショナリに見つからないときの例外を処理するシンプルで直感的な方法ですが、より良いパフォーマンスで類似の機能を実現できるTryGetValue のような代替メソッドを考慮する価値があります。 次のセクションでTryGetValueについて詳しく説明します。

TryGetValueを使用した検証と取得の統合

ここでTryGetValue メソッドが便利になります。 TryGetValue メソッドは、検証と値の取得を一度のステップで組み合わせることで、ほぼ同様のコード機能を提供しつつ、パフォーマンスを向上させます。

TryGetValue メソッドは二つのパラメータを必要とします。

1. 探しているキー。
2. キーが存在する場合に値を保持する out パラメータ。

構文は以下の通りです：

Dictionary<TKey, TValue>.TryGetValue(TKey key, out TValue value)

Dictionary<TKey, TValue>.TryGetValue(TKey key, out TValue value)

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'Dictionary<TKey, TValue>.TryGetValue(TKey key, out TValue value)

out キーワードは、このメソッドがvalue パラメータを変更することを示すために使用されます。 指定されたキーが見つからない場合、out 値は値タイプのデフォルト値になります（整数の場合は0、参照タイプの場合はnull）。 それ以外の場合、指定されたキーに対応する値を保持します。

TryGetValueの使い方は以下です。

string student = "Alice";
if (studentAges.TryGetValue(student, out int age))
{
    Console.WriteLine($"{student} is {age} years old.");
}
else
{
    Console.WriteLine($"{student} does not exist in the dictionary.");
}

string student = "Alice";
if (studentAges.TryGetValue(student, out int age))
{
    Console.WriteLine($"{student} is {age} years old.");
}
else
{
    Console.WriteLine($"{student} does not exist in the dictionary.");
}

Dim student As String = "Alice"
Dim age As Integer
If studentAges.TryGetValue(student, age) Then
	Console.WriteLine($"{student} is {age} years old.")
Else
	Console.WriteLine($"{student} does not exist in the dictionary.")
End If

このコードは、ContainsKey メソッドの例とほぼ同じ機能を提供しますが、キーを一度だけ検索するため、より効率的です。

TryGetValue の実践的コード例

TryGetValue メソッドをより理解するために、実践的なコード例を見てみましょう。 学生ごとに固有の ID と対応する名前を持つ学校のデータベースを考えてみましょう。 このデータは、学生 ID をキーとし、名前を値とする Dictionary に格納されています。

Dictionary<int, string> studentNames = new Dictionary<int, string>
{
    {1, "Alice"},
    {2, "Bob"},
    {3, "Charlie"}
};

Dictionary<int, string> studentNames = new Dictionary<int, string>
{
    {1, "Alice"},
    {2, "Bob"},
    {3, "Charlie"}
};

Dim studentNames As New Dictionary(Of Integer, String) From {
	{1, "Alice"},
	{2, "Bob"},
	{3, "Charlie"}
}

この場合、ID 2 の学生の名前を取得したいが、この ID を持つ学生がデータベースに存在することを確認したいとします。

従来は、まずContainsKey メソッドを使用してキー（学生ID 2）が存在するか確認し、その後ディクショナリにアクセスして対応する値（学生名）を取得しました。 しかし、TryGetValue メソッドを使用すれば、これを一度のステップで達成できます。

TryGetValue メソッドは二つの引数を取ります: 探しているキーと、そのキーが存在する場合に関連する値を保持するout パラメータです。 キーが見つかれば、メソッドはtrue を返し、対応する値をout パラメータに割り当てます。 見つからない場合、false を返し、out パラメータはそのタイプのデフォルト値を取ります。

int i = 2; // Student ID
if (studentNames.TryGetValue(i, out string value))
{
    Console.WriteLine($"The name of the student with ID {i} is {value}.");
}
else
{
    Console.WriteLine($"No student with ID {i} exists in the dictionary.");
}

int i = 2; // Student ID
if (studentNames.TryGetValue(i, out string value))
{
    Console.WriteLine($"The name of the student with ID {i} is {value}.");
}
else
{
    Console.WriteLine($"No student with ID {i} exists in the dictionary.");
}

Dim i As Integer = 2 ' Student ID
Dim value As String
If studentNames.TryGetValue(i, value) Then
	Console.WriteLine($"The name of the student with ID {i} is {value}.")
Else
	Console.WriteLine($"No student with ID {i} exists in the dictionary.")
End If

この場合、TryGetValue メソッドはstudentNames ディクショナリ内のキー2を探します。 キーを見つけた場合、対応する値をvalue 変数（学生名）に割り当て、メソッドはtrue を返します。 その後、プログラムは"ID 2 の学生の名前は Bob です。"と出力します。

もしTryGetValue メソッドがキー2を見つけられなかった場合は、文字列のデフォルト値（null）をvalue 変数に割り当て、メソッドはfalse を返します。 その後、コードはelse ブロックに進み、"ディクショナリにID 2の学生は存在しません"と印刷します。

TryGetValue はキーの存在確認と値の取得を一度のステップで行うことでコードを簡素化します。さらに、大規模なディクショナリの場合、複数回のキー検索操作を排除することで、パフォーマンスの向上を提供します。

Iron Suite の紹介

C# の旅を進める中で、プログラムの能力を大幅に強化するさまざまなツールとライブラリが手に入ります。 その中には、C# アプリケーションの機能を拡張するために特別に設計された Iron ライブラリがあります。 IronPDF、IronXL、IronOCR、IronBarcode が含まれています。 これらの各ライブラリは独自の機能セットを持ち、標準の C# と組み合わせて使用することで大きな利点を提供します。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

Imports IronPdf

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim renderer = New ChromePdfRenderer()

		' 1. Convert HTML String to PDF
		Dim htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>"
		Dim pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent)
		pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf")

		' 2. Convert HTML File to PDF
		Dim htmlFilePath = "path_to_your_html_file.html" ' Specify the path to your HTML file
		Dim pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath)
		pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf")

		' 3. Convert URL to PDF
		Dim url = "http://ironpdf.com" ' Specify the URL
		Dim pdfFromUrl = renderer.RenderUrlAsPdf(url)
		pdfFromUrl.SaveAs("URLToPDF.pdf")
	End Sub
End Class

結論

Ironライブラリの機能を探索し、TryGetValue メソッドのような標準のC#機能と組み合わせた結果、これらのツールは開発プロセスを大幅に向上させることができることは明らかです。 PDF、Excel ファイル、OCR またはバーコードのいずれを扱っている場合でも、Iron Suiteはお客様のニーズに合わせたソリューションを提供します。

さらに魅力的なのは、これらの製品のそれぞれがIron Software 製品の無料トライアルを提供しており、無料で機能を探索し実験することができます。ライブラリの継続使用を決定した場合、ライセンスは各製品で$999から開始されます。 ただし、複数の Iron ライブラリに興味がある場合は、2 つの個別製品の価格で Iron Suite 全体を購入することで、さらに価値を見出すことができます。