[Go开源工具] go-optioner:轻松生成函数选项模式代码

简介: 你是否使用过 functional options 函数选项模式?在使用时,你是否遇到过多字段的结构体而需要手动编写大量的设置选项函数的代码?本文介绍了 go-opioner 开源工具的安装和使用,它能够根据结构体的定义,自动生成函数选项模式的代码。

作者:陈明勇
个人网站:https://chenmingyong.cn
文章持续更新,如果本文能让您有所收获,欢迎关注本号。
微信阅读可搜《Go 技术干货》。这篇文章已被收录于 GitHub https://github.com/chenmingyong0423/blog 欢迎大家 Star 催更并持续关注。

前言

最近在进行重构代码时,我遇到了一个问题:在使用函数选项模式来构造一个结构体时,由于该结构体字段过多,我需要手动编写大量的设置选项函数的代码。这样的工作既繁琐又容易出错。

为了解决这个问题,我开始在 github 上面寻找能够根据结构体的定义自动生成函数选项模式代码的工具,尽管找到了几个相关工具,但并没有完全符合我的要求。因此我决定自己动手,开发了 go-optioner 工具,并将其推荐给大家使用。

工具链接: https://github.com/chenmingyong0423/go-optioner

欢迎 Star,如果有任何问题或提供功能的改进方案,欢迎提交 IssuesPull Request(PR)

go-optioner

go-optioner 是一个在 Go 代码中生成函数选项模式代码的工具。该工具可以根据给定的结构定义自动生成相应的选项代码。

安装

  • 1、go install github.com/chenmingyong0423/go-optioner/cmd/optioner@latest
  • 2、执行 optioner 命令检查是否安装成功
      > optioner
      optioner is a tool for generating functional options pattern.
      Usage: 
               optioner [flags]
      Flags:
               -type <struct name>
               -output <output path>, default: srcDir/opt_xxx_gen.go
    
    如果你安装成功了,但是提示 optioner 命令找不到,请确认是否已将 $GOPATH/bin 添加到环境变量中。

使用教程

你可以直接使用 optioner 命令生成对应结构体的 functional options 代码,也可以使用 go generate 命令进行批量生成。

optioner 命令

  • 1、首先,你需要创建一个包含需要生成函数选项模式代码的结构体的 Go 文件。在结构体字段中,您可以使用 opt 标签来控制是否为 NewXXX() 函数的必传参数和生成相应的函数。

      package example
    
      type User struct {
         
          Name   string `opt:"-"`
          Age    int
          Gender string
      }
    

    如果字段定义了 opt 标签,并且值为 -,则它将作为 NewXXX 函数的必要参数,并且不会生成该字段的 WithXXX 函数。

注意:必须声明 package

  • 2、在包含结构体定义的文件目录下,执行 optioner -type XXX 命令,其中 XXX 是结构体的名称。执行命令之后,optioner 工具会根据结构体定义生成相应的函数选项模式代码。内容如下所示:

      // Generated by optioner -type User; DO NOT EDIT
      // If you have any questions, please create issues and submit contributions at:
      // https://github.com/chenmingyong0423/go-optioner
    
      package example
    
      type UserOption func(*User)
    
      func NewUser(name string, opts ...UserOption) *User {
         
          user := &User{
         
              Name: name,
          }
    
          for _, opt := range opts {
         
              opt(user)
          }
    
          return user
      }
    
      func WithAge(age int) UserOption {
         
          return func(user *User) {
         
              user.Age = age
          }
      }
    
      func WithGender(gender string) UserOption {
         
          return func(user *User) {
         
              user.Gender = gender
          }
      }
    

    optioner 工具将会生成一个名为 opt_xxx_gen.go 的文件,其中 xxx 是结构体的名称,例如 opt_user_gen.go。该文件包含生成的函数选项代码,用于初始化结构体和设置结构体字段的值。

go generate 命令

请注意,在执行 go generate 命令之前,确保您的项目已经初始化 Go Modules 或正确设置了 GOPATH,并且您的项目结构符合 Go ModulesGOPATH 的要求。

  • 1、首先,你需要创建一个包含需要生成函数选项模式代码的结构体的 Go 文件。在结构体定义之上,你需要添加 //go:generate optioner -type XXX 的注释,其中 XXX 是结构体的名称。这样工具就能根据参数生成相应的代码。在结构体字段中,您可以使用 opt 标签来控制是否为 NewXXX() 函数的必传参数和生成相应的函数。

      package example
    
      //go:generate optioner -type User
      type User struct {
         
          Name   string `opt:"-"`
          Age    int
          Gender string
      }
    

    如果字段定义了 opt 标签,并且值为 -,则它将作为 NewXXX 函数的必要参数,并且不会生成该字段的 WithXXX 函数。

注意:必须声明 package

  • 2、在包含结构体定义的文件目录下,执行 go generate 命令,这将调用 optioner 工具并根据结构体定义生成相应的函数选项模式代码。内容如下所示:

      // Generated by optioner -type User; DO NOT EDIT
      // If you have any questions, please create issues and submit contributions at:
      // https://github.com/chenmingyong0423/go-optioner
    
      package example
    
      type UserOption func(*User)
    
      func NewUser(name string, opts ...UserOption) *User {
         
          user := &User{
         
              Name: name,
          }
    
          for _, opt := range opts {
         
              opt(user)
          }
    
          return user
      }
    
      func WithAge(age int) UserOption {
         
          return func(user *User) {
         
              user.Age = age
          }
      }
    
      func WithGender(gender string) UserOption {
         
          return func(user *User) {
         
              user.Gender = gender
          }
      }
    

    optioner 工具将会生成一个名为 opt_xxx_gen.go 的文件,其中 xxx 是结构体的名称,例如 opt_user_gen.go。该文件包含生成的函数选项代码,用于初始化结构体和设置结构体字段的值。

小结

在本文中,我介绍了 go-opioner 开源工具的安装和使用,它能够根据结构体的定义,自动生成函数选项模式的代码。它让我们告别繁琐的构造函数编写和修改,让代码编写过程更加高效和愉悦。

希望各位开发者能够踊跃给 go-optioner 点予星标(Star),以示支持和认可。您的支持是持续改进和优化工具的动力。同时,也欢迎各位提交 IssuesPull Request(PR),为 go-optioner 提出宝贵的意见和贡献更好的功能和改进。

工具链接: https://github.com/chenmingyong0423/go-optioner

目录
相关文章
|
22天前
|
存储 算法 Go
go语言中的延迟执行函数
【5月更文挑战第13天】`defer`是Go语言中用于延迟执行函数的关键字,尤其适用于资源管理,如文件关闭和锁的释放。它在函数返回前按照LIFO顺序执行,确保资源在任何返回路径下都能正确释放。`defer`可以拦截`panic`并在函数返回前执行,但无法阻止某些致命的`panic`。此外,`defer`可用于修改返回值、输出调试信息和还原变量值。尽管在某些场景下可能影响性能,但Go的优化使得其在多数情况下性能表现良好,特别是在资源清理方面。在Go 1.20及以后的版本,`defer`的性能已显著提升,尤其是在高计算量的场景下。
246 2
|
7天前
|
Go
掌握Go语言:Go语言错误处理,从基础到高级,让你的代码更健壮!(33)
掌握Go语言:Go语言错误处理,从基础到高级,让你的代码更健壮!(33)
|
9天前
|
关系型数据库 Go 开发工具
|
16天前
|
编译器 Go
Go 语言函数
Go 语言函数
16 7
|
16天前
|
编译器 Go 索引
浅谈go语言中的符文字符处理工具
【5月更文挑战第20天】本文简述了Go 1.20之后的rune符文处理工具和函数,`unsafe`包新增了SliceData、String和StringData函数,支持直接将slice转换为array,明确了数组和结构体比较顺序。
33 1
浅谈go语言中的符文字符处理工具
|
20天前
|
数据可视化 算法 Java
了解go语言运行时工具的作用
【5月更文挑战第16天】本文简介`runtime`库提供系统调用包装、执行跟踪、内存分配统计、运行时指标和剖析支持。`internal/syscall`封装系统调用,保证uintptr参数有效。`trace`用于执行跟踪,捕获各种事件,如goroutine活动、系统调用和GC事件。`ReadMemStats`提供内存分配器统计。`metrics`接口访问运行时定义的度量,包括CPU使用、GC和内存信息。`coverage`支持代码覆盖率分析,`cgo`处理C语言交互,`pprof`提供性能剖析工具集成。这些功能帮助优化和理解Go程序的运行行为。
37 6
|
30天前
|
Go 数据处理
Go杂记1-切片Slice作为函数参数那点事儿
Go杂记1-切片Slice作为函数参数那点事儿
18 0
|
30天前
|
Kubernetes Go 开发者
GO编程语言:简洁、高效、强大的开源编程语言
GO语言,又称Golang,是由Google公司开发的一种静态类型、编译型的编程语言。其设计理念是提供一种直观、简洁、可靠的解决方案
22 2
|
30天前
|
前端开发 Go
Golang深入浅出之-Go语言中的异步编程与Future/Promise模式
【5月更文挑战第3天】Go语言通过goroutines和channels实现异步编程,虽无内置Future/Promise,但可借助其特性模拟。本文探讨了如何使用channel实现Future模式,提供了异步获取URL内容长度的示例,并警示了Channel泄漏、错误处理和并发控制等常见问题。为避免这些问题,建议显式关闭channel、使用context.Context、并发控制机制及有效传播错误。理解并应用这些技巧能提升Go语言异步编程的效率和健壮性。
44 5
Golang深入浅出之-Go语言中的异步编程与Future/Promise模式
|
30天前
|
设计模式 Go 调度
Golang深入浅出之-Go语言中的并发模式:Pipeline、Worker Pool等
【5月更文挑战第1天】Go语言并发模拟能力强大,Pipeline和Worker Pool是常用设计模式。Pipeline通过多阶段处理实现高效并行,常见问题包括数据竞争和死锁,可借助通道和`select`避免。Worker Pool控制并发数,防止资源消耗,需注意任务分配不均和goroutine泄露,使用缓冲通道和`sync.WaitGroup`解决。理解和实践这些模式是提升Go并发性能的关键。
32 2