Personnalisation de la mise en page JSON pour time.Time dans Golang

Dans Golang, la fonction encoding/json.Marshal est couramment utilisée pour convertir des objets en JSON. Cependant, avec les paramètres par défaut, il se peut qu'il ne corresponde pas à la disposition JSON souhaitée. Cet article illustre une solution pour remplacer la disposition par défaut et personnaliser le format utilisé par les champs time.Time lors du marshalling JSON.

Supposons que vous ayez un struct s avec un champ time.Time nommé starttime. Lors du marshalling de cette structure en JSON, vous souhaitez utiliser une mise en page personnalisée spécifique.

s := {"starttime":time.Now(), "name":"ali"}

Pour y parvenir, nous pouvons créer un type personnalisé qui intègre time.Time et remplace les méthodes MarshalText et MarshalJSON.

import "fmt"
import "time"
import "encoding/json"

type jsonTime struct {
    time.Time
    f string
}

func (j jsonTime) format() string {
    return j.Time.Format(j.f)
}

func (j jsonTime) MarshalText() ([]byte, error) {
    return []byte(j.format()), nil
}

func (j jsonTime) MarshalJSON() ([]byte, error) {
    return []byte(`"`   j.format()   `"`), nil
}

En remplaçant MarshalText, nous contrôlons la façon dont le type jsonTime convertit sa valeur en forme de texte, nous permettant de spécifier la mise en page personnalisée. De plus, en remplaçant MarshalJSON, nous garantissons que la méthode remplacée est utilisée à la place de l'implémentation time.Time intégrée pour le marshalling JSON.

Avec le type jsonTime personnalisé, vous pouvez désormais marshaler votre structure s en utilisant la disposition souhaitée. :

jt := jsonTime{time.Now(), time.Kitchen}
x := map[string]interface{}{
    "foo": jt,
    "bar": "baz",
}
data, err := json.Marshal(x)
if err != nil {
    panic(err)
}

Cela produira une chaîne JSON avec le champ starttime formaté en fonction de la disposition time.Kitchen.