• 功能选项

    功能选项

    功能选项是一种模式，声明一个不透明 Option 类型，该类型记录某些内部结构体的信息。您的函数接受这些不定数量的选项参数，并将选项参数上的信息作用于内部结构上。

    此模式可用于扩展构造函数和实现其他公共 API 中的可选参数，特别是这些参数已经有三个或者超过三个的情况下。

    BadGood
    1. // package db
    3. func Connect(
    4.   addr string,
    5.   timeout time.Duration,
    6.   caching bool,
    7. ) (Connection, error) {
    8.   // …
    9. }
    11. // Timeout and caching must always be provided,
    12. // even if the user wants to use the default.
    14. db.Connect(addr, db.DefaultTimeout, db.DefaultCaching)
    15. db.Connect(addr, newTimeout, db.DefaultCaching)
    16. db.Connect(addr, db.DefaultTimeout, false / caching /)
    17. db.Connect(addr, newTimeout, false / caching /)
    		 
    1. type options struct {
    2.   timeout time.Duration
    3.   caching bool
    4. }
    6. // Option overrides behavior of Connect.
    7. type Option interface {
    8.   apply(options)
    9. }
    11. type optionFunc func(options)
    13. func (f optionFunc) apply(o options) {
    14.   f(o)
    15. }
    17. func WithTimeout(t time.Duration) Option {
    18.   return optionFunc(func(o options) {
    19.     o.timeout = t
    20.   })
    21. }
    23. func WithCaching(cache bool) Option {
    24.   return optionFunc(func(o options) {
    25.     o.caching = cache
    26.   })
    27. }
    29. // Connect creates a connection.
    30. func Connect(
    31.   addr string,
    32.   opts …Option,
    33. ) (*Connection, error) {
    34.   options := options{
    35.     timeout: defaultTimeout,
    36.     caching: defaultCaching,
    37.   }
    39.   for _, o := range opts {
    40.     o.apply(&options)
    41.   }
    43.   // …
    44. }
    46. // Options must be provided only if needed.
    48. db.Connect(addr)
    49. db.Connect(addr, db.WithTimeout(newTimeout))
    50. db.Connect(addr, db.WithCaching(false))
    51. db.Connect(
    52.   addr,
    53.   db.WithCaching(false),
    54.   db.WithTimeout(newTimeout),
    55. )

    另见，

    • Self-referential functions and the design of options
    • Functional options for friendly APIs