Niedawno zasugerowałem metodę łączenia dla pewnej klasy w pewnym projekcie, aby poprawić czytelność kodu. Dostałem odpowiedź „płynne interfejsy nie powinny być implementowane tylko dla wygody, ale dla semantyki” i kazałem zrzucić moją sugestię. Odpowiedziałem, że nie sugeruję płynnego interfejsu, ale samą metodę łączenia łańcuchów (obie można pomylić ze sobą, czytać na dole), aby poprawić czytelność i komfort kodowania, sugestia została ponownie zestrzelona.

W każdym razie, to sprawiło, że pomyślałem, że być może będę narażony na złą praktykę, zawsze zwracając „to” metodami, które nie powinny niczego zwracać (np. Setery).

Moje pytanie brzmi: czy stosowanie poprzedniej konwencji można uznać za złą praktykę lub nadużycie ?, dlaczego ?. Nie sądzę, żeby były wady wydajności, czy są?

Nie

Jak zauważa Kent Beck , kod jest odczytywany znacznie częściej niż jest pisany.

Jeśli łączenie metod sprawia, że ​​kod jest bardziej czytelny, użyj łączenia łańcuchowego metod.

Tak, są wady

Kod, który jest łatwy do odczytania, jest dobry, ale należy także uważać na to, co kod komunikuje . Kiedy metody obiektu zawsze zwracają obiekt, komunikuje się kilka rzeczy:

1. Potrzebuję zaawansowanej konfiguracji, która niekoniecznie jest oczywista, w jakiej kolejności należy ustawić lub skonfigurować rzeczy
2. Każde kolejne wywołanie metody opiera się na ostatnim

Prawidłowy przypadek użycia: zapytania do bazy danych ad hoc

Biblioteki klas istnieją w większości języków, które pozwalają wyszukiwać w bazie danych bez uciekania się do SQL. Weźmy przykład Entity Framework dla platformy .NET:

DBContext db = new DBContext();
List<Post> posts = db.Posts
    .Where(post => post.Title.Contains("Test"))
    .OrderBy(post => post.DateCreated)
    .ToList();

Jest to płynny interfejs, w którym każde kolejne wywołanie metody opiera się na poprzednim. Logiczne czytanie tych wywołań ma sens w kontekście odpytywania bazy danych.

Nieprawidłowy przypadek użycia: cukier składniowy do ustawiania właściwości

Teraz zastosujmy ten sam wzór z Postklasą:

public class Post
{
    public string Title { get; set; }
    public DateTime DateCreated { get; set; }
    public string Body { get; set; }

    public Post SetTitle(string title)
    {
        Title = title;

        return this;
    }

    public Post SetDateCreated(DateTime created)
    {
        DateCreated = created;

        return this;
    }

    public Post SetBody(string body)
    {
        Body = body;

        return this;
    }
}

Spójrzmy teraz, jak używałbyś tej klasy:

Post post = new Post()
    .SetTitle("Test")
    .SetDateCreated(DateTime.Now)
    .SetBody("Just a test");

Kiedy widzę ten kod, natychmiast zadaję to pytanie: „Czy po wywołaniu SetBodywysyła zapytanie do bazy danych? Czy muszę wywoływać inną metodę, aby powiedzieć„ gotowe ”?

Co łańcuchowe wywołania metod komunikują się z kodem za pomocą Postklasy?

1. Mam skomplikowaną konfigurację
2. Każde wywołanie metody opiera się na poprzednim

Czy to rzeczywiście prawda? Nie. PostKlasa nie ma skomplikowanej konfiguracji. Ustawienie tytułu, daty utworzenia i treści nie opiera się na sobie w celu osiągnięcia bardziej skomplikowanego celu końcowego. Wcieliłeś kwadratowy kołek w okrągły otwór.

Wadą samodzielnego łączenia metod jest to, że komunikujesz, że do wykonania czegoś potrzeba wielu wywołań metod i że każde wywołanie opiera się na ostatnim. Jeśli nie jest to prawdą, wówczas łączenie metod może przekazywać niewłaściwe informacje innym programistom.

Kiedy twoi współpracownicy powiedzieli:

Płynne interfejsy nie powinny być implementowane tylko dla wygody, ale dla semantyki

Miały absolutną rację. Płynny interfejs lub łączenie metod komunikuje coś samo w sobie, co może nie być prawdą.

Główną wadą jest utrata przejrzystości. Na przykład:

x.foo();
x.bar();
x.baz();

Ponieważ żadna z tych instrukcji nie zwraca wartości (a jeśli tak, to jest ignorowana), mogą być użyteczne tylko wtedy, gdy wywołują skutki uboczne. Porównaj to z:

x.foo()
 .bar()
 .baz();

Po pierwsze, nie jest jasne bari bazdziała na obiektach tego samego typu co x, chyba że wiadomo, że xklasa jest jedyną klasą z tymi metodami. Nawet jeśli tak jest, nie jest jasne, czy metody działają na xnowych obiektach.

Podświetlanie części kodu, które mają skutki uboczne, jest przydatne, ponieważ trzeba śledzić te skutki uboczne, aby uzasadnić program. Musisz porównać potencjalną utratę przejrzystości z potencjalnym zyskiem na łatwości pisania kodu, ale pamiętaj również, że kod jest czytany więcej niż jest napisany.

Rozważ wszystkie elementy stylistyczne języków programowania (w przeciwieństwie do języka maszynowego kodowania ręcznego) i osłabia to argument „semantyka, a nie wygoda”.

Wiele z tego, co robimy jako inżynierowie, zapewnia wygodę w zakresie semantyki.