0 Tage Serie
go / intermediate
Snippet

Implementierung einer benutzerdefinierten JSON-Serialisierung für Domänentypen

Durch die Implementierung von json.Marshaler und json.Unmarshaler für benutzerdefinierte Typen steuern Sie, wie Go-Strukturen in und aus JSON konvertiert werden. Dies ist besonders nützlich, um Enums als lesbare Strings in JSON-API-Daten anstelle von rohen Ganzzahlen darzustellen.

snippet.go
go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main
import (
"encoding/json"
"fmt"
"strings"
)
type Status int
const (
Pending Status = iota
Active
)
func (s Status) MarshalJSON() ([]byte, error) {
var str string
switch s {
case Pending:
str = "pending"
case Active:
str = "active"
default:
str = "unknown"
}
return json.Marshal(str)
}
func (s *Status) UnmarshalJSON(data []byte) error {
var str string
if err := json.Unmarshal(data, &str); err != nil {
return err
}
caseInsensitive := strings.ToLower(str)
switch caseInsensitive {
case "pending":
*s = Pending
case "active":
*s = Active
default:
return fmt.Errorf("invalid status: %s", str)
}
return nil
}
Erklärung
1
func (s Status) MarshalJSON() ([]byte, error) {
Implementiert das json.Marshaler-Interface, um den benutzerdefinierten Ganzzahlstatus in eine lesbare JSON-Zeichenkette zu konvertieren.
2
func (s *Status) UnmarshalJSON(data []byte) error {
Implementiert das json.Unmarshaler-Interface. Verwendet einen Zeiger-Empfänger, um den Zielwert während der JSON-Dekodierung zu ändern.
3
*s = Pending
Dereferenziert den Zeiger-Empfänger, um den Status basierend auf dem geparsten JSON-String-Wert zu aktualisieren.