C# 字典 Trygetvalue（開發者的工作原理）

瞭解 C# 辭典的基礎知識

在深入了解 TryGetValue 方法之前，了解 C# 中的字典是什麼至關重要。 簡單來說，字典是鍵/值對的集合。 例如，您可能有一個詞典，其中的鍵是學生的姓名（字串值），而值是他們相對應的年齡（整數值）。

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}
}

詞典中的鍵是唯一的。 您可以存取鍵來取得相對應的值，這使得 Dictionaries 在查詢功能上有難以置信的效率。

傳統方法：ContainsKey 方法

在使用 C# 字典時，常見的任務是取得與特定鍵相關的值。 但是，直接存取不存在的鍵可能會拋出 KeyNotFoundException 錯誤，從而中斷程式的流程。 為了避免這種情況，通常的做法是檢查字典中是否存在指定的關鍵字。 這時就需要用到 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<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"的學生的年齡，你首先需要使用 ContainsKey 方法來檢查"Alice"是否是字典中的一個鍵。

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 20 歲"。如果您嘗試取得字典中不存在的學生的年齡，ContainsKey 方法將防止拋出 KeyNotFoundException 異常，而是列印一條訊息，說明該學生不存在。

然而，雖然 ContainsKey 方法可能很有用，但它並不總是最有效的，因為對字典執行了兩次查找操作：一次用於 ContainsKey 方法，一次用於檢索值。 這可能很花時間，尤其是在處理大型字典時。

雖然 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<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# 的旅程中不斷進步時，您會發現有許多工具和函式庫可供您使用，可以大幅提升您的程式設計能力。 其中 Iron library 是一套專門用來擴充 C# 應用程式功能的工具。 這些工具包括 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 庫的功能以及標準 C# 功能（例如 TryGetValue 方法）時，很明顯，這些工具可以顯著增強您的開發流程。 無論您是處理 PDF、Excel 檔案、OCR 或 BarCode，Iron Suite 都有為您量身打造的解決方案。

更吸引人的是，這些產品均提供Iron Software Products 的免費試用版，讓您可以免費探索和體驗各項功能。如果您決定繼續使用這些庫，則每個產品的許可證價格從 $999 起。 不過，如果您對多個 Iron 函式庫感興趣，還可以發現更多價值，因為您只需花兩個單獨產品的價格，就可以購買完整的 Iron Suite。