如何在编组时省略结构字段* *,但在解组时保留它?

时间:2017-05-23 22:33:42

标签: json go marshalling unmarshalling

我有一个带有密码字段的User结构。当我通过POSTed JSON创建用户(或使用新密码进行更新)时,我想接受/解密密码字段到我的对象中,但每当我返回用户时,我想要省略密码字段。以下是我迄今为止能够提出的最好成绩。它有效,但它需要围绕我想消除的字段名称重复批次(现在,如果我添加一个像FirstName这样的新字段,我必须在3个不同的地方添加。)

如何更好地执行此操作,同时仍然尊重结构上的json标记?

func main() {
    origJson := []byte(`{"id":"1","username":"Chad","pwd":"sillypants"}`)
    fmt.Println("Original:     " + string(origJson))

    var unmarshalled User
    json.Unmarshal(origJson, &unmarshalled)
    fmt.Printf("Unmarshalled: %+v\n", unmarshalled)

    marshalled, _ := json.Marshal(unmarshalled)
    fmt.Println("ReMarshalled: " + string(marshalled))
}

type User struct {
    Id       string `json:"id"`
    Username string `json:"username"`
    Password string `json:"pwd"`
}

type SafeUser struct {
    Id       string `json:"id"`
    Username string `json:"username"`
}

func (u User) MarshalJSON() ([]byte, error) {
    safeUser := SafeUser{
        Id      : u.Id,
        Username: u.Username,
    }

    return json.Marshal(safeUser)
}
Go Playground

Try it

2 个答案:

答案 0 :(得分:5)

利用embedded structs。定义用户,并将其嵌入到添加密码字段的UnsafeUser中(以及其他任何内容,如付款信息)。

type User struct {
    Id       string `json:"id"`
    Username string `json:"username"`
}

type UnsafeUser struct {
    User
    Password string `json:"pwd"`
}

(默认情况下最好安全并声明不安全的内容,例如Go's unsafe pacakge。)

然后,您可以从UnsafeUser中提取用户,而无需知道并复制所有字段。

func (uu UnsafeUser) MarshalJSON() ([]byte, error) {
    return json.Marshal(uu.User)
}

$ go run ~/tmp/test.go
Original:     {"id":"1","username":"Chad","pwd":"sillypants"}
Unmarshalled: {User:{Id:1 Username:Chad} Password:sillypants}
ReMarshalled: {"id":"1","username":"Chad"}

请注意如何在Unmarshalled UnsafeUser中看到嵌入的User结构。

答案 1 :(得分:3)

我遇到了同样的问题,但遇到了this article

我们的想法是使用嵌入和匿名结构来覆盖字段。

func (u User) MarshalJSON() ([]byte, error) {
    type Alias User
    safeUser := struct {
        Password string `json:"pwd,omitempty"`
        Alias
    }{
        // Leave out the password so that it is empty
        Alias: Alias(u),
    }

    return json.Marshal(safeUser)
}

Try it

Alias有助于在编组时防止无限循环。

请注意,您必须保持相同的JSON字段名称才能使覆盖工作。