Go|Go 常见错误集锦之函数式选项模式 Go常见错误集锦之函数式选项模

本节将通过一个常见的用例来展示如何使API方便且友好地接受选项配置。我们将深入研究不同的选项，以达到最后展示一个在Go中流行的解决方案：函数式选项模式。
首先，从概念上看下什么是函数式选项模式。这个概念由两部分组成：函数式和选项。
所谓函数式，是从函数式编程中借鉴过来的概念，即函数和其他基础类型一样，可以将函数作为参数、返回值以及赋值给其他变量。
选项就是配置中的参数字段。所以，函数式选项就是通过一系列的具有相同签名的函数（或匿名函数或带某个函数字段的结构体）来对选项中的字段执行相关的逻辑操作。
下面我们通过一个例子来看看函数式选项模式的演化过程。
假设我们要设计一个库，并暴露一个函数接口来创建一个HTTP服务器。该函数将接受不同的输入：一个地址和一个端口。该函数的签名如下：

func NewServer(addr string, port int) (*http.Server, error) { // ... }

调用者开始使用这个函数，并且所有人都很开心。然而，在某个时间点，调用者开始抱怨该函数有一些限制并缺少一些其他参数（例如，超时时间，连接上下文）。但是，这时我们开始注意到如果我们增加一个新的参数，它将会破坏兼容性，会强制使用者修改他们已经调用过的NewServer函数。
同时，我们也希望扩展与端口管理相关的逻辑，像下图展示的这样：

文章图片

如果端口号没有设置，则使用默认值
如果端口号是负数，则返回错误
如果端口号是0，则使用随机端口
否则，使用用户提供的端口号

我们该如何以友好的API的方式实现这个函数呢？让我们来看看所有的不同实现。
实现一：传一个配置结构体的实现（Config struct）
第一种方法是使用一个结构体（config struct）来处理不同的配置选项。我们可以把参数分成两类：基础配置和可选配置。基础配置参数可以作为函数参数，可选参数在config结构体中处理：

type Config struct { Portint } func NewServer(addr string, cfg Config) { }

这种解决方案修复了兼容性的问题。如果我们增加了新的配置选项，它也不会中断调用者的调用。然而，这种方法没有解决端口管理相关的需求。事实上，我们应该知道如果结构体的字段没有提供，那默认将会被初始化成零值：

int类型的零值是0
浮点类型的零值是0.0
字符串的零值是“”
slice、map、channels、指针、接口和函数的零值是nil

因此，在下面的例子中两个结构体是相等的：

c1 := httplib.Config{ Port:0, ① }c2 := httplib.Config{ ② }

① Port被初始化成0
② Port字段缺失，所以初始值也是0
在我们的例子中，我们需要找到一种方法来正确区分端口号是被设置成了0还是没有提供port字段。一种可能的方法是将结构体的字段都定义成指针类型：

type Config struct { Port *int }

这种方式也会工作，但有两个缺点。

首先，调用者提供整型指针并不方便。调用者必须要创建一个变量并且要以指针的形式传递：

port := 0 config := httplib.Config{ Port: &port, ① }

① 提供一个整型指针
传递指针的话，整体 API 变得不那么方便使用。

第二个缺点是使用我们库的调用者，如果是带默认配置的话，调用者必须要传递一个空结构体：

httplib.NewServer("localhost", httplib.Config{})

这段代码的可读性也不是很好。阅读者不得不思考这个struct结构体到底是什么意思。
实现二：构造器模式
构建器模式为各种对象创建问题提供了灵活的解决方案。我们看看这种模式是如何帮助我们设计一个友好的API，以满足我们所有的需求，包括端口号的管理。

type Config struct { ① Port int } type ConfigBuilder struct { ② Port *int } func (b *ConfigBuilder) Port(port int) { ③ b.Port = &port }func (b *ConfigBuilder) Build() (Config, error) { ④ cfg := Config{} if b.Port == nil { ⑤ cfg.Port = defaultHTTPPort } else { if *b.Port == 0 { cfg.Port = randomPort() } else if *b.Port < 0 { return Config{}, errors.New("port should be positive") } else { cfg.Port = *b.Port } } return cfg, nil }func NewServer(addr string, config Config) (*http.Server, error) { // ... }

① 定义Config结构体
② 定义ConfigBuilder结构体，包含一个可选的port字段
③ 设置port的public方法
④ Build方法创建一个config结构体
⑤ 管理Port的主要逻辑
下面是调用者如何使用我们基于构建器的API（我们假设已经把我们的代码放在了httplib包中）：

builder := httplib.ConfigBuilder{} ① builder.Port(8080) ② cfg, err := builder.Build() ③ if err != nil { return err } server, err := httplib.NewServer("localhost", cfg) ④ if err != nil { return err }

① 创建一个ConfigBuilder结构体
② 设置port
③ 构建config结构体
④ 给函数传递config结构体
这种方法使端口管理更方便。由于该Port方法接受的是一个整型参数，所有没有必要传递一个整型指针。然而，如果调用者只需要默认的配置情况下，依然需要传递一个空的config结构体。

注意：该方法有不同的变体。例如，一种变体是NewServer接收一个ConfigBuilder结构体，然后在函数内部构建config。然而，不管怎样，都必须要传递一个config对象的问题。

在某些场景下，另外一个缺点是和错误管理相关的。在builder的Port方法中，如果输入的参数是非法的，就会抛出异常。但在Go中，我们不能让构建方法返回错误。因为构造器模式一般被认为是用组合的模式进行调用的（例如：builder.Port(8080).Timeout(time.Second).Certificate(cert)）。我们不想让调用者每次都检查错误。因此，在Build方法中我们把校验逻辑推迟了。在一些场景中，这对调用者来说可能不具备表现力。
现在我们来看另一个模式，叫做函数选项模式，它依赖于变量参数。
实现3：函数选项模式
我们要深入研究的最后一种方法是函数选项模式。虽然在不同的实现中有一些小的变化，但其主要思想下面介绍的相同，如下图：

文章图片

每一个选项（例如WithPort）都返回一个Option接口的具体实现，该实现将会更新options结构体中的某个字段。该结构体是私有的：

type options struct { port *int }

同时，我们需要创建一个公有的Option接口和一个私有的applyOptions方法：

type Option interface { apply(*opitons) error ① }type applyOptions struct { f func(*options) error ② } func (ao *applyOptions) apply(opts *options) error { return ao.f(opts) ③ }

① Option接口由一个apply方法构成
② f 字段是一个函数引用，该函数包含了如何更新config结构体的逻辑
③ applyOptions结构体实现了apply方法，该方法中调用了内部的f 函数
整个逻辑的实现在内部的 f 函数字段上。该 f 字段是被调用者使用公开的方法创建的。例如，WithPort方法：

func WithPort(port int) Option { return &applyOptions{ f: func(options *options) error { ① if port < 0 { return errors.New("port should be positive") } options.port = &port return nil }, } }

① 初始化 f 字段，该f字段提供了一段校验输入并且更新config结构体的逻辑
每一个配置字段都需要创建一个包含简单逻辑的公开方法（为了方便一般以With前缀开头）：如需要，则要验证输入参数的合法性以及说明如何更新config结构体。
现在，让我们深入研究供给侧的最后一部分，如何使用这些可选项：

func NewServer(addr string, opts ...Option) (*http.Server, error) { ① var options options ② for _, opt := range opts { ③ err := opt.apply(&options) ④ if err != nil { return nil, err } }// 程序这行到这里，options结构体已经构建完毕并包含了相关的配置 // 因此，我们就可以实现和端口管理相关的逻辑了 var port int if options.port == nil { port = defaultHTTPPort } else { if *options.port == 0 { port = randomPort() } else { port = *options.port } } // ... }

① 接受一个可变的Options参数
② 创建一个空options结构体
③ 循环迭代所有的输入options
④ Apply每一个option，该函数将会修改普通的options结构体
因为NewServer接受一个可变的Option参数，调用者可以通过传递0个或多个options来使用该API：

// No options server, err := httplib.NewServer("localhost") // Multiple options server, err := httplib.NewServer("localhost", httplib.WithPort(8080), httplib.WithTimeout(time.Second))

【Go|Go 常见错误集锦之函数式选项模式】多亏有可变参数，如果调用者需要默认配置，它不需要提供一个空结构体，就像我们在前面看到那样调用：