Go Academy · Leçon

Construire une API flexible

Appliquer le motif

Leçon 3 sur 413 étapes

Construire une API flexible est une leçon Go Academy gratuite sur CoddyKit. Ceci est la leçon 3 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Go Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Go Academy comprend 4 leçons au total.

Mettre le modèle en œuvre

Assemblez maintenant le modèle complet : un constructeur qui accepte les arguments obligatoires, puis une liste variadique d'options.

Le constructeur variadique

Les paramètres obligatoires viennent en premier ; les options suivent sous la forme ...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)
}

Appeler sans options

Comme les options sont variadiques, les appelants peuvent toutes les omettre et s'en remettre à ce que le constructeur initialise.

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)
}

Appeler avec plusieurs options

Empilez autant d'options que vous le souhaitez ; chacune reste clairement lisible sur le site d'appel.

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)
}

Des appels explicites

Comparez NewServer("localhost", WithPort(9000), WithTLS()) à un appel positionnel. L'intention est évidente sans consulter la signature.

Ajouter des options ultérieurement

Besoin d'un nouveau réglage ? Ajoutez une fonction WithX. Chaque site d'appel existant continuera de compiler sans modification : une véritable compatibilité ascendante.

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)))
}

Transmettre des options

Puisque les options sont des valeurs, vous pouvez créer une liste ailleurs et la transmettre au constructeur.

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)
}

Les options comme interface publique

Exposez le type Option et les fonctions WithX afin que les utilisateurs de la bibliothèque configurent votre type sans toucher à ses détails internes.

Garder les champs privés

Les champs de configuration peuvent rester non exportés ; les options sont le seul moyen autorisé de les définir, ce qui protège les invariants.

Quand le modèle est particulièrement utile

  • Les constructeurs de bibliothèques comportant de nombreux paramètres facultatifs
  • Les interfaces qui doivent rester stables à mesure qu'elles évoluent
  • Les clients, les serveurs, les journaliseurs et les générateurs

Échos dans l'écosystème standard

Vous retrouverez ce style dans tout l'écosystème Go, notamment dans gRPC et de nombreux pilotes. Le reconnaître rend ces interfaces familières.

Vérification rapide

Évaluez vos connaissances des interfaces flexibles.

Récapitulatif

Vous avez créé une interface flexible avec des options fonctionnelles.

  • Les arguments obligatoires d'abord, puis ...Option
  • Parcourir les options en appliquant chacune
  • Les appelants peuvent en transmettre zéro ou plusieurs, de manière claire
  • Ajouter des options ultérieurement sans casser les appelants
Gratuit pour commencer

Apprends Go avec un tuteur IA — gratuit

Écris et exécute du vrai code dans ton navigateur, obtiens de l'aide instantanée d'un tuteur IA disponible 24h/24, et reprends là où tu t'es arrêté sur le web ou dans l'app.

Cours
51
Leçons
203

Questions Fréquemment Posées

La leçon « Construire une API flexible » est-elle gratuite ?

Oui — le texte complet de « Construire une API flexible » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Go Academy, passe à CoddyKit PRO. Le cours Go Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Construire une API flexible » ?

Appliquer le motif Tu pratiques Go Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Go Academy ?

Aucune expérience préalable n'est requise. Go Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 3 sur 4.

Combien de temps prend la leçon « Construire une API flexible » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Go Academy ?

Oui. Chaque leçon Go Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

  1. Le problème des paramètres nombreux
  2. Fonctions d’options
  3. Construire une API flexible
  4. Valeurs par défaut et validation
← Retour à Go Academy