Go : une nouvelle API JSON
Go travaille à la refonte complète de son API JSON. Fondamentalement, elle a peu évoluée depuis sa apparition dans le langage. "Après avoir pris en compte les retours d'utilisateurs et apporté des améliorations, les nouveaux packages encoding/json/v2 et encoding/json/jsontext sont stables et disponibles pour tous dans Go 1.27 !" explique le long post officiel.
Globalement, l'encodage JSON a bien résisté à l'épreuve du temps. L'idée de sérialiser et de désérialiser des types Go arbitraires avec une représentation JSON par défaut, combinée à la possibilité de personnaliser cette représentation, s'est avérée extrêmement flexible.
De nombreux utilisateurs ont relevé plusieurs lacunes :
- gestion imprécise la syntaxe JSON
- acceptation d'un UTF-8 invalide en encodage JSON
- appel des méthodes un peu aléatoire
- des performances qui pèsent l'environnement Go
- une gestion mémoire imparfaite
Mais changer une API aussi importante pose de nombreux problèmes. Le plus important est l'incompatibilité entre la v1 et la v2 (la nouvelle API). "S'il est relativement facile d'ajouter de nouvelles fonctionnalités, il est difficile de modifier celles existantes. Malheureusement, ces problèmes sont inhérents à l'API actuelle, ce qui les rend pratiquement impossibles à corriger dans le cadre de la compatibilité avec Go 1.
En principe, nous pourrions déclarer des noms distincts, tels que MarshalV2 ou UnmarshalV2, mais cela reviendrait à créer un espace de noms parallèle au sein du même package. C'est pourquoi nous avons opté pour encoding/json/v2 (ci-après appelé v2), où nous pouvons effectuer ces modifications dans un espace de noms v2 séparé, contrairement à encoding/json (ci-après appelé v1)." explique le post.
La sérialisation JSON repose sur 2 composants :
- la fonctionnalité syntaxique, qui traite le JSON en fonction de sa grammaire, et
- la fonctionnalité sémantique, qui définit la relation entre les valeurs JSON et les valeurs Go.
encoding/json/2 package est là pour corriger les problèmes de la v1 sans pour autant rompre avec les habitudes des développeurs et de faciliter la migration vers la v2. Par exemple, les fonctions Marshal et Unmarshel ont des signatures identiques à la v1 mais elles acceptent des options pour pouvoir configurer et modifier le comportement.
Les principales différentes entre la v1 et v2 :
- La version 2 signale une erreur si un encodage UTF-8 est invalide.
- La version 2 signale une erreur si un objet JSON contient un nom dupliqué.
- La version 2 désérialise un objet JSON en une structure Go en utilisant une correspondance sensible à la casse entre le nom du membre JSON et le nom du champ Go.
- La version 2 redéfinit l'option de balise `omitempty` pour omettre un champ s'il aurait été encodé comme une valeur JSON « vide »
- La version 2 signale une erreur lors de la tentative de sérialisation d'un `time.Duration`, qui n'a actuellement pas de représentation par défaut, mais offre des options permettant à l'appelant de choisir.
Présentation complète : https://go.dev/blog/jsonv2