MarshalJSON具有嵌入式类型的类型最终以{}代替值

时间:2019-03-25 12:33:57

标签: json go struct embedding

要与大手笔互动,我需要制作一个自定义的BigInt结构,该结构只不过绕着go的big.Int

type BigInt struct {
    big.Int
}

...
type SpendTx struct {
    SenderID    string       `json:"sender_id,omitempty"`
    RecipientID string       `json:"recipient_id,omitempty"`
    Amount      utils.BigInt `json:"amount,omitempty"`
    Fee         utils.BigInt `json:"fee,omitempty"`
    Payload     string       `json:"payload,omitempty"`
    TTL         uint64       `json:"ttl,omitempty"`
    Nonce       uint64       `json:"nonce,omitempty"`
}

func (t SpendTx) JSON() (output []byte, err error) {
    return json.Marshal(t)
}

我希望SpendTx.JSON()最终会调用big.Int.MarshalJSON(),它将返回0。相反,我得到了以下输出:

{"sender_id":"alice","recipient_id":"bob","amount":{},"fee":{},"payload":"Hello World","ttl":10,"nonce":1}

但是我真正想要的是:

{"sender_id":"alice","recipient_id":"bob","amount":10,"fee":10,"payload":"Hello World","ttl":10,"nonce":1}

我必须将以下代码添加到BigInt中:

func (b BigInt) MarshalJSON() ([]byte, error) {
    return b.Int.MarshalJSON()
}

但是根据Effective Go's section on embedding structs,这根本没有必要。为什么big.Int显示为{}

1 个答案:

答案 0 :(得分:6)

big.Int实现了自定义JSON封送程序(json.Marshaler),请参阅Int.MarshalJSON()。但是此方法具有指针接收器,因此只有在具有指针值*big.Int的情况下,才使用/调用该方法。

并且您嵌入了一个非指针值,因此不会调用此自定义封送拆收器,并且由于big.Int是具有未导出字段的结构,因此您将在输出中看到一个空的JSON对象:{}

要使其正常工作,您应该使用指向您类型的指针,例如:

Amount      *utils.BigInt `json:"amount,omitempty"`
Fee         *utils.BigInt `json:"fee,omitempty"`

使用示例:

s := SpendTx{
    SenderID:    "alice",
    RecipientID: "bob",
    Amount:      &utils.BigInt{},
    Fee:         &utils.BigInt{},
}
data, err := s.JSON()
fmt.Println(string(data), err)

然后将以输出为例(在Go Playground上尝试):

{"sender_id":"alice","recipient_id":"bob","amount":0,"fee":0} <nil>

另一种选择是使用非指针utils.BigInt,但是utils.BigInt应该嵌入一个指针类型:

type BigInt struct {
    *big.Int
}

type SpendTx struct {
    Amount      utils.BigInt `json:"amount,omitempty"`
    Fee         utils.BigInt `json:"fee,omitempty"`
}

然后使用它:

s := SpendTx{
    SenderID:    "alice",
    RecipientID: "bob",
    Amount:      utils.BigInt{new(big.Int)},
    Fee:         utils.BigInt{new(big.Int)},
}
data, err := s.JSON()
fmt.Println(string(data), err)

然后将再次输出(在Go Playground上尝试):

{"sender_id":"alice","recipient_id":"bob","amount":0,"fee":0} <nil>