Go Academy · Lekcja

Projektowanie interfejsu pluginu

Współdzielone kontrakty interfejsów między hostem a pluginem

Projektowanie interfejsu pluginu to bezpłatna lekcja Go Academy na CoddyKit. To lekcja 2 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej Go Academy, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs Go Academy zawiera 4 lekcji w sumie.

Pluginy oparte na interfejsach

Należy zdefiniować stabilny interfejs Go, który muszą implementować pluginy. Host ładuje plugin, pobiera implementację i wywołuje ją za pośrednictwem interfejsu — bez wykonywania asercji typu dla każdej metody.

type Processor interface {
    Name() string
    Process(ctx context.Context, data []byte) ([]byte, error)
}

Punkt wejścia pluginu

Każdy plugin eksportuje znany symbol (np. Plugin), który zwraca implementację interfejsu:

// In the plugin:
var Plugin processor // exported symbol

type processor struct{}
func (p processor) Name() string { return "my-processor" }
func (p processor) Process(ctx context.Context, data []byte) ([]byte, error) {
    return bytes.ToUpper(data), nil
}

Ładowanie za pośrednictwem interfejsu

Po stronie hosta należy załadować symbol i wykonać do niego asercję typu interfejsu:

sym, _ := p.Lookup("Plugin")
proc, ok := sym.(Processor)
if !ok { log.Fatal("plugin does not implement Processor") }

Wzorzec rejestru

Należy prowadzić rejestr załadowanych pluginów uporządkowanych według nazw:

var registry = map[string]Processor{}

func register(p Processor) { registry[p.Name()] = p }
func get(name string) (Processor, bool) {
    p, ok := registry[name]
    return p, ok
}

Wersjonowanie interfejsu

Należy dodać metodę Version() do interfejsu, aby host mógł sprawdzić zgodność przed zarejestrowaniem pluginu.

type Versioned interface {
    APIVersion() string
}
if v, ok := proc.(Versioned); ok && v.APIVersion() != "1.0" {
    log.Fatalf("incompatible plugin version: %s", v.APIVersion())
}

Kontekst i anulowanie

Należy przekazywać kontekst przez wywołania metod pluginu, aby host mógł anulować długo trwające operacje pluginu podczas zamykania lub po przekroczeniu limitu czasu żądania.

Kontrakt obsługi błędów

Należy określić, czy pluginy powinny zgłaszać panikę, czy zwracać błędy w przypadku niepowodzenia. Zwracanie błędów jest bezpieczniejsze — paniki w pluginach mogą być niemożliwe do przechwycenia przez middleware recover hosta.

Konfiguracja

Konfigurację należy przekazywać pluginom podczas ładowania za pomocą metody Init(config map[string]string) error. Dzięki temu tworzenie pluginu jest oddzielone od jego konfiguracji.

Zarządzanie cyklem życia

Do interfejsu należy dodać Close() error w przypadku pluginów, które utrzymują zasoby (połączenia z bazą danych, goroutines) wymagające zwolnienia podczas zamykania.

Niezależne testowanie pluginów

Implementację pluginu należy testować bezpośrednio (jako pakiet Go), bez ładowania pliku binarnego .so. Interfejs upraszcza testowanie za pomocą atrap.

Kontrakt dokumentacji

Należy jasno udokumentować kontrakt interfejsu: które metody są wywoływane i kiedy, jakie są gwarancje dotyczące współbieżności oraz co stanowi błąd, a co stan krytyczny.

Szybkie sprawdzenie

Dlaczego należy zdefiniować stabilny interfejs Go dla pluginów zamiast wyszukiwać poszczególne symbole funkcji?

Podsumowanie: projektowanie interfejsu pluginu

Najważniejsze informacje:

Zdefiniować stabilny interfejs, który musi implementować plugin
Eksportować z pluginu znany symbol (var Plugin InterfaceType)
Wykonywać pojedynczą asercję typu podczas ładowania; wszystkie wywołania są bezpieczne typowo dzięki interfejsowi
Dodać Version(), Init() i Close() do zarządzania cyklem życia

Często zadawane pytania

Czy lekcja „Projektowanie interfejsu pluginu” jest bezpłatna?

Tak — pełny tekst „Projektowanie interfejsu pluginu” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu Go Academy, przejdź na CoddyKit PRO. Kurs Go Academy zawiera 4 lekcji w sumie.

Co nauczysz się w „Projektowanie interfejsu pluginu”?

Współdzielone kontrakty interfejsów między hostem a pluginem Ćwiczysz Go Academy z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć Go Academy?

Nie wymagamy żadnego doświadczenia. Go Academy w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 2 z 4.

Ile czasu zajmuje lekcja „Projektowanie interfejsu pluginu”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji Go Academy?

Tak. Każda lekcja Go Academy zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

← Powrót do Go Academy