C# Dictionnaire TryGetValue (Comment ça fonctionne pour les développeurs)

Comprendre les bases du Dictionnaire C

Avant de plonger dans la méthode TryGetValue, il est crucial de comprendre ce qu'est un Dictionary en C#. En termes simples, un Dictionnaire est une collection de paires clé/valeur. Par exemple, vous pouvez avoir un Dictionnaire où les clés sont les noms des étudiants (valeurs de type chaîne), et les valeurs sont leurs âges correspondants (valeurs entières).

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

Les clés dans un Dictionnaire sont uniques. Vous pouvez accéder aux clés pour récupérer la valeur correspondante, ce qui rend les Dictionnaires incroyablement efficaces pour la fonctionnalité de recherche.

L'approche conventionnelle : méthode ContainsKey

Lorsque vous travaillez avec des Dictionnaires C#, une tâche courante est de récupérer une valeur associée à une clé particulière. Cependant, accéder directement à une clé qui n'existe pas peut lancer une KeyNotFoundException, interrompant le flux de votre programme. Pour éviter cela, il est pratique courante de vérifier si la clé spécifiée existe dans le Dictionnaire. C'est là que la méthode ContainsKey entre en jeu.

La méthode ContainsKey est une fonction simple et intuitive qui vérifie si une certaine clé est présente dans le Dictionary. Voici la syntaxe de base de la méthode ContainsKey :

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

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

Elle prend la clé en paramètre et renvoie une valeur booléenne. Si la clé est dans le Dictionary, elle retournera true ; sinon, elle retournera false.

Considérez l'exemple suivant où nous avons un Dictionnaire avec les noms des étudiants comme clés et leurs âges correspondants comme valeurs.

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

Maintenant, si vous voulez obtenir l'âge d'un étudiant nommé " Alice ", vous utiliseriez d'abord la méthode ContainsKey pour vérifier si " Alice " est une clé dans le 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.");
}

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.");
}

Dans ce cas, le programme affichera " Alice a 20 ans. " Si vous essayiez d'obtenir l'âge d'un étudiant non présent dans le Dictionary, la méthode ContainsKey empêcherait l'envoi d'une KeyNotFoundException et afficherait plutôt un message indiquant que l'étudiant n'existe pas.

Cependant, bien que la méthode ContainsKey puisse être utile, ce n'est pas toujours la plus efficace, car deux opérations de recherche sont effectuées sur le Dictionary : une pour la méthode ContainsKey et une pour récupérer la valeur. Cela peut être chronophage, surtout lorsqu'il s'agit de grands Dictionnaires.

Bien que la méthode ContainsKey soit un moyen simple et intuitif de gérer les exceptions lorsqu'une clé spécifiée n'est pas trouvée dans un Dictionary, il vaut la peine d'envisager des méthodes alternatives comme TryGetValue, qui peuvent réaliser des fonctionnalités similaires avec de meilleures performances. Nous discuterons de TryGetValue en détail dans les sections suivantes.

Combinaison de vérification et de récupération avec TryGetValue

C'est là que la méthode TryGetValue est pratique. La méthode TryGetValue combine la vérification et la récupération de valeur en une seule étape, offrant une fonctionnalité de code presque identique mais avec des performances améliorées.

La méthode TryGetValue nécessite deux paramètres :

1. La clé que vous recherchez.
2. Un paramètre out qui contiendra la valeur si la clé existe.

Voici la syntaxe :

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

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

Le mot-clé out est utilisé pour signifier que cette méthode modifiera le paramètre value. La valeur out sera la valeur par défaut du type de valeur si la clé spécifiée n'est pas trouvée (0 pour les entiers, null pour les types de référence). Sinon, elle contiendra la valeur qui correspond à la clé fournie.

Voici comment utiliser 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.");
}

Ce code offre une fonctionnalité presque identique à l'exemple de méthode ContainsKey, mais il est plus efficace car il effectue une seule recherche de clé.

TryGetValue Code Exemple en Action

Pour mieux comprendre la méthode TryGetValue, explorons un exemple pratique de code. Considérez une base de données scolaire où chaque étudiant a un ID unique et un nom correspondant. Ces données sont stockées dans un Dictionnaire avec l'ID de l'étudiant comme clé et le nom comme valeur.

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

Dans ce cas, disons que vous voulez récupérer le nom de l'étudiant avec l'ID 2, mais vous voulez également vous assurer que l'étudiant avec cet ID existe dans la base de données.

Traditionnellement, vous pourriez d'abord utiliser la méthode ContainsKey pour vérifier si la clé (ID d'étudiant 2) existe, puis accéder au Dictionary pour obtenir la valeur correspondante (le nom de l'étudiant). Cependant, avec la méthode TryGetValue, vous pouvez accomplir cela en une seule étape.

La méthode TryGetValue prend deux arguments : la clé que vous recherchez et un paramètre out qui contiendra la valeur associée à cette clé si elle existe. Si la clé est trouvée, la méthode retournera true et assignera la valeur correspondante au paramètre out. Sinon, elle retournera false, et le paramètre out prendra la valeur par défaut pour son type.

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.");
}

Dans ce cas, la méthode TryGetValue recherche la clé 2 dans le Dictionary studentNames. Si elle trouve la clé, elle assigne la valeur correspondante à la variable value (le nom de l'étudiant), et la méthode retourne true. Ensuite, le programme imprime : "Le nom de l'étudiant avec l'ID 2 est Bob."

Si la méthode TryGetValue ne trouve pas la clé 2, elle assignera la valeur par défaut pour une chaîne (qui est null) à la variable value, et la méthode retournera false. Le code passe ensuite au bloc else, affichant " Aucun étudiant avec l'ID 2 n'existe dans le dictionary. "

TryGetValue rationalise votre code en combinant la vérification de l'existence d'une clé et la récupération de valeur en une seule étape. De plus, elle offre un gain de performance, notamment avec de plus grands Dictionaries, en éliminant le besoin de multiples opérations de recherche de clé.

Introduction de Iron Suite

Au fur et à mesure que vous progressez dans votre parcours C#, vous trouverez de nombreux outils et bibliothèques à votre disposition qui peuvent améliorer considérablement vos capacités de programmation. Parmi ceux-ci figurent les bibliothèques Iron, une suite d'outils spécialement conçus pour étendre la fonctionnalité des applications C#. Elles incluent IronPDF, IronXL, IronOCR et IronBarcode. Chacune de ces bibliothèques a un ensemble de fonctionnalités unique, et toutes offrent des avantages significatifs lorsqu'elles sont utilisées en conjonction avec du C# standard.

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

Conclusion

Comme nous avons exploré les fonctionnalités des bibliothèques Iron en conjonction avec les fonctionnalités standard de C# comme la méthode TryGetValue, il est clair que ces outils peuvent améliorer considérablement votre processus de développement. Que vous travailliez avec des PDF, des fichiers Excel, de l'OCR ou des codes-barres, la Iron Suite a une solution adaptée à vos besoins.

Ce qui est encore plus séduisant, c'est que chacun de ces produits offre une version d'essai gratuite des produits Iron Software, vous permettant d'explorer et de tester les fonctionnalités sans frais. Si vous décidez de continuer à utiliser les bibliothèques, la licence commence à partir de $799 pour chaque produit. Cependant, il y a encore plus de valeur à trouver si vous êtes intéressé par plusieurs bibliothèques Iron, car vous pouvez acheter l'intégralité de la Iron Suite au prix de seulement deux produits individuels.