一文详解Go语言中的Option设计模式

寻技术 Go编程 2023年07月11日 154

关于什么是设计模式,笔者在这里就不做过多的解释。大家自行百度谷歌就好。下面我们聊聊Option设计模式,这个单词翻译过来就是选项的意思。

它一般都是用在初始化数据的时候使用。

type User struct {
    // 必须初始化的值
    Username string
    Age int
    
    // 非必要初始化的值
    Password string
}

结构体中,有些字段是必须要初始化的,而有些则是不用。那些不用初始化的字段就被称为可选项。用户根据自己的实际需求对其进行初始化。

一般来说,对于这种结构体,不论是必须初始化的字段还是非必须的,都是私有的字段,不会暴露给外界。

下面是一个标准的Option的设计模式

// 定义一个Option函数签名
type UserOption func(user *User)

// 提供一个可选函数
func WithUserPassword(password string) UserOption {
    return func(user *User) {
        user.Password = password
    }
}

type User struct {
    // 必须初始化的值
    Username string
    Age int
    
    // 非必要初始化的值
    Password string
}

// 定义一个初始化User的方法
func NewUser(username string, age int, opts...UserOption) *User {
    user := &User{
        Username: username,
        Age: age,
    }
    for _, opt := range opts {
        opt(user)
    }
    return user
}

步骤

  • 定义一个结构体,内部字段全部都是私有的,并且存在必须初始化字段和非必要初始化字段
  • 定义一个Option函数签名,参数是结构体指针,必须是结构体指针,因为只有指针才能设置上值
  • 定义一个初始化结构体的方法,参数是结构体必须要初始化的字段值,外加一个Option函数切片,返回值可以是结构体,也可以是指针结构体
  • 初始化结构体方法内部先初始化好一个最基本的结构体,然后遍历Option函数切片
  • 定义的Option函数实现最好用With开头,规范,不遵守也可以

Option模式变种

// 定义一个Option函数签名
type UserOptionErr func(user *User) error

// 提供一个可选函数
func WithUserPassword(password string) UserOption {
    return func(user *User) error {
        if password == "" {
            return errors.New("password 不能为空")
        }
        user.Password = password
        return nil
    }
}

type User struct {
    // 必须初始化的值
    Username string
    Age int
    
    // 非必要初始化的值
    Password string
}

// 定义一个初始化User的方法
func NewUser(username string, age int, opts...UserOption) (*User, error) {
    user := &User{
        Username: username,
        Age: age,
    }
    for _, opt := range opts {
        if err := opt(user); err != nil {
            return nil, err
        }
    }
    return user, nil
}

大家应该发现了,就是修改Option函数签名的返回值,这种模式可以用作对Option函数的参数进行校验。由于这里发生了变更,导致初始化结构体的方法也需要做出相应的变化。

对于Option模式,在很多场景中都能用到,并且也是非常好用的。大家记住它是在初始化数据的时候用就行,代码模式相对固定。

原文地址:https://juejin.cn/post/7229816598058565691
关闭

用微信“扫一扫”