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

What is the best way to hide struct fields and yet make it synchronise access and modification of fields?

这是我在使用 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 编组失败,因为它需要导出字段

所以我实现了自定义编组,其中 returns 一个类似的结构,但具有导出的字段

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 的互斥体。

一些重要的事情:

  • 如果你嵌入了一个非指针互斥量,你必须用指针接收者指定你的所有方法,否则锁将被复制!
  • 您不需要在未导出的字段上指定 json 标签,那是多余的。更进一步,由于您提供了自己的编组逻辑,您甚至不必提供任何 json 标记,因为它们根本不会被使用。所以这个 User 就足够了:

    type User struct {
        name  string
        email string
        sync.RWMutex
    }
    
  • 即使 nameemail 未导出,这些值也不是 "safe",因为您提供了导出的 MarshalJSON() 方法 return 这些值(采用 JSON 格式)。您仍然拥有访问 User.nameUser.email 的编译时安全性,但要知道它们存储的值不是秘密的。

示例:

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
}