Go 1.24's omitzero Tag erklärt

Vorwort

In Go Version 1.24 führte das Paket encoding/json das Tag omitzero ein, wodurch das Verhalten des Ignorierens von Feldern mit Nullwerten expliziter und anpassbarer wurde. Dieser Artikel bietet eine detaillierte Erklärung zur Verwendung des Tags omitzero.

Das omitzero Tag

Das omitzero Tag wird verwendet, um zu steuern, welche Felder mit Nullwerten beim Serialisieren von Go-Objekten in JSON ausgelassen werden sollen. Im Gegensatz zum Tag omitempty, das Felder mit Leeren Werten auslässt, sind Nullwerte und leere Werte zwar ähnlich, aber in Go nicht gleichwertig. Zum Beispiel:

• Für den Typ time.Time ist der Nullwert "0001-01-01T00:00:00Z", der nicht als leerer Wert betrachtet wird.
• Für ein Slice-Feld wie IntSlice []int werden sowohl [] als auch nil als leere Werte betrachtet.

Warum omitzero verwenden

• Präzise Steuerung: Lässt explizit Felder mit Nullwerten aus, anstatt Felder mit leeren Werten.
• Benutzerdefinierte Steuerung: Durch die Implementierung der Methode IsZero() bool können Sie benutzerdefinierte Logik definieren, um den Nullwert eines Feldes zu bestimmen.

Verwenden des omitzero Tags

package main

import (
  "encoding/json"
  "fmt"
  "time"
)

type User struct {
  Name    string    `json:"name,omitzero"`
  Age     int       `json:"age,omitzero"`
  Hobbies []string  `json:"hobbies,omitzero"`
  BornAt  time.Time `json:"born_at,omitzero"`
}

func main() {
  user := User{
    Name:    "Leapcell",
    Age:     18,
    Hobbies: []string{},
  }

  bytes, _ := json.MarshalIndent(user, "", "  ")
  fmt.Println(string(bytes))
}

Die Ausführung von string(bytes) gibt das folgende JSON-Ergebnis aus:

{
  "name": "Leapcell",
  "age": 18,
  "hobbies": []
}

Wenn stattdessen das Tag omitempty verwendet würde, würde das Feld hobbies ausgelassen. Darüber hinaus würde born_at selbst als Nullwert als "born_at": "0001-01-01T00:00:00Z" serialisiert. Durch die Verwendung des Tags omitzero können wir genauer steuern, welche Felder ignoriert werden, und sicherstellen, dass nur Felder mit Nullwerten ausgeschlossen werden.

Die Methode IsZero() bool

Die Methode IsZero() bool wird verwendet, um die Logik zur Bestimmung, ob ein Feld ein Nullwert ist, anzupassen. Wenn Sie ändern möchten, wie der Nullwert eines Feldes bestimmt wird, können Sie die Methode IsZero für dieses Feld implementieren. Hier ist ein Beispiel:

package main

import (
  "encoding/json"
  "fmt"
  "time"
)

type Age int

func (age *Age) IsZero() bool {
  return *age <= 0
}

type User struct {
  Name    string    `json:"name,omitzero"`
  Age     Age       `json:"age,omitzero"`
  Hobbies []string  `json:"hobbies,omitzero"`
  BornAt  time.Time `json:"born_at,omitzero"`
}

func main() {
  user := User{
    Name:    "Leapcell",
    Age:     -1,
    Hobbies: []string{},
  }

  bytes, _ := json.MarshalIndent(user, "", "  ")
  fmt.Println(string(bytes))
}

In diesem Beispiel definiert das Feld Age seine eigene Nullwertlogik, indem es die Methode IsZero implementiert. Wenn Age kleiner oder gleich 0 ist, gibt IsZero true zurück, und das Feld wird während der Serialisierung ausgelassen. Die Ausgabe ist:

{
  "name": "Leapcell",
  "hobbies": []
}

Zusammenfassung

In Go können wir durch die Verwendung des Tags omitzero präzise steuern, welche Felder während der JSON-Serialisierung ausgelassen werden, und sicherstellen, dass nur Felder mit Nullwerten ausgeschlossen werden. Durch die Implementierung der Methode IsZero können wir zusätzlich benutzerdefinierte Nullwertlogiken für bestimmte Felder definieren und so ein flexibleres und kontextbezogeneres Serialisierungsverhalten ermöglichen.

---

Wir sind Leapcell, Ihre erste Wahl für das Hosten von Go-Projekten.

Leapcell ist die Next-Gen Serverless Plattform für Webhosting, Async Tasks und Redis:

Multi-Language Support

• Entwickeln Sie mit Node.js, Python, Go oder Rust.

Stellen Sie unbegrenzt viele Projekte kostenlos bereit

• zahlen Sie nur für die Nutzung - keine Anfragen, keine Gebühren.

Unschlagbare Kosteneffizienz

• Pay-as-you-go ohne Leerlaufgebühren.
• Beispiel: 25 $ unterstützen 6,94 Mio. Anfragen bei einer durchschnittlichen Antwortzeit von 60 ms.

Optimierte Entwicklererfahrung

• Intuitive Benutzeroberfläche für mühelose Einrichtung.
• Vollautomatische CI/CD-Pipelines und GitOps-Integration.
• Echtzeit-Metriken und -Protokollierung für verwertbare Erkenntnisse.

Mühelose Skalierbarkeit und hohe Leistung

• Automatische Skalierung zur einfachen Bewältigung hoher Parallelität.
• Null Betriebsaufwand - konzentrieren Sie sich einfach auf das Bauen.

Erfahren Sie mehr in der Dokumentation!

Folgen Sie uns auf X: @LeapcellHQ