Comparer des données JSON — réponses d'API, fichiers de configuration, fichiers de traduction — est une tâche fréquente. Or, en comparant deux JSON tels quels comme du texte, on obtient souvent une foule de différences alors que les données sont identiques. Cet article en explique la raison et la solution.
D'où viennent les fausses différences
La norme JSON (RFC 8259) définit un objet comme « une collection non ordonnée de paires nom/valeur ». Autrement dit, {"a":1,"b":2} et {"b":2,"a":1} représentent les mêmes données. Mais en tant que texte, l'ordre des lignes diffère et diff y voit une différence. D'autres écarts sans rapport avec les données apparaissent aussi :
- La largeur de l'indentation (2 espaces, 4 espaces, tabulation) et le JSON compacté sur une seule ligne
- La présence ou non d'un espace après les deux-points (
"a":1et"a": 1) - L'écriture des nombres (
1.0et1,1e2et100) - L'échappement des chaînes (
"\u00e9"et"é")
La solution : analyser puis réécrire sous la même forme
La méthode la plus fiable consiste à analyser les deux JSON pour en faire des données, puis à les resérialiser selon les mêmes règles.
- Analysez (parsez) les deux textes comme du JSON. S'il y a une erreur de syntaxe, corrigez-la d'abord.
- Triez récursivement les clés de tous les objets.
- Réécrivez le tout avec la même indentation (par exemple 2 espaces).
- Comparez le résultat ligne par ligne.
Par exemple, les deux JSON suivants ne diffèrent que par l'ordre des clés et par l'ordre d'un tableau.
{"name":"kim","age":30,"tags":["a","b"]}{"age":30,"name":"kim","tags":["b","a"]}Après tri et réécriture, la différence d'ordre des clés disparaît et seule reste la vraie différence, l'ordre du tableau.
@@ -2,7 +2,7 @@ "age": 30, "name": "kim", "tags": [- "a",- "b"+ "b",+ "a" ] }On ne trie pas les tableaux
Contrairement aux objets, l'ordre des éléments d'un tableau a un sens. ["a","b"] et ["b","a"] sont des données différentes. En règle générale, la normalisation ne trie donc pas les tableaux. Toutefois, pour un tableau dont l'ordre n'a pas d'importance métier, comme une liste de tags, le trier vous-même avant la comparaison rend le résultat plus lisible. Le bon choix dépend de la signification des données.
Ce que l'analyse modifie au passage
Réécrire après analyse a des effets secondaires à connaître.
- L'écriture des nombres est uniformisée.
1.0et1deviennent tous deux1et paraissent identiques. C'est généralement souhaitable, mais si l'écriture elle-même compte, comparez aussi le texte brut. - La précision des grands entiers. JavaScript manipule les nombres en virgule flottante sur 64 bits : les entiers supérieurs à
Number.MAX_SAFE_INTEGER(2^53 − 1 = 9007199254740991) ne sont pas représentés exactement. Par exemple,9007199254740993devient9007199254740992après analyse. Méfiez-vous des JSON qui contiennent de longs identifiants sous forme de nombres. - Les clés en double. La RFC 8259 recommande seulement (SHOULD) que les noms soient uniques au sein d'un objet ; le traitement des clés en double varie selon les implémentations.
JSON.parseen JavaScript conserve la dernière valeur. - Commentaires et virgules finales.
// commentaireou une virgule finale comme dans[1, 2,]ne font pas partie du JSON standard (des formats étendus comme JSON5 ou JSONC les acceptent). Un analyseur standard renvoie une erreur.
En ligne de commande
Si jq est installé, l'option -S (--sort-keys) affiche le JSON avec ses clés triées.
jq -S . before.json > a.json
jq -S . after.json > b.json
diff -u a.json b.jsonLa différence avec JSON Patch
Le résultat d'un diff est une liste de modifications par ligne, destinée à être lue par un humain. JSON Patch (RFC 6902), lui, est une norme qui exprime les modifications par chemins dans la structure JSON, comme {"op":"replace","path":"/age","value":31}, tandis que JSON Merge Patch (RFC 7396) consiste à appliquer sur l'original un JSON qui ne contient que les parties modifiées. Pour échanger des modifications entre programmes, ces normes conviennent ; pour une relecture humaine, le diff textuel après tri est plus adapté.
Essayer avec cet outil
Dans les options du comparateur de texte, activez Trier les clés JSON : les deux côtés sont analysés, leurs clés triées et le tout réécrit avec une indentation de 2 espaces avant la comparaison. L'ordre des tableaux n'est pas modifié, et en cas d'échec de l'analyse, l'outil indique de quel côté et à quel caractère se trouve l'erreur. Vous pouvez aussi déposer deux fichiers .json à la fois. Pour lire le résultat comme un patch, consultez Lire un diff unifié.