Opbygning af en fleksibel API
Anvend mønstret
Opbygning af en fleksibel API er en gratis Go Academy-lektion på CoddyKit. Dette er lektion 3 af 4. Du kan læse alle 3 lektioner i dette læringsspor gratis i deres fulde længde — derefter låser CoddyKit PRO alle lektioner op samt praktiske øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Den er en del af læringsforløbet i Go Academy, og dine fremskridt synkroniseres på tværs af nettet og CoddyKit-appen. Go Academy-kurset indeholder 4 lektioner i alt.
Anvend mønsteret
Nu samler du hele mønsteret: en konstruktør, der modtager påkrævede argumenter samt en variadisk liste af indstillinger.
Den variadiske konstruktør
De påkrævede parametre kommer først; indstillingerne følger som ...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)
}Kald uden indstillinger
Fordi indstillingerne er variadiske, kan kaldere helt udelade dem og benytte det, konstruktøren sætter op.
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)
}Kald med flere indstillinger
Stak så mange indstillinger, du vil; hver af dem er tydelig på kaldestedet.
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)
}Selvforklarende kald
Sammenlign NewServer("localhost", WithPort(9000), WithTLS()) med et positionsbestemt kald. Hensigten er tydelig uden at kontrollere signaturen.
Tilføj indstillinger senere
Har du brug for en ny indstilling? Tilføj en WithX-funktion. Alle eksisterende kaldesteder bliver ved med at compilere uden ændringer — ægte bagudkompatibilitet.
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)))
}Send indstillinger rundt
Da indstillinger er værdier, kan du bygge en slice et andet sted og sende den videre til konstruktøren.
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)
}Indstillinger som offentlig API
Eksportér typen Option og funktionerne WithX, så biblioteksbrugere kan konfigurere din type uden at røre dens interne detaljer.
Bevar felterne private
Konfigurationsfelterne kan forblive ikke-eksporterede; indstillinger er den eneste godkendte måde at sætte dem på, hvilket beskytter invariansbetingelserne.
Hvor mønsteret er særligt nyttigt
- Bibliotekskonstruktører med mange valgfrie indstillinger
- API'er, der skal forblive stabile, efterhånden som de vokser
- Klienter, servere, loggere og byggere
Genklange fra standardbiblioteket
Du vil se denne stil i hele Go-økosystemet (gRPC og mange drivere). Når du genkender den, føles disse API'er velkendte.
Hurtigt tjek
Afprøv din viden om fleksible API'er.
Opsummering
Du har bygget en fleksibel API med funktionelle indstillinger.
- Påkrævede argumenter først, derefter
...Option - Gå gennem indstillingerne, og anvend hver af dem
- Kaldere sender nul eller mange indstillinger, som er tydelige at læse
- Tilføj indstillinger senere uden at bryde kaldere
Lær Go med en AI-underviser — gratis
Skriv og kør rigtig kode i din browser, få øjeblikkelig hjælp fra en AI-underviser døgnet rundt, og fortsæt, hvor du slap, på web eller i appen.
- Kurser
- 51
- Lektioner
- 203
Ofte stillede spørgsmål
Er lektionen “Opbygning af en fleksibel API” gratis?
Ja — alle 3 lektioner i læringssporet Go Academy, inklusive “Opbygning af en fleksibel API”, kan læses gratis i deres fulde længde her på webstedet. Derefter låser CoddyKit PRO alle lektioner op samt interaktive øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Go Academy-kurset indeholder 4 lektioner i alt.
Hvad lærer jeg i “Opbygning af en fleksibel API”?
Anvend mønstret Du øver dig i Go Academy med praktisk kode, som du kører direkte i browseren, og en AI-vejleder døgnet rundt besvarer dine spørgsmål, mens du arbejder dig gennem lektionen.
Skal jeg have erfaring for at begynde på Go Academy?
Der kræves ingen tidligere erfaring. Go Academy på CoddyKit er tilrettelagt for både begyndere og øvede, så du kan starte her eller fra begyndelsen og lære i dit eget tempo. Dette er lektion 3 af 4.
Hvor lang tid tager lektionen “Opbygning af en fleksibel API”?
De fleste CoddyKit-lektioner tager cirka 5–10 minutter. Hver lektion er kort og interaktiv, så du gør løbende fremskridt og kan fortsætte, hvor du slap – på både web og app.
Kan jeg skrive og køre kode i denne Go Academy-lektion?
Ja. Alle Go Academy-lektioner har en indbygget kodeeditor, så du kan skrive og køre rigtig kode direkte i din browser og få øjeblikkelig feedback fra AI – uden lokal opsætning.
Alle lektioner i dette kursus
- Problemet med mange parametre
- Option-funktioner
- Opbygning af en fleksibel API
- Standardværdier og validering