当编组而不是解组时,Golang会忽略Json字段

Question

假设我在User结构中有一个密码字段.

type User struct{
   UserName string `json:"username"`
   Password string `json:"-"`
}

我的客户通过一起发布用户名和密码来注册用户.因此,如果我将JSON解码为上面的结构,它会忽略密码.这是预期的.但是我想知道在编组时是否有任何方法可以忽略字段.我查了官方文档页面但找不到任何东西.

https://golang.org/pkg/encoding/json/

我可以在结构中添加一个额外的字段,但我首先需要知道是否可以使用JSON lib.

Answer 1

一种常见的方法是使用具有相同结构但不同json标签甚至不同结构的临时类型或变量:

type User struct {
    UserName string `json:"username"`
    Password string `json:"password"`
}

func (usr User) MarshalJSON() ([]byte, error) {
    var tmp struct {
        UserName string `json:"username"`
    }
    tmp.UserName = usr.UserName
    return json.Marshal(&tmp)
}

Answer 2

与Go中的任何自定义编组/解组要求一样,最好的办法是查看自定义类型的实现json.Marshaler/ json.Unmarshaler接口.

在这种情况下,您可以为密码字段执行此操作:

// Use an explicit password type.
type password string

type User struct{
    UserName string   `json:"username"`
    Password password `json:"password"`
}

// Marshaler ignores the field value completely.
func (password) MarshalJSON() ([]byte, error) {
    return []byte(`""`), nil
}

请注意,通过不实现json.Unmarshaler,类型password保留其基础类型(string)的默认行为,这允许使用Password值对结构进行解组.

工作示例:https://play.golang.org/p/HZQoCKm0vN

Answer 3

我更喜欢类型组合。例如：

type User struct {
    UserName string `json:"username"`
}

type UserWithPassword struct {
    *User
    Password string `json:"password"`
}

接收数据时使用 UserWithPassword（例如用户创建/修改），返回时使用 User（身份验证）。