Méthodes JavaScript JSON, toJSON

La JavaScript Object Notation (JSON) est un format notable pour représenter des objets et des valeurs. Initialement, ce format a été créé pour JavaScript, mais plusieurs langages incluent également des bibliothèques pour le gérer. Par conséquent, il est plus facile d'utiliser JSON pour l'échange de données dans le cas où le client utilise JavaScript, et que le serveur est écrit en PHP, Ruby, Java, et plus encore.

En général, JavaScript fournit deux méthodes de conversion : JSON.stringify et JSON.parse. Vous pouvez utiliser la première pour convertir des objets en JSON et la seconde - pour convertir le JSON en un objet.

JSON.stringify

Considérons l'exemple suivant de l'utilisation de JSON.stringify :

Veuillez noter qu'un objet encodé en JSON diffère de l'objet littéral. Les principales différences sont les suivantes:

1. La chaîne utilise des guillemets doubles. Il ne doit y avoir ni guillemets simples ni backticks dans JSON. Par exemple, 'W3Docs' devient "W3Docs".
2. Les guillemets doubles doivent également être utilisés pour les noms de propriétés d'objet. C'est obligatoire. Par exemple, booksCount : 4 deviendra "booksCount": 4.

Vous pouvez appliquer la méthode JSON.stringify aux primitives également. Elle supporte les types de données suivants :

• Tableaux [ ... ]
• Objets { ... }
• Primitives (nombres, chaînes de caractères, valeurs booléennes et null).

Voici un exemple :

Notez que JSON.stringify ignore plusieurs objets spécifiques à JavaScript, tels que les propriétés des fonctions (méthodes), les propriétés symboliques et les propriétés stockant undefined.

Examinons le cas suivant :

Le meilleur dans tout cela est que les objets imbriqués sont automatiquement pris en charge et convertis.

Par exemple :

Mais il y a aussi une limitation essentielle : vous ne devez pas utiliser de références circulaires.

Par exemple :

Exclusion et Transformation : replacer

Pour JSON.stringify la syntaxe complète suivante est utilisée :

let json = JSON.stringify(value[, replacer, space])

Il a trois arguments :

• la valeur : une valeur pour l'encodage;
• le replacer : le tableau des propriétés pour l'encodage ou une fonction de mappage function(key, value);;
• l'espace : quantité d'espace utilisée pour la mise en forme.

JSON.stringify utilise le plus souvent le premier argument. Mais si vous souhaitez améliorer votre processus de remplacement, vous pouvez également utiliser le second argument. Si un tableau de propriétés lui est passé, seules ces propriétés sont encodées.

Examinons un exemple :

Maintenant, essayons d'ajouter à la liste toutes les propriétés, à l'exception de books.free :

Comme vous pouvez le voir, tout est sérialisé, sauf canUse. Vous pouvez également remarquer que la liste donnée semble plutôt longue. Heureusement, la fonction replacer peut être appelée. Vous pouvez l'appeler pour chaque paire key, value, et la valeur "remplacée" peut être renvoyée. Vous pouvez l'utiliser à la place de la valeur originale. Pour ignorer canUse, undefined est renvoyé dans l'exemple ci-dessous :

Notez que la fonction replacer reçoit toute paire clé/valeur avec les éléments de tableau et les objets imbriqués.

Formatage : espace

Comme mentionné précédemment, JSON.stringify a trois arguments. Le troisième est le nombre d'espaces utilisés pour le formatage. Généralement, les développeurs utilisent l'argument space pour obtenir une sortie excellente.

Le space = 2 ordonne à JavaScript d'afficher les objets imbriqués sur différentes lignes avec une indentation de deux espaces à l'intérieur d'un objet.

Par exemple :

"toJSON" personnalisé

En règle générale, un objet peut fournir la méthode toJSON pour implémenter la conversion to-JSON. Si elle est disponible, JSON.stringify l'appelle automatiquement.

Voici un exemple :

Dans le cas ci-dessus, update (1) est transformé en une chaîne. La raison en est que toutes les dates ont une méthode toJSON intégrée.

Si vous ajoutez un toJSON personnalisé pour l'objet books (2), il ressemblera à ceci :

JSON.parse

Pour décoder une chaîne JSON, une autre méthode est utilisée, appelée JSON.parse avec la syntaxe suivante :

let value = JSON.parse(str, [reviver]);

JSON est quelque peu compliqué : les objets et les tableaux peuvent inclure d'autres objets et tableaux. Mais il est obligatoire de respecter le format du JSON.

Vous trouverez ci-dessous les erreurs typiques dans du JSON écrit à la main :

let json = `{
  welcome: "Welcome",                     // mistake: property name without quotes
  "site": 'W3Docs',               // mistake: single quotes in value (must be double)
  'hasAdmin': true                  // mistake: single quotes in key (must be double)
  "update": new Date(2000, 2, 3), // mistake: no "new" is allowed, only bare values
  "books": [1, 2, 3, 4]              // here all fine
}`;

De plus, notez que JSON ne permet pas de commenter. Si vous ajoutez un commentaire, vous le rendrez invalide. Il existe un format spécifique JSON, qui prend en charge les clés non citées, les commentaires, et plus encore.

Résumé

JSON représente un format de données avec une norme indépendante et des bibliothèques pour la majorité des langages de programmation. Il prend en charge les tableaux, les chaînes de caractères, les objets, les booléens, les nombres, et null.

JavaScript a les méthodes JSON.stringify pour la sérialisation en JSON et JSON.parse pour la lecture à partir de JSON. Dans le cas où un objet a toJSON, vous devez l'appeler par JSON.stringify..