JSON omitempty With time.Time Field

by

The omitempty tag option does not work with time.Time as it is a struct. There is a “zero” value for structs, but that is a struct value where all fields have their zero values. This is a “valid” value, so it is not treated as “empty”.

But by simply changing it to a pointer: *time.Time, it will work (nil pointers are treated as “empty” for json marshaling/unmarshaling). So no need to write custom Marshaler in this case:

type MyStruct struct {
    Timestamp *time.Time `json:",omitempty"`
    Date      *time.Time `json:",omitempty"`
    Field     string     `json:",omitempty"`
}

Using it:

ts := time.Date(2015, 9, 18, 0, 0, 0, 0, time.UTC)
ms := MyStruct{
    Timestamp: &ts,
    Field:     "",
}

Output (as desired):

{"Timestamp":"2015-09-18T00:00:00Z"}

Try it on the Go Playground.

If you can’t or don’t want to change it to a pointer, you can still achieve what you want by implementing a custom Marshaler and Unmarshaler. If you do so, you can use the Time.IsZero() method to decide if a time.Time value is the zero value.

Related Contents:

  1. How to define multiple name tags in a struct
  2. How to format timestamp in outgoing JSON
  3. Capitals in struct fields
  4. How do I send a JSON string in a POST request in Go
  5. Handling JSON Post Request in Go
  6. How can I pretty-print JSON using Go?
  7. Decoding JSON using json.Unmarshal vs json.NewDecoder.Decode
  8. Converting Go struct to JSON
  9. Removing fields from struct or hiding them in JSON Response
  10. Lowercase JSON key names with JSON Marshal in Go
  11. How to get JSON response from http.Get
  12. json.Marshal(struct) returns “{}”
  13. Partly JSON unmarshal into a map in Go
  14. How to serve up a JSON response using Go?
  15. Convert Go map to json
  16. How to not marshal an empty struct into JSON with Go?
  17. How to decode JSON with type convert from string to float64
  18. Unmarshal JSON with some known, and some unknown field names
  19. JSON and dealing with unexported fields
  20. Unmarshaling nested JSON objects
  21. Unmarshaling json in Go: required field?
  22. What input will cause golang’s json.Marshal to return an error?
  23. json unmarshal time that isn’t in RFC 3339 format
  24. Cannot unmarshal string into Go value of type int64
  25. Why does json.Unmarshal work with reference but not pointer?
  26. Decode JSON with unknown structure
  27. JSON unmarshaling with long numbers gives floating point number
  28. golang json marshal: how to omit empty nested struct
  29. Most efficient way to convert io.ReadCloser to byte array
  30. Has Json tag but not exported [duplicate]
  31. JSON golang boolean omitempty
  32. How to unmarshal an escaped JSON string
  33. How to parse/deserialize dynamic JSON
  34. How Do I Parse a JSON file into a struct with Go
  35. How to parse unix timestamp to time.Time
  36. How do I do a literal *int64 in Go?
  37. Go Interface Fields
  38. How to update a value in a json file and save it through node.js
  39. jq Conditional output
  40. Only allow properties that are declared in JSON schema
  41. How to serialize a JObject without the formatting?
  42. Nested ng-repeat
  43. Standardized way to serialize JSON to query string?
  44. How to set and get fields in struct’s method
  45. Modify default JSON error response from Spring Boot Rest Controller
  46. Json Java serialization that works with GWT [closed]
  47. How to use jq when the variable has reserved characters?
  48. tell typescript to compile json files
  49. loading .json files generates 404 errors
  50. Using jq how can I replace the name of a key with something else

Leave a Comment