soichisumi/go-simple-jsonmarshaler

A library that provides json.Marshal/Unmarshal functions that do not base64 encode []byte fields

go-simple-jsonmarshaler

A library that provides json.Marshal/Unmarshal/Encoder/Decoder that do not base64 encode []byte fields

Motivation

Go base64 encodes the []byte field of struct when Marshal/Unmarshal it.

This is an appropriate way to safely represent byte data in JSON, but most external systems do not base64 encode the JSON string type, and in effect it is not possible to convert the JSON string field of an external system into a []byte field.

If the struct field is a string, it can be marshal/unmarshal without any problem, but if the type is determined by the external (e.g. IDL such as Protocol Buffers), this method cannot be used.

As a workaround for this problem, I have created a library that converts the []byte field of struct to JSON without base64 encoding.

Installation

• go get -u github.com/soichisumi/go-simple-jsonmarshaler

Examples

func ExampleUnmarshal() {
	type Bytes struct {
		A []byte
	}

	in := `{ "a": "not-base64-encoded-string" }`
	
    // json.Unmarshal:
	var v Bytes
	if err := json.Unmarshal([]byte(in), &v); err != nil {
		fmt.Printf("json.Unmarshal: error: %+v\n", err)
	} else {
		fmt.Printf("json.Unmarshal: res: %+v\n", string(v.A))
	}

	// sjson.Unmarshal:
	if err := Unmarshal([]byte(in), &v); err != nil {
		fmt.Printf("sjson.Unmarshal: error: %+v\n", err)
	} else {
		fmt.Printf("sjson.Unmarshal: res: %+v\n", string(v.A))
	}
	// Output:
	// json: error: illegal base64 data at input byte 3
	// sjson: res: not-base64-encoded-string
}

func ExampleMarshal() {
	in := struct{
		A []byte
	}{A: []byte("an string")}

	// json.Marshal:
	b, _ := json.Marshal(in)
	fmt.Printf("json.Marshal: res: %+v\n", string(b))

	// sjson.Marshal:
	b, _ = Marshal(in);
	fmt.Printf("sjson.Unmarshal: res: %+v\n", string(b))

	// Output:
	// json.Marshal: res: {"A":"YW4gc3RyaW5n"}
	// sjson.Unmarshal: res: {"A":"an string"}
}