0Pricing
Go Academy · 课时

构建灵活的 API

应用这一模式

构建灵活的 API 是 CoddyKit 上的免费 Go Academy 课时。 这是第 3 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Go Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Go Academy 课程共包含 4 节课。

应用这一模式

现在组装完整模式:构造函数接收必需参数以及可变数量的选项。

可变参数构造函数

必需参数位于前面;选项随后以 ...Option 的形式出现。

package main

import "fmt"

type Server struct {
	Host string
	Port int
}
type Option func(*Server)

func WithPort(p int) Option { return func(s *Server) { s.Port = p } }

func NewServer(host string, opts ...Option) *Server {
	s := &Server{Host: host}
	for _, opt := range opts {
		opt(s)
	}
	return s
}

func main() {
	s := NewServer("localhost", WithPort(8080))
	fmt.Printf("%+v\n", *s)
}

不带选项调用

由于选项是可变参数,调用方可以完全省略它们,并依赖构造函数设置的内容。

package main

import "fmt"

type Server struct{ Host string; Port int }
type Option func(*Server)

func NewServer(host string, opts ...Option) *Server {
	s := &Server{Host: host}
	for _, o := range opts { o(s) }
	return s
}

func main() {
	s := NewServer("localhost")
	fmt.Printf("%+v\n", *s)
}

带多个选项调用

您可以按需叠加任意多个选项;每个选项在调用位置都清晰可读。

package main

import "fmt"

type Server struct {
	Host    string
	Port    int
	Timeout int
	TLS     bool
}
type Option func(*Server)

func WithPort(p int) Option    { return func(s *Server) { s.Port = p } }
func WithTimeout(t int) Option { return func(s *Server) { s.Timeout = t } }
func WithTLS() Option          { return func(s *Server) { s.TLS = true } }

func NewServer(host string, opts ...Option) *Server {
	s := &Server{Host: host}
	for _, o := range opts { o(s) }
	return s
}

func main() {
	s := NewServer("localhost", WithPort(9000), WithTimeout(60), WithTLS())
	fmt.Printf("%+v\n", *s)
}

调用能够自我说明

将 NewServer("localhost", WithPort(9000), WithTLS()) 与位置参数调用进行比较。无需查看签名,调用意图也一目了然。

日后添加选项

需要新的设置吗?添加一个 WithX 函数即可。所有现有调用位置都能继续原样编译——这才是真正的向后兼容。

package main

import "fmt"

type Server struct{ Host string; Retries int }
type Option func(*Server)

func WithRetries(n int) Option { return func(s *Server) { s.Retries = n } }

func NewServer(host string, opts ...Option) *Server {
	s := &Server{Host: host}
	for _, o := range opts { o(s) }
	return s
}

func main() {
	fmt.Printf("%+v\n", *NewServer("h", WithRetries(5)))
}

传递选项

由于选项是值,您可以在其他位置构建切片,然后将其转发给构造函数。

package main

import "fmt"

type Server struct{ Host string; Port int }
type Option func(*Server)

func WithPort(p int) Option { return func(s *Server) { s.Port = p } }

func NewServer(host string, opts ...Option) *Server {
	s := &Server{Host: host}
	for _, o := range opts { o(s) }
	return s
}

func main() {
	common := []Option{WithPort(443)}
	s := NewServer("api", common...)
	fmt.Printf("%+v\n", *s)
}

作为公共应用程序接口的选项

导出 Option 类型和 WithX 函数,这样库的使用者就能配置您的类型,而无需接触其内部实现。

保持字段私有

配置字段可以保持未导出;选项是设置这些字段的唯一正式途径,从而保护不变量。

这一模式最适合的场景

  • 具有许多可选配置项的库构造函数
  • 必须随着发展保持稳定的应用程序接口
  • 客户端、服务器、日志记录器和构建器

标准库中的类似用法

您会在 Go 生态系统中看到这种风格(例如 gRPC 和许多驱动程序)。识别出这种模式后,您会更容易熟悉这些应用程序接口。

快速检查

测试您对灵活应用程序接口的掌握程度。

回顾

您使用函数式选项构建了灵活的应用程序接口。

  • 先传入必需参数,再传入 ...Option
  • 遍历选项并逐个应用
  • 调用方可以传入零个或多个选项,调用清晰易读
  • 日后添加选项而不破坏调用方

常见问题解答

「构建灵活的 API」课时是免费的吗?

是的 — 「构建灵活的 API」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Go Academy 课程的其余内容,请升级到 CoddyKit PRO。 Go Academy 课程共包含 4 节课。

「构建灵活的 API」这节课中我会学到什么?

应用这一模式 你通过在浏览器中直接运行的动手代码来练习 Go Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Go Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 Go Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 3 节课,共 4 节。

「构建灵活的 API」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 Go Academy 课中编写并运行代码吗?

能。每节 Go Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 参数过多的问题
  2. 选项函数
  3. 构建灵活的 API
  4. 默认值与验证
← 返回 Go Academy