Reicht es aus, wenn Methoden nur nach dem Argumentnamen (nicht nach dem Typ) unterschieden werden?

Reicht es aus, Methoden nur nach dem Argumentnamen (nicht nach dem Typ) zu unterscheiden, oder ist es besser, ihn expliziter zu benennen?

Zum Beispiel T Find<T>(int id)vs T FindById<T>(int id).

Gibt es einen guten Grund, es expliziter zu benennen (dh hinzuzufügen ById), anstatt nur den Argumentnamen beizubehalten?

Ein Grund, an den ich denken kann, ist, dass die Signaturen der Methoden gleich sind, aber eine andere Bedeutung haben.

FindByFirstName(string name) und FindByLastName(string name)

Sicher gibt es einen guten Grund, es expliziter zu nennen.

Es ist nicht in erster Linie die Methode Definition , die selbsterklärend sein sollte, aber die Methode verwenden . Und während findById(string id)und find(string id)beide selbsterklärend sind, gibt es einen großen Unterschied zwischen findById("BOB")und find("BOB"). Im ersteren Fall wissen Sie, dass das zufällige Literal tatsächlich eine ID ist. Im letzteren Fall sind Sie sich nicht sicher - es könnte sich tatsächlich um einen Vornamen oder etwas ganz anderes handeln.

Vorteile von FindById () .

1. Zukunftssicherheit : Wenn Sie mit beginnen Find(int), und später anderen Methoden hinzufügen müssen ( FindByName(string), FindByLegacyId(int), FindByCustomerId(int), FindByOrderId(int)usw.), Leute wie ich sind in der Regel im Alter zu verbringen suchen FindById(int). Nicht wirklich ein Problem , wenn Sie können und wird sich ändern Find(int)zu , FindById(int)sobald es notwendig wird - Zukunftssicherheit ist über diese , wenn s.

2. Einfacher zu lesen . Findist vollkommen in Ordnung, wenn der Anruf so aussieht. Ist jedoch etwas einfacher zu lesen, wenn dies der record = Find(customerId);Fall FindByIdist record = FindById(AFunction());.

3. Konsistenz . Sie können das Muster FindByX(int)/ FindByY(int)überall konsistent anwenden , Find(int X)/ Find(int Y)ist jedoch nicht möglich, da Konflikte auftreten.

Vorteile von Find ()

• KUSS. Findist einfach und unkompliziert und nebenbei operator[]einer der 2 am meisten erwarteten Funktionsnamen in diesem Zusammenhang. (Einige beliebte Alternativen sind get, lookupoder fetch, je nach Kontext).
• Als Faustregel gilt: Wenn Sie einen Funktionsnamen haben, der ein bekanntes Wort ist, das genau beschreibt, was die Funktion tut, verwenden Sie ihn. Auch wenn es einen längeren Namen mit mehreren Wörtern gibt, der die Funktionsweise der Funktion etwas besser beschreibt. Beispiel: Länge vs NumberOfElements . Es gibt einen Kompromiss, und die Frage, wo die Grenze gezogen werden soll, ist Gegenstand einer laufenden Debatte.
• Es ist im Allgemeinen gut, Redundanzen zu vermeiden. Wenn wir uns das ansehen FindById(int id), können wir Redundanzen leicht entfernen, indem wir sie auf ändern Find(int id), aber es gibt einen Kompromiss - wir verlieren etwas Klarheit.

Alternativ können Sie die Vorteile von beiden nutzen, indem Sie stark typisierte IDs verwenden:

CustomerRecord Find(Id<Customer> id) 
// Or, depending on local coding standards
CustomerRecord Find(CustomerId id) 

Implementierung von Id<>: Starke Eingabe von ID-Werten in C #

Die Kommentare hier und im obigen Link haben zu mehreren Bedenken geführt, auf Id<Customer>die ich eingehen möchte:

• Bedenken 1: Es ist ein Missbrauch von Generika. CustomerIdund OrderIDsind verschiedene Typen ( customerId1 = customerId2;=> gut, customerId1 = orderId1;=> schlecht), aber ihre Implementierung ist nahezu identisch, sodass wir sie entweder mit Copy Paste oder mit Metaprogramm implementieren können. Während in einer Diskussion Wert darauf gelegt wird, das Generikum entweder freizulegen oder zu verbergen, ist Metaprogrammierung das, wofür Generika gedacht sind.
• Bedenken 2: Es hört nicht mit einfachen Fehlern auf./Es ist eine Lösung auf der Suche nach einem Problem. Das Hauptproblem, das durch die Verwendung stark typisierter IDs behoben wird, ist die falsche Argumentreihenfolge in einem Aufruf an DoSomething(int customerId, int orderId, int productId). Stark eingegebene IDs verhindern auch andere Probleme, einschließlich desjenigen, nach dem OP gefragt wurde.
• Bedenken 3: Es verdeckt wirklich nur den Code. Es ist schwer zu sagen, ob ein Ausweis festgehalten wird int aVariable. Es ist leicht zu erkennen, dass eine ID gespeichert ist Id<Customer> aVariable, und wir können sogar feststellen, dass es sich um eine Kunden-ID handelt.
• Bedenken 4: Diese IDs sind keine starken Typen, nur Wrapper. Stringist nur ein Wrapper herum byte[]. Das Umschließen oder Einkapseln steht nicht im Widerspruch zu starker Typisierung.
• Bedenken 5: Es ist ausgereift. Hier ist die Minimalversion, obwohl ich das Hinzufügen empfehle operator==und operator!=auch, wenn Sie sich nicht ausschließlich auf Folgendes verlassen möchten Equals:

.

public struct Id<T>: {
    private readonly int _value ;
    public Id(int value) { _value = value; }
    public static explicit operator int(Id<T> id) { return id._value; }
}

Eine andere Art, darüber nachzudenken, besteht darin, die Typensicherheit der Sprache zu verwenden.

Sie können eine Methode wie die folgenden implementieren:

Find(FirstName name);

Wobei FirstName ein einfaches Objekt ist, das eine Zeichenfolge umschließt, die den Vornamen enthält und bedeutet, dass es keine Verwirrung darüber geben kann, was die Methode tut und mit welchen Argumenten sie aufgerufen wird.

Ich werde für eine explizite Erklärung wie FindByID stimmen. Software sollte für den Wandel gebaut werden. Es sollte offen und geschlossen sein (SOLID). Die Klasse ist also offen, ähnliche Suchmethoden wie FindByName usw. hinzuzufügen.

FindByID ist jedoch geschlossen und seine Implementierung ist Unit-getestet.

Ich werde keine Methoden mit Prädikaten vorschlagen, die sind gut im Allgemeinen. Was ist, wenn Sie basierend auf dem Feld (ByID) unterschiedliche Methoden anwenden.

Ich bin überrascht, dass niemand vorgeschlagen hat, ein Prädikat wie das folgende zu verwenden:

User Find(Predicate<User> predicate)

Mit diesem Ansatz reduzieren Sie nicht nur die Oberfläche Ihrer API, sondern geben dem Benutzer, der sie verwendet, auch mehr Kontrolle.

Wenn das nicht ausreicht, können Sie es jederzeit nach Ihren Wünschen erweitern.