Dicionário C# Trygetvalue (Como funciona para desenvolvedores)

Entendendo os conceitos básicos do dicionário C

Antes de analisarmos o método TryGetValue, é crucial entender o que é um dicionário em C#. Em termos simples, um dicionário é uma coleção de pares chave/valor. Por exemplo, você pode ter um dicionário onde as chaves são os nomes dos alunos (valores de texto) e os valores são suas respectivas idades (valores inteiros).

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

As chaves em um dicionário são únicas. Você pode acessar chaves para obter o valor correspondente, tornando os dicionários incrivelmente eficientes para funcionalidades de pesquisa.

A abordagem convencional: ContainsKey Método

Ao trabalhar com dicionários em C#, uma tarefa comum é obter um valor associado a uma chave específica. No entanto, acessar diretamente uma chave que não existe pode gerar um erro KeyNotFoundException, interrompendo o fluxo do seu programa. Para evitar isso, é prática comum verificar se a chave especificada existe no dicionário. É aqui que entra em jogo o método ContainsKey.

O método ContainsKey é uma função simples e intuitiva que verifica se uma determinada chave está presente no dicionário. Aqui está a sintaxe básica do método 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)

Essa função recebe a chave como parâmetro e retorna um valor booleano. Se a chave estiver no dicionário, retornará true; caso contrário, retornará false.

Considere o seguinte exemplo, onde temos um dicionário com nomes de alunos como chaves e suas respectivas idades como valores.

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

Agora, se você quiser obter a idade de uma aluna chamada "Alice", primeiro você usaria o método ContainsKey para verificar se "Alice" é uma chave no dicionário.

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

Neste caso, o programa imprimirá "Alice tem 20 anos". Se você tentasse obter a idade de um aluno que não está presente no dicionário, o método ContainsKey impediria que um erro KeyNotFoundException fosse lançado e, em vez disso, imprimiria uma mensagem informando que o aluno não existe.

No entanto, embora o método ContainsKey possa ser útil, nem sempre é o mais eficiente, pois duas operações de pesquisa são realizadas no dicionário: uma para o método ContainsKey e outra para recuperar o valor. Isso pode ser demorado, especialmente quando se trata de dicionários grandes.

Embora o método ContainsKey seja uma maneira simples e intuitiva de lidar com exceções quando uma chave específica não é encontrada em um dicionário, vale a pena considerar métodos alternativos como TryGetValue, que podem alcançar funcionalidade semelhante com melhor desempenho. Discutiremos TryGetValue com mais detalhes nas seções seguintes.

Combinando verificação e recuperação com TryGetValue

É aqui que o método TryGetValue se torna útil. O método TryGetValue combina a verificação e a recuperação de valores em uma única etapa, oferecendo funcionalidade de código quase idêntica, mas com desempenho aprimorado.

O método TryGetValue requer dois parâmetros:

1. A chave que você está procurando.
2. Um parâmetro de saída que armazenará o valor caso a chave exista.

Eis a sintaxe:

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)

A palavra-chave out é usada para indicar que este método irá alterar o parâmetro value. O valor out será o valor padrão do tipo de valor se a chave especificada não for encontrada (0 para inteiros, nulo para tipos de referência). Caso contrário, armazenará o valor correspondente à chave fornecida.

Eis como usar 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

Este código fornece funcionalidade quase idêntica ao exemplo do método ContainsKey, mas é mais eficiente porque busca a chave apenas uma vez.

TryGetValue Exemplo de código em ação

Para melhor compreender o método TryGetValue, vamos explorar um exemplo de código prático. Considere um banco de dados escolar onde cada aluno possui um ID único e o nome correspondente. Esses dados são armazenados em um dicionário com o ID do aluno como chave e o nome como valor.

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

Nesse caso, digamos que você queira recuperar o nome do aluno com o ID 2, mas também queira garantir que o aluno com esse ID exista no banco de dados.

Tradicionalmente, você poderia primeiro usar o método ContainsKey para verificar se a chave (ID do aluno 2) existe e, em seguida, acessar o dicionário para obter o valor correspondente (nome do aluno). No entanto, com o método TryGetValue, você pode realizar isso em uma única etapa.

O método TryGetValue recebe dois argumentos: a chave que você está procurando e um parâmetro out que conterá o valor associado a essa chave, se existir. Se a chave for encontrada, o método retornará true e atribuirá o valor correspondente ao parâmetro out. Caso contrário, retornará false, e o parâmetro out assumirá o valor padrão para seu tipo.

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

Neste caso, o método TryGetValue procura a chave 2 no dicionário studentNames. Se encontrar a chave, atribui o valor correspondente à variável value (o nome do aluno) e o método retorna true. Em seguida, o programa imprime: "O nome do aluno com ID 2 é Bob."

Se o método TryGetValue não encontrar a chave 2, ele atribuirá o valor padrão para uma string (que é nulo) à variável value e o método retornará false. Em seguida, o código vai para o bloco else, imprimindo: "Não existe nenhum aluno com ID 2 no dicionário."

TryGetValue simplifica seu código combinando a verificação de existência da chave e a recuperação do valor em uma única etapa. Além disso, proporciona um aumento de desempenho, principalmente com dicionários maiores, eliminando a necessidade de múltiplas operações de busca de chave.

Apresentando o Iron Suite

À medida que você avança em sua jornada com C#, encontrará muitas ferramentas e bibliotecas à sua disposição que podem aprimorar significativamente suas capacidades de programação. Entre elas estão as bibliotecas Iron, um conjunto de ferramentas projetadas especificamente para estender a funcionalidade de aplicativos C#. Eles incluem IronPDF, IronXL, IronOCR e IronBarcode. Cada uma dessas bibliotecas possui um conjunto único de funcionalidades, e todas elas oferecem vantagens significativas quando usadas em conjunto com o C# padrão.

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

Conclusão

Ao explorarmos as funcionalidades das bibliotecas Iron em conjunto com recursos padrão do C#, como o método TryGetValue, fica claro que essas ferramentas podem aprimorar significativamente seu processo de desenvolvimento. Seja qual for o tipo de arquivo com que você trabalha — PDFs, Excel, OCR ou códigos de barras —, o Iron Suite tem uma solução sob medida para as suas necessidades.

O que é ainda mais interessante é que cada um desses produtos oferece um período de teste gratuito dos Produtos Iron Software , permitindo que você explore e experimente os recursos sem custo algum. Se você decidir continuar usando as bibliotecas, a licença começa a partir de $799 para cada produto. No entanto, o valor agregado é ainda maior se você estiver interessado em várias bibliotecas Iron, pois pode adquirir o pacote completo Iron Suite pelo preço de apenas dois produtos individuais.