Lire un fichier JSON en C#

Ce didacticiel abordera les méthodes de lecture d’un fichier JSON en C#.

Lire un fichier JSON avec la classe JsonConvert en C#

La classe JsonConvert permet de lire des données JSON dans des objets et des variables et d’écrire des objets et des variables au format JSON en C#. La classe JsonConvert est présente dans le framework Json.net, qui n’est pas pré-installé. La commande pour installer Json.net est donnée ci-dessous.

Install-Package Newtonsoft.Json

Dans cet article, nous utiliserons les données JSON suivantes.

{
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
}

Afin de lire les données de ce fichier, nous devons d’abord créer une classe de modèle qui contient tous les attributs que nous voulons lire à partir du fichier.

file.json:

class datamodel {
  public string key1 { get; set; }
  public string key2 { get; set; }
  public string key3 { get; set; }
}

Nous avons maintenant une classe de modèle qui stockera toutes les données du fichier JSON dans des objets de classe. On peut récupérer les données d’un fichier avec la fonction JsonConvert.DeserializeObject() en C#. La fonction JsonConvert.DeserializeObject() prend les données JSON sous la forme d’une variable chaîne et les convertit en l’objet de classe de modèle de données spécifié. L’exemple de code suivant nous montre comment obtenir les données d’un fichier JSON dans des objets de classe avec la fonction JsonConvert.DeserializeObject() en C#.

StreamReader r = new StreamReader("file.json");
string jsonString = r.ReadToEnd();
datamodel m = JsonConvert.DeserializeObject<datamodel>(jsonString);

Nous avons initialisé un StreamReader - r pour lire le fichier contenant les données JSON file.json. Nous avons ensuite initialisé le jsonString, qui est l’ensemble des données contenues dans le fichier file.json. Nous avons créé une instance de la classe datamodel m pour stocker la valeur retournée par la fonction JsonConvert.DeserializeObject<datamodel>(jsonString). Il s’agit de la méthode la plus simple pour lire et écrire des données dans un fichier JSON en C#.