Toto je tretí článok v sérii "Clean Code in Go". predchádzajúce časti: Čistý kód: Funkcie a riešenie chýb v Go: Od chaosu k jasnosti [Časť 1] Čistý kód v pohybe (časť 2): štruktúry, metódy a zloženie nad dedičnosťou Úvodná stránka > Interfaces - Go's Secret Weapon Sledoval som tímy, ktoré vytvárajú rozhrania 20 metód, ktoré sa stávajú nemožnými na testovanie, výsmech alebo údržbu.Potom sa pýtajú, prečo sa Go cíti hrubý. „Prijmite rozhrania, vráťte štruktúry“ – ak ste počuli len jednu idióm Go, je to pravdepodobne táto.Ale prečo je to tak dôležité? Bežné chyby rozhrania, s ktorými som sa stretol: Rozhrania s viac ako 10 metódami: ~45% kódu Enterprise Go Definovanie rozhraní na mieste implementácie: ~70% balíkov Vrátenie rozhraní namiesto betónových typov: ~55% funkcií Používanie prázdneho rozhrania všade: ~30% API - nil interface vs nil pointer confusion: ~25% jemných chýb Po ôsmich rokoch práce s Go a debugovaní nespočetných problémov súvisiacich s rozhraním môžem povedať: správne používanie rozhraní je rozdiel medzi kódom, ktorý bojuje proti jazyku, a kódom, ktorý prúdi ako voda. Spokojnosť s rozhraním: Duck typing pre dospelých V Go typ automaticky spĺňa rozhranie bez explicitného vyhlásenia: // Interface defines a contract type Writer interface { Write([]byte) (int, error) } // File satisfies Writer automatically type File struct { path string } func (f *File) Write(data []byte) (int, error) { // implementation return len(data), nil } // Buffer also satisfies Writer type Buffer struct { data []byte } func (b *Buffer) Write(data []byte) (int, error) { b.data = append(b.data, data...) return len(data), nil } // Function accepts interface func SaveLog(w Writer, message string) error { _, err := w.Write([]byte(message)) return err } // Usage - works with any Writer file := &File{path: "/var/log/app.log"} buffer := &Buffer{} SaveLog(file, "Writing to file") // OK SaveLog(buffer, "Writing to buffer") // OK Malé rozhrania: Sila jednoduchosti Pravidlo jednotnej metódy Pozrite si štandardnú knižnicu Go: type Reader interface { Read([]byte) (int, error) } type Writer interface { Write([]byte) (int, error) } type Closer interface { Close() error } type Stringer interface { String() string } Jeden spôsob - jeden rozhranie. prečo? // BAD: large interface type Storage interface { Save(key string, data []byte) error Load(key string) ([]byte, error) Delete(key string) error List(prefix string) ([]string, error) Exists(key string) bool Size(key string) (int64, error) LastModified(key string) (time.Time, error) } // Problem: what if you only need Save/Load? // You'll have to implement ALL methods! // GOOD: small interfaces type Reader interface { Read(key string) ([]byte, error) } type Writer interface { Write(key string, data []byte) error } type Deleter interface { Delete(key string) error } // Interface composition type ReadWriter interface { Reader Writer } type Storage interface { ReadWriter Deleter } // Now functions can require only what they need func BackupData(r Reader, keys []string) error { for _, key := range keys { data, err := r.Read(key) if err != nil { return fmt.Errorf("read %s: %w", key, err) } // backup process } return nil } // Function requires minimum - only Reader, not entire Storage Princíp segregácie rozhrania v akcii // Instead of one monstrous interface type HTTPClient interface { Get(url string) (*Response, error) Post(url string, body []byte) (*Response, error) Put(url string, body []byte) (*Response, error) Delete(url string) (*Response, error) Head(url string) (*Response, error) Options(url string) (*Response, error) Patch(url string, body []byte) (*Response, error) } // Create focused interfaces type Getter interface { Get(url string) (*Response, error) } type Poster interface { Post(url string, body []byte) (*Response, error) } // Function requires only what it uses func FetchUser(g Getter, userID string) (*User, error) { resp, err := g.Get("/users/" + userID) if err != nil { return nil, fmt.Errorf("fetch user %s: %w", userID, err) } // parse response return parseUser(resp) } // Testing becomes easier type mockGetter struct { response *Response err error } func (m mockGetter) Get(url string) (*Response, error) { return m.response, m.err } // Only need to mock one method, not entire HTTPClient! Akceptovať rozhrania, vrátiť štruktúry Prečo to záleží // BAD: returning interface func NewLogger() Logger { // Logger is interface return &FileLogger{ file: os.Stdout, } } // Problems: // 1. Hides actual type // 2. Loses access to type-specific methods // 3. Complicates debugging // GOOD: return concrete type func NewLogger() *FileLogger { // concrete type return &FileLogger{ file: os.Stdout, } } // But ACCEPT interface func ProcessData(logger Logger, data []byte) error { logger.Log("Processing started") // processing logger.Log("Processing completed") return nil } Praktický príklad // Repository returns concrete types type UserRepository struct { db *sql.DB } func NewUserRepository(db *sql.DB) *UserRepository { return &UserRepository{db: db} } func (r *UserRepository) FindByID(id string) (*User, error) { // SQL query return &User{}, nil } func (r *UserRepository) Save(user *User) error { // SQL query return nil } // Service accepts interfaces type UserFinder interface { FindByID(id string) (*User, error) } type UserSaver interface { Save(user *User) error } type UserService struct { finder UserFinder saver UserSaver } func NewUserService(finder UserFinder, saver UserSaver) *UserService { return &UserService{ finder: finder, saver: saver, } } // Easy to test - can substitute mocks type mockFinder struct { user *User err error } func (m mockFinder) FindByID(id string) (*User, error) { return m.user, m.err } func TestUserService(t *testing.T) { mock := mockFinder{ user: &User{Name: "Test"}, } service := NewUserService(mock, nil) // test with mock } Kompozícia rozhrania Integrované rozhrania // Base interfaces type Reader interface { Read([]byte) (int, error) } type Writer interface { Write([]byte) (int, error) } type Closer interface { Close() error } // Composition through embedding type ReadWriter interface { Reader Writer } type ReadWriteCloser interface { Reader Writer Closer } // Or more explicitly type ReadWriteCloser interface { Read([]byte) (int, error) Write([]byte) (int, error) Close() error } Typové tvrdenia a typové prepínače // Type assertion - check concrete type func ProcessWriter(w io.Writer) { // Check if Writer also supports Closer if closer, ok := w.(io.Closer); ok { defer closer.Close() } // Check for buffering if buffered, ok := w.(*bufio.Writer); ok { defer buffered.Flush() } w.Write([]byte("data")) } // Type switch - handle different types func Describe(i interface{}) string { switch v := i.(type) { case string: return fmt.Sprintf("String of length %d", len(v)) case int: return fmt.Sprintf("Integer: %d", v) case fmt.Stringer: return fmt.Sprintf("Stringer: %s", v.String()) case error: return fmt.Sprintf("Error: %v", v) default: return fmt.Sprintf("Unknown type: %T", v) } } názov titulu: The Gotchas // WARNING: classic mistake type MyError struct { msg string } func (e *MyError) Error() string { return e.msg } func doSomething() error { var err *MyError = nil // some logic return err // RETURNING nil pointer } func main() { err := doSomething() if err != nil { // TRUE! nil pointer != nil interface fmt.Println("Got error:", err) } } // CORRECT: explicitly return nil func doSomething() error { var err *MyError = nil // some logic if err == nil { return nil // return nil interface } return err } Skontrolovať Nil // Safe nil check for interface func IsNil(i interface{}) bool { if i == nil { return true } // Check if value inside interface is nil value := reflect.ValueOf(i) switch value.Kind() { case reflect.Ptr, reflect.Map, reflect.Slice, reflect.Chan, reflect.Func: return value.IsNil() } return false } Skutočné príklady zo štandardnej knižnice io.Reader/Writer – Nadácia všetkého // Copy between any Reader and Writer func Copy(dst io.Writer, src io.Reader) (int64, error) // Works with files file1, _ := os.Open("input.txt") file2, _ := os.Create("output.txt") io.Copy(file2, file1) // Works with network conn, _ := net.Dial("tcp", "example.com:80") io.Copy(conn, strings.NewReader("GET / HTTP/1.0\r\n\r\n")) // Works with buffers var buf bytes.Buffer io.Copy(&buf, file1) http.Handler — Web Server in One Method type Handler interface { ServeHTTP(ResponseWriter, *Request) } // Any type with ServeHTTP method can be a handler type MyAPI struct { db Database } func (api MyAPI) ServeHTTP(w http.ResponseWriter, r *http.Request) { switch r.URL.Path { case "/users": api.handleUsers(w, r) case "/posts": api.handlePosts(w, r) default: http.NotFound(w, r) } } // HandlerFunc - adapter for regular functions type HandlerFunc func(ResponseWriter, *Request) func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) { f(w, r) // call the function } // Now regular function can be a handler! http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello, World!") }) Vzorky a anti-vzorky Model: Implementácia podmieneného rozhrania // Optional interfaces for extending functionality type Optimizer interface { Optimize() error } func ProcessData(w io.Writer, data []byte) error { // Basic functionality if _, err := w.Write(data); err != nil { return err } // Optional optimization if optimizer, ok := w.(Optimizer); ok { return optimizer.Optimize() } return nil } Anti-Pattern: Príliš všeobecné rozhrania // BAD: interface{} everywhere func Process(data interface{}) interface{} { // type assertions everywhere switch v := data.(type) { case string: return len(v) case []byte: return len(v) default: return nil } } // GOOD: specific interfaces type Sized interface { Size() int } func Process(s Sized) int { return s.Size() } Praktické tipy Definujte rozhrania na strane spotrebiteľa, nie implementáciu Uprednostňujú malé rozhrania pred veľkými Použitie vkladu pre kompozíciu rozhrania Nevráťte rozhrania bez potreby Pamätať nil rozhranie vs nil pointer Používajte typy tvrdení opatrne Interface{} je posledným prostriedkom, nie prvým Kontrolný zoznam rozhrania - Rozhranie má 1-3 metódy maximálne - Rozhranie definované v blízkosti použitia Funkcie prijímajú rozhrania, nie konkrétne typy Funkcie vrátia konkrétne typy, nie rozhrania Žiadne nepoužité metódy v rozhraní - typové tvrdenia sa zaoberajú oboma prípadmi (ok / nie ok) - rozhranie {} použité len v prípade potreby záver Rozhrania sú lepidlom, ktoré drží programy Go spolu. Umožňujú flexibilný, testovateľný a udržateľný kód bez zložitých hierarchií dedičstva. V ďalšom článku budeme diskutovať o balíkoch a závislostiach: ako usporiadať kód tak, aby importný graf bol plochý a závislosti sú jednosmerné. Aký je váš prístup k dizajnu rozhrania? Ako malé je príliš malé? Ako sa rozhodnete, kedy vytvoriť rozhranie v porovnaní s použitím betónu? Zdieľajte svoje skúsenosti v komentároch!
![featured image - Čistý kód: Rozhrania v pohybe - prečo je malý krásny [časť 3]](https://hackernoon.imgix.net/images/ZTiVtl9TF6Mqdq0GSgDuxuALFDX2-d10233z.png?auto=format&fit=max&w=3840)
