Czy powinienem używać różnych typów zwrotu na przeciążonych metodach?

Question

Czy są jakieś sprawdzone metody zwracania różnych typów zwracania na przeciążonych metodach? Na przykład, jeśli mam metodę ładowania w moim DAL, chcę załadować pojedynczy element lub kilka elementów. Wiem, że mogę korzystać z wielu metod:

Załaduj jeden obiekt

MyBusinessObject LoadOne(int id) 
{ 
} 

Ładowanie wielu obiektów

MyBusinessObject[] LoadMany(params int[] ids) 
{ 
} 

Teraz coś wiem może zrobić, to przeciążenie jednej metody i mają różne typy zwrotu. Tak:

MyBusinessObject Load(int id) 
{ 
} 

I

MyBusinessObject[] Load(params int[] ids) 
{ 
} 

Choć wydaje się, nie ma nic, aby zatrzymać mnie w ten sposób, a to sprawia, że ​​coś schludne z perspektywy API, czy to wydawać się dobrym pomysłem? Natknąłem się na niego wczoraj wieczorem i część mnie myśli, że nie powinienem tego robić z powodu konieczności dopasowywania typów powrotu dla przeciążonej metody.

Mogę również mieć metodę Load (int id) zwracającą kolekcję, która zawiera tylko jeden przedmiot. Wydaje mi się, że narusza to zasadę najmniejszego zaskoczenia, ponieważ jeśli spodziewasz się zwrotu jednego elementu, powinieneś zwrócić ten przedmiot, nie powinieneś zwracać listy zawierającej pojedynczy przedmiot.

Więc tutaj są moje myśli na otaczające te pomysły:

• Przeciążone metody powinno wszystko wrócić tego samego typu.
• Jeśli metody robią to samo, nie nadawaj im kilku różnych nazw, przeciąż tę samą nazwę metody. Ułatwia to pracę z perspektywy użytkownika API, nie musi przeszukiwać wielu różnych metod, które zasadniczo robią to samo, ale z różnymi parametrami.
• Zwróć najbardziej oczywisty typ metody, tj. Jeśli użytkownik prawdopodobnie oczekuje kolekcji przedmiotów, zwróć kolekcję przedmiotów, jeśli najprawdopodobniej spodziewają się jednego przedmiotu, zwróć pojedynczy przedmiot.

Dwie ostatnie myśli przeważają nad pierwszą, ale jednocześnie pierwsza myśl wydaje się być programową najlepszą praktyką.

Czy istnieją najlepsze praktyki dotyczące tej praktyki? Byłbym zainteresowany wysłuchaniem myśli innych na ten temat.

Answer 1

I może być skłonny do API wyraźne i używać wielu w nazwach:

Customer LoadCustomer(int id) {...} 
Customer[] LoadCustomers(params int[] id) {...} 

Właściwie params jest rzadko przydatna tutaj - nie wiem, identyfikatory zwykle w czasie kompilacji.

Answer 2

Mój osobisty pomysł jest taki, że ta ostatnia metoda wydaje się bardziej zrozumiała z punktu widzenia API-użytkownika.

Answer 3

Wystarczy spojrzeć na istniejące interfejsy API. Weźmy na przykład LINQ, ma metodę "Select", która zwraca wiele encji, a także metodę "Single", która zwraca tylko jedną encję. Większość istniejących interfejsów API ma dwie różne metody, a nie przeładowane i uważam, że jest to logiczne i bardziej czytelne.

Answer 4

Mam tendencję do podążania za pierwszym punktem na liście "myślami stanowiącymi ten pomysł", który mówi "przeciążenia powinny powrócić tego samego typu".

ale można wtedy przeciążać "LoadMany" kilkoma różnymi scenariuszami;

public Customer Load(int id) 
{ 
    // return just one customer 
} 

public List<Customer> LoadMany() 
{ 
    // return every single customer 
} 

public List<Customer> LoadMany(int statusFilter) 
{ 
    // return a filtered list of customers 
} 

public List<Customer> LoadMany(DateTime InitialContactFrom) 
{ 
    // return a filtered list of customers 
} 

public List<Customer> LoadMany(DateTime InitialContactFrom, DateTime InitialContactBefore) 
{ 
    // return a filtered list of customers 
} 

... dowolne potrzebne kombinacje można oczywiście dodać, ale na końcu LoadMany zwraca listę, a Load zwraca jeden obiekt.

Answer 5

Są prawdopodobnie wyjątki, ale jeśli nie masz naprawdę dobrego powodu, aby zwracać różne typy, funkcja i jej przeciążenia powinny zwracać ten sam typ, aby nie doprowadzać innych deweloperów do szaleństwa.

Na przykład:

var a = MyFunc("Some text"); 

i

var a = MyFunc(1); 

zarówno wyglądają jak powinny one rozwiązać var ​​do tego samego typu do mnie. Zanim zrezygnowałem z tego, że wszystkie przeciążenia zwracają ten sam typ, upewniłem się, że mam bardzo solidny powód do zwrócenia różnych typów.