How to marshal a byte/uint8 array as json array in Go?

by

According to the docs, a []byte will be encoded as a Base64 string.

“Array and slice values encode as JSON arrays, except that []byte encodes as a base64-encoded string, and a nil slice encodes as the null JSON object.”

So I think that you may need to make your struct implement the Marshaler interface by implementing your own MarshalJSON method that makes a more desirable JSON array encoding out of your []uint8.

Take this example:

import "fmt"
import "encoding/json"
import "strings"

type Test struct {
    Name  string
    Array []uint8
}

func (t *Test) MarshalJSON() ([]byte, error) {
    var array string
    if t.Array == nil {
        array = "null"
    } else {
        array = strings.Join(strings.Fields(fmt.Sprintf("%d", t.Array)), ",")
    }
    jsonResult := fmt.Sprintf(`{"Name":%q,"Array":%s}`, t.Name, array)
    return []byte(jsonResult), nil
}

func main() {
    t := &Test{"Go", []uint8{'h', 'e', 'l', 'l', 'o'}}

    m, err := json.Marshal(t)
    if err != nil {
        fmt.Println(err)
    }
    fmt.Printf("%s", m) // {"Name":"Go","Array":[104,101,108,108,111]}
}

http://play.golang.org/p/Tip59Z9gqs

Or maybe a better idea would be to make a new type that has []uint8 as its underlying type, make that type a Marshaler, and use that type in your struct.

import "fmt"
import "encoding/json"
import "strings"

type JSONableSlice []uint8

func (u JSONableSlice) MarshalJSON() ([]byte, error) {
    var result string
    if u == nil {
        result = "null"
    } else {
        result = strings.Join(strings.Fields(fmt.Sprintf("%d", u)), ",")
    }
    return []byte(result), nil
}

type Test struct {
    Name  string
    Array JSONableSlice
}

func main() {
    t := &Test{"Go", []uint8{'h', 'e', 'l', 'l', 'o'}}

    m, err := json.Marshal(t)
    if err != nil {
        fmt.Println(err)
    }
    fmt.Printf("%s", m) // {"Name":"Go","Array":[104,101,108,108,111]}
}

http://play.golang.org/p/6aURXw8P5d

More Related Contents:

  1. How I can encode JSON with multiple elements in Go Lang [closed]
  2. Go JSON Naming strategy about extends
  3. json.Marshal(struct) returns “{}”
  4. JSON and dealing with unexported fields
  5. How to parse/deserialize dynamic JSON
  6. My structures are not marshalling into json [duplicate]
  7. Unmarshal JSON with some known, and some unknown field names
  8. Converting Go struct to JSON
  9. Taking a JSON string, unmarshaling it into a map[string]interface{}, editing, and marshaling it into a []byte seems more complicated then it should be
  10. Handling JSON Post Request in Go
  11. How to get JSON response from http.Get
  12. Why struct fields are showing empty?
  13. Unmarshaling nested JSON objects
  14. Unmarshaling json in Go: required field?
  15. How to parse a complicated JSON with Go unmarshal?
  16. How do I send a JSON string in a POST request in Go
  17. How to decode JSON with type convert from string to float64
  18. Partly JSON unmarshal into a map in Go
  19. How to not marshal an empty struct into JSON with Go?
  20. Accessing Nested Map of Type map[string]interface{} in Golang
  21. Parsing multiple JSON objects in Go
  22. Is it possible to partially decode and update JSON? (go)
  23. How to parse JSON in golang without unmarshaling twice
  24. Decode JSON as it is still streaming in via net/http
  25. How can I pretty-print JSON using Go?
  26. json unmarshal time that isn’t in RFC 3339 format
  27. How to unmarshal JSON into interface{} in Go?
  28. Call json.Unmarshal inside UnmarshalJSON function without causing stack overflow
  29. JSON single value parsing
  30. How to format timestamp in outgoing JSON

Leave a Comment