json - 隐藏结构体字段并使其同步字段的访问和修改的最佳方法是什么？

Question

这是我在使用 golang 结构时遇到的问题

 type User struct {
     name  string `json:"name"`
     email string `json:"email"`
 }

现在我希望该结构体字段的访问和修改是并发安全的 因此添加了互斥锁并添加了锁定互斥锁的方法 用户代码现在只能通过方法访问和变异，不能直接访问字段

type User struct {
     name string  `json:"name"`
     email string `json:"email"`
     sync.RWMutex `json:"-"`
}

func (u *User) Name() string {
   u.RLock()
   defer u.RUnlock()

   return u.name  
}

func (u *User) Email() string {
   u.RLock()
   defer u.RUnlock()

   return u.email  
}

func (u *User) SetName(p string) {
   u.Lock()
   defer u.Unlock()

   u.name = p  
}

func (u *User) SetEmail(p string) {
   u.RLock()
   defer u.RUnlock()

   u.email = p  
}

到目前为止一切顺利，但问题是 json/bson 编码失败，因为它需要导出字段

因此，我实现了自定义编码，它返回类似的结构，但具有导出的字段

func (self User) MarshalJSON() ([]byte, error) {
    var usr struct {
        Name  string `json:"name"` 
        Email string `json:"email,omitempty"`
        sync.RWMutex `json:"-"`
    }
    return json.Marshal(usr)
}

func (self *User) UnmarshalJSON(b []byte) error {
    var usr struct {
        Name   string  `json:"name"`
        Email  string  `json:"email"` 
        sync.RWMutex   `json:"-"`
    }

    if err := json.Unmarshal(b, &usr); err != nil {
        return err
    }

    self.name = usr.Name
    self.email = usr.Email

    return nil
}

但这并不能完全使 User 结构并发安全，因为编码代码未锁定。

我的问题是如何使编码代码使用相同的互斥锁？ 当我们创建该结构的多个实例时，使互斥锁成为全局并不能解决问题。 编码(marshal)中声明的用户结构与主用户结构不同，因此锁定内部结构的互斥体是没有意义的。

实现这一目标的最佳方法是什么？

Answer 1

您不必向您编码的值添加互斥锁，这是毫无意义的。

但是在复制或设置其字段时，您确实需要使用用户的互斥体。

一些重要的事情:

• 如果嵌入非指针互斥体，则必须使用指针接收器指定所有方法，否则锁将被复制!

• 您不需要在未导出的字段上指定 json 标记，这是多余的。更进一步，由于您提供了自己的编码(marshal)逻辑，您甚至不必提供任何 json 标记，因为它们根本不会被使用。所以这个 User 就足够了:

  type User struct {
      name  string
      email string
      sync.RWMutex
  }
  

• 即使 name 和 email 未导出，这些值也不“安全”，因为您提供了导出的 MarshalJSON() 返回这些值的方法(JSON 格式)。您在访问 User.name 和 User.email 方面仍然具有编译时安全性，但要知道它们存储的值不是 secret 的。

示例:

func (u *User) MarshalJSON() ([]byte, error) {
    u.RLock()
    usr := struct {
        Name  string `json:"name"`
        Email string `json:"email,omitempty"`
    }{u.name, u.email}
    u.RUnlock()

    return json.Marshal(usr)
}

func (u *User) UnmarshalJSON(b []byte) error {
    usr := struct {
        Name  string `json:"name"`
        Email string `json:"email"`
    }{}

    if err := json.Unmarshal(b, &usr); err != nil {
        return err
    }

    u.Lock()
    u.name = usr.Name
    u.email = usr.Email
    u.Unlock()

    return nil
}