.NET 帮助

C# 字典 TryGetValue（开发人员如何使用）

发布 2023年八月29日

C# 是一种多功能且强大的语言，提供了许多功能。其中包括 C# Dictionary。

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

VB C#

字典中的键是唯一的。您可以访问键以获取相应的值，使得字典在查找功能方面非常高效。

传统方法：`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)

VB C#

它将键作为参数并返回一个布尔值。如果键在字典中，它将返回 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}
}

VB C#

现在，如果要获取名为 "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

VB C#

在这种情况下，程序将打印 "Alice is 20 years old." 如果你试图获取不在字典中的学生年龄，ContainsKey 方法将防止抛出 KeyNotFoundException，而改为打印一条消息，说明该学生不存在。

然而，虽然 ContainsKey 方法可能有用，但它并不总是最高效的。在上面的代码片段中，对字典进行了两次查找操作：一个是使用 ContainsKey 方法，另一个是检索值。这可能会耗费时间，尤其是处理大型字典时。

虽然 ContainsKey 方法是在字典中未找到指定键时处理异常的简单直观方法，但值得考虑像 TryGetValue 这样的方法，它可以以更好的性能实现类似功能。我们将在接下来的部分中更详细地讨论 TryGetValue。

结合验证和检索与 `TryGetValue`

这就是 TryGetValue 方法派上用场的地方。 TryGetValue 方法将验证和值检索结合在一起，提供了几乎相同的代码功能但性能更高。

TryGetValue 方法需要两个参数：

您正在寻找的钥匙。
一个 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)

VB C#

out 关键字用于表示此方法将更改 value 参数。如果未找到指定键，则 out 值将是该值类型的默认值。(整数为 0，引用类型为空). 否则，它将持有与提供的键对应的值。

以下是 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

VB C#

这段代码提供了与 ContainsKey 方法示例几乎相同的功能，但由于只查找一次键，因此效率更高。

`TryGetValue` 操作代码示例

为了更好地理解 TryGetValue 方法，让我们探讨一个实际的代码示例。考虑一个学校数据库，每个学生都有一个唯一的ID和相应的姓名。这些数据存储在一个Dictionary中，学生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"}
}

VB C#

在这种情况下，假设你想获取ID为2的学生的姓名，但你还想确保具有此ID的学生存在于数据库中。

传统上，您可能会首先使用 ContainsKey 方法来检查该键是否存在。(学生编号 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

VB C#

在这种情况下，TryGetValue 方法在 studentNames 字典中查找键 2。如果找到该键，则将相应的值赋给 value 变量(学生姓名)，并且该方法返回 true。然后，程序打印出：“ID为2的学生的名字是Bob。”

如果 TryGetValue 方法未找到键 2，它将分配字符串的默认值(为空)将其赋值给 value 变量，该方法将返回 false。然后代码进入 else 块，打印出 "字典中不存在 ID 为 2 的学生。"

TryGetValue 通过将键存在检查和值检索合并为一个步骤，使您的代码简化。此外，它通过消除对多个键查找操作的需求，特别是在处理较大字典时，提供性能提升。

介绍 Iron Suite

随着你在C#编程旅程中不断进步，你会发现有许多工具和库可供使用，这些工具和库可以显著提升你的编程能力。其中包括Iron库，这是一个专门设计用于扩展C#应用程序功能的工具套件。它们包括 IronPDF、IronXL、IronOCR 和 IronBarcode。这些库各自具有独特的功能，当与标准C#结合使用时，它们都能提供显著的优势。

IronPDF

C# 词典 `TryGetValue`（开发人员如何使用）图 1

了解 IronPDF for PDF Creation in .NET是一个 C# 库，旨在从 HTML 创建 PDF 文件在 .NET 应用程序中编辑和提取 PDF 内容。通过IronPDF，您可以以编程方式生成PDF报告、填写PDF表单和操作PDF文档。该库还提供HTML到PDF转换功能，使将现有的HTML内容转换为PDF变得容易。

IronPDF 的亮点是其HTML 转 PDF函数，它保持所有的布局和样式不变。它允许您从网络内容创建PDF，适用于报告、发票和文档。 HTML文件、URL和HTML字符串可以无缝转换为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");
    }
}

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

VB C#

在我们的主题背景下，想象一个从字典中检索学生数据并生成PDF报告的场景。 TryGetValue 可以高效获取必要的数据，然后利用 IronPDF 创建 PDF 文档。