Le JSON doit-il inclure des valeurs nulles ?

Question

Je suis en train de créer une API qui renvoie les résultats en JSON. Existe-t-il une meilleure pratique actuelle pour savoir si nous devons inclure les clés dans le résultat lorsque la valeur est nulle ? Par exemple :

{
    "title":"Foo Bar",
    "author":"Joe Blow",
    "isbn":null
}

ou

{
    "title":"Foo Bar",
    "author":"Joe Blow"
}

Comme le second est plus petit, je penche pour ce style, mais je ne suis pas sûr qu'il y ait un style préféré ou non. Du point de vue du client, il semble que les deux styles soient fonctionnellement équivalents. Quels sont les avantages et les inconvénients de chacun ?

Answer 1

Je suis un adepte de l'inclusion explicite de null, car cela a un sens. Alors que l'omission d'une propriété laisse une ambiguïté.

Tant que votre protocole avec le serveur est accepté, tout ce qui précède peut fonctionner, mais si vous passez des nuls depuis le serveur, je pense que cela rend vos API plus flexibles par la suite.

Il faut également mentionner que la fonction hasOwnProperty de javascript vous donne un aperçu supplémentaire.

/* if true object DOES contain the property with *some* value */
if( objectFromJSON.hasOwnProperty( "propertyName" ) )

/* if true object DOES contain the property and it has been set to null */
if( jsonObject.propertyName === null )

/* if true object either DOES NOT contain the property
   OR
   object DOES contain the property and it has been set to undefined */
if( jsonObject.propertyName === undefined )

Answer 2

La deuxième solution permet d'économiser une petite quantité de bande passante, mais si cela était un problème, vous utiliseriez également des tableaux indexés au lieu de remplir le JSON avec des clés. C'est clair, ["Foo Bar","Joe Blow"] est beaucoup plus courte que celle que vous avez maintenant.

En termes de convivialité, je ne pense pas que cela fasse une différence. Dans les deux cas, if(json.isbn) passera au else . Il n'est généralement pas nécessaire de faire la distinction entre null (sans valeur) et undefined (aucune valeur donnée).

Answer 3

En JavaScript, null signifie quelque chose de très différent de undefined .

Votre sortie JSON doit refléter ce qui est utilisé et nécessaire à votre application dans le contexte spécifique de l'utilisation des données JSON.

Answer 4

Vous devez absolument l'inclure s'il est nécessaire de faire la distinction entre null y undefined car ils ont deux significations différentes en Javascript. Vous pouvez penser à null comme signifiant que le bien est inconnu ou sans signification, et undefined comme signifiant que la propriété n'existe pas.

D'un autre côté, si personne n'a besoin de faire cette distinction, alors allez-y et laissez-la de côté.

Answer 5

Lorsque JSON est utilisé comme support de données de l'API, il n'y a aucune différence entre une valeur nulle ou vide (non définie). Il est probable que la valeur vide soit meilleure car elle permet d'économiser de la taille de la charge utile.

La différence apparaît pour les fichiers JSON-config lorsque vous souhaitez modifier quelque chose à la main. Il est préférable d'avoir des nuls à la place des props indéfinis. De cette façon, vous donnerez des indices sur l'existence des props de configuration.