GO 函數式選項模式(Functional Options Pattern)

Posted on by

Golang 開發者遇到的許多問題之一是嘗試將一個函數的參數設置為可選. 這是一個非常常見的用例, 有些對象應該使用一些基本的默認設置來開箱即用, 並且你偶爾可能需要提供一些更詳細的配置.

在很多語言中這很容易; 在 C 族語言中, 可以使用不同數量的參數提供相同函數的多個版本; 在像 PHP 這樣的語言中, 可以給參數一個默認值，並在調用方法時忽略它們. 但是在 Golang 中, 這兩種方式你哪個也用不瞭. 那麼你如何創建一個函數, 用戶可以指定一些額外的配置?

有很多可能的方法可以做到這一點, 但是大多數都不能滿足要求, 或者需要在服務端的代碼中進行額外的檢查和驗證, 或者通過傳遞額外的客戶端不關心的參數來為客戶端做額外的工作.

下面介紹GO 函數式選項模式(Functional Options Pattern)，內容如下：

Option模式的優缺點
優點:
    1. 支持傳遞多個參數，並且在參數個數、類型發生變化時保持兼容性
    2. 任意順序傳遞參數
    3. 支持默認值
    4. 方便拓展
缺點:
    1. 增加許多function，成本增大
    2. 參數不太復雜時，盡量少用

DEMO

package main

import "fmt"

type Client struct {
	Id        int64
	AppKey    string
	AppSecret string
}

type Option func(*Client) //  go函數的參數都是值傳遞 因此想要修改Client(默認值) 必須傳遞指針

func WithAppKey(appKey string) Option {
	return func(client *Client) {
		client.AppKey = appKey
	}
}

func WithAppSecret(appSecret string) Option {
	return func(client *Client) {
		client.AppSecret = appSecret
	}
}

//
//  NewClient
//  @Description 將一個函數的參數設置為可選的功能
//  @param id 固定參數，也可以將所有都放進可選參數 opts 中
//  @param opts
//  @return Client 返回 *Client 和 Client 都可以
//
func NewClient(id int64, opts ...Option) Client {
	o := Client{
		Id:        id,
		AppKey:    "key_123456",
		AppSecret: "secret_123456",
	}

	for _, opt := range opts {
		opt(&o) //  go函數的參數都是值傳遞 因此想要修改Client(默認值) 必須傳遞指針
	}

	return o
}

func main() {
	//  使用默認值
	fmt.Println(NewClient(1)) //  {1 key_123456 secret_123456}
	//  使用傳入的值
	fmt.Println(NewClient(2, WithAppKey("change_key_222"))) //  {2 change_key_222 secret_123456}
	//  不按照順序傳入
	fmt.Println(NewClient(3, WithAppSecret("change_secret_333"))) //  {3 key_123456 change_secret_333}
	fmt.Println(NewClient(4, WithAppSecret("change_secret_444"), WithAppKey("change_key_444"))) //  {4 change_key_444 change_secret_444}
}

到此這篇關於GO 函數式選項模式(Functional Options Pattern)的文章就介紹到這瞭,更多相關GO 函數式選項模式內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：