Wie kann ich mit einem Booleschen Clearer telefonieren? Boolesche Falle

Wie in den Kommentaren von @ benjamin-gruenbaum angemerkt, wird dies die Boolesche Falle genannt:

Angenommen, ich habe eine Funktion wie diese

UpdateRow(var item, bool externalCall);

und in meinem Controller wird dieser Wert für externalCallimmer WAHR sein. Wie kann man diese Funktion am besten aufrufen? Normalerweise schreibe ich

UpdateRow(item, true);

Aber ich frage mich, ob ich einen Booleschen deklarieren soll, nur um anzugeben, wofür dieser "wahre" Wert steht. Sie können das an der Deklaration der Funktion erkennen, aber es ist offensichtlich schneller und klarer, wenn Sie so etwas gesehen haben

bool externalCall = true;
UpdateRow(item, externalCall);

PD: Ich bin mir nicht sicher, ob diese Frage wirklich hier passt. Wenn nicht, wo kann ich weitere Informationen dazu erhalten?

PD2: Ich habe keine Sprache markiert, weil ich dachte, es sei ein sehr allgemeines Problem. Wie auch immer, ich arbeite mit c # und die akzeptierte Antwort funktioniert für c #

Es gibt nicht immer eine perfekte Lösung, aber Sie haben viele Alternativen zur Auswahl:

• Verwenden Sie benannte Argumente , sofern diese in Ihrer Sprache verfügbar sind. Dies funktioniert sehr gut und hat keine besonderen Nachteile. In einigen Sprachen kann jedes Argument als benanntes Argument übergeben werden, z. B. updateRow(item, externalCall: true)( C # ) oder update_row(item, external_call=True)(Python).

  Ihr Vorschlag, eine separate Variable zu verwenden, ist eine Möglichkeit, benannte Argumente zu simulieren, hat jedoch nicht die damit verbundenen Sicherheitsvorteile (es gibt keine Garantie dafür, dass Sie den richtigen Variablennamen für dieses Argument verwendet haben).

• Verwenden Sie unterschiedliche Funktionen für Ihre öffentliche Schnittstelle mit besseren Namen. Dies ist eine weitere Möglichkeit, benannte Parameter zu simulieren, indem die Parameterwerte in den Namen eingefügt werden.

  Dies ist sehr gut lesbar, führt aber zu einer Menge Boilerplate für Sie, die diese Funktionen schreiben. Es kann auch nicht gut mit kombinatorischer Explosion umgehen, wenn es mehrere boolesche Argumente gibt. Ein wesentlicher Nachteil ist, dass Clients diesen Wert nicht dynamisch festlegen können, sondern if / else verwenden müssen, um die richtige Funktion aufzurufen.

• Verwenden Sie eine Aufzählung . Das Problem mit Booleschen Werten ist, dass sie als "wahr" und "falsch" bezeichnet werden. Führen Sie stattdessen einen Typ mit besseren Namen ein (z enum CallType { INTERNAL, EXTERNAL }. B. ). Als zusätzlicher Vorteil, erhöht dies die Art Sicherheit Ihres Programms (wenn Ihre Sprache Aufzählungen als verschiedene Typen implementiert). Der Nachteil von Enums ist, dass sie Ihrer öffentlich sichtbaren API einen Typ hinzufügen. Für rein interne Funktionen spielt dies keine Rolle und Aufzählungen haben keine wesentlichen Nachteile.

  In Sprachen ohne Aufzählungen werden stattdessen manchmal kurze Zeichenfolgen verwendet. Dies funktioniert und ist möglicherweise sogar besser als rohe Boolesche Werte, ist jedoch sehr anfällig für Tippfehler. Die Funktion sollte dann sofort bestätigen, dass das Argument mit einer Reihe möglicher Werte übereinstimmt.

Keine dieser Lösungen wirkt sich negativ auf die Leistung aus. Benannte Parameter und Aufzählungen können zur Kompilierungszeit (für eine kompilierte Sprache) vollständig aufgelöst werden. Die Verwendung von Zeichenfolgen kann einen Zeichenfolgenvergleich erfordern, die Kosten hierfür sind jedoch für kleine Zeichenfolgenliterale und die meisten Arten von Anwendungen vernachlässigbar.

Die richtige Lösung ist, das zu tun, was Sie vorschlagen, aber es in eine Mini-Fassade zu packen:

void updateRowExternally() {
  bool externalCall = true;
  UpdateRow(item, externalCall);
}

Lesbarkeit trumpft mit Mikrooptimierung. Sie können sich den zusätzlichen Funktionsaufruf leisten, sicherlich besser als Sie es sich leisten können, die Semantik des Booleschen Flags einmal nachschlagen zu müssen.

Angenommen, ich habe eine Funktion wie UpdateRow (var item, bool externalCall);

Warum hast du so eine Funktion?

Unter welchen Umständen würden Sie das Argument externalCall auf unterschiedliche Werte setzen?

Wenn eine von beispielsweise einer externen Client-Anwendung stammt und die andere sich im selben Programm befindet (dh in verschiedenen Codemodulen), würde ich argumentieren, dass Sie zwei verschiedene Methoden haben sollten, eine für jeden Fall, möglicherweise sogar für verschiedene Schnittstellen.

Wenn Sie den Aufruf jedoch auf der Grundlage eines Datums aus einer Nicht-Programmquelle (z. B. einer Konfigurationsdatei oder einem Datenbanklesevorgang) ausführen würden, wäre die Methode der Booleschen Übergabe sinnvoller.

Ich bin damit einverstanden, dass es ideal ist , eine Sprachfunktion zu verwenden, um sowohl Lesbarkeit als auch Wertsicherheit zu gewährleisten. Sie können sich jedoch auch für einen praktischen Ansatz entscheiden: Kommentare zur Anrufzeit. Mögen:

UpdateRow(item, true /* row is an external call */);

oder:

UpdateRow(item, true); // true means call is external

oder (zu Recht, wie von Frax vorgeschlagen):

UpdateRow(item, /* externalCall */true);

1. Sie können Ihre Narren "benennen". Nachfolgend finden Sie ein Beispiel für eine OO-Sprache (wo sie in der Klassenbereitstellung ausgedrückt werden kann UpdateRow()). Das Konzept selbst kann jedoch in einer beliebigen Sprache angewendet werden:

   class Table
   {
   public:
       static const bool WithExternalCall = true;
       static const bool WithoutExternalCall = false;
   

   und auf der Anrufseite:

   UpdateRow(item, Table::WithExternalCall);
   

2. Ich glaube, Punkt 1 ist besser, erzwingt aber nicht, dass der Benutzer neue Variablen verwendet, wenn er die Funktion verwendet. Wenn die Typensicherheit für Sie wichtig ist, können Sie einen enumTyp erstellen und UpdateRow()diesen anstelle eines bool:

   UpdateRow(var item, ExternalCallAvailability ec);

3. Sie können den Namen der Funktion so ändern, dass er die Bedeutung des boolParameters besser widerspiegelt . Nicht sehr sicher, aber vielleicht:

   UpdateRowWithExternalCall(var item, bool externalCall)

Eine andere Option, die ich hier noch nicht gelesen habe, ist: Verwenden Sie eine moderne IDE.

Beispielsweise gibt IntelliJ IDEA den Variablennamen der Variablen in der aufgerufenen Methode aus, wenn Sie ein Literal wie trueoder nulloder übergeben username + “@company.com. Dies geschieht in einer kleinen Schrift, damit sie nicht zu viel Platz auf Ihrem Bildschirm einnimmt und sich stark vom tatsächlichen Code unterscheidet.

Ich sage immer noch nicht, dass es eine gute Idee ist, überall Booleaner einzusetzen. Das Argument, dass Sie Code weitaus häufiger lesen als schreiben, ist oft sehr stark. In diesem speziellen Fall hängt es jedoch stark von der Technologie ab, mit der Sie (und Ihre Kollegen!) Ihre Arbeit unterstützen. Mit einer IDE ist das weitaus weniger ein Problem als zum Beispiel mit vim.

Geändertes Beispiel eines Teils meines Testaufbaus:

2 Tage und niemand erwähnte Polymorphismus?

target.UpdateRow(item);

Wenn ich ein Kunde bin, der eine Zeile mit einem Element aktualisieren möchte, möchte ich nicht über den Namen der Datenbank, die URL des Mikrodienstes, das zur Kommunikation verwendete Protokoll oder darüber nachdenken, ob es sich um einen externen Anruf handelt oder nicht müssen verwendet werden, um es zu verwirklichen. Hör auf, mir diese Details aufzuzwingen. Nimm einfach meinen Gegenstand und aktualisiere irgendwo schon eine Zeile.

Wenn Sie das tun, wird es Teil des Konstruktionsproblems. Das kann auf viele Arten gelöst werden. Hier ist eins:

Target xyzTargetFactory(TargetBuilder targetBuilder) {
    return targetBuilder
        .connectionString("some connection string")
        .table("table_name")
        .external()
        .build()
    ; 
}

Wenn Sie sich das ansehen und denken "Aber meine Sprache hat Argumente benannt, ich brauche das nicht". Gut, großartig, benutze sie. Halten Sie diesen Unsinn einfach von dem anrufenden Client fern, der nicht einmal wissen sollte, womit er spricht.

Es ist anzumerken, dass dies mehr als ein semantisches Problem ist. Es ist auch ein Designproblem. Übergeben Sie einen Booleschen Wert, und Sie sind gezwungen, mit der Verzweigung umzugehen. Nicht sehr objektorientiert. Müssen zwei oder mehr Booleaner übergeben werden? Möchten Sie, dass Ihre Sprache mehrfach versendet wird? Prüfen Sie, was Sammlungen tun können, wenn Sie sie verschachteln. Die richtige Datenstruktur kann Ihr Leben so viel einfacher machen.

Wenn Sie die updateRowFunktion ändern können, können Sie sie möglicherweise in zwei Funktionen umgestalten. Angesichts der Tatsache, dass die Funktion einen booleschen Parameter hat, vermute ich, dass dies so aussieht:

function updateRow(var item, bool externalCall) {
  Database.update(item);

  if (externalCall) {
    Service.call();
  }
}

Das kann ein bisschen nach Code riechen. Die Funktion kann je nach externalCallEinstellung der Variablen ein dramatisch unterschiedliches Verhalten aufweisen. In diesem Fall hat sie zwei unterschiedliche Verantwortlichkeiten. Das Umgestalten in zwei Funktionen, die nur eine Verantwortung haben, kann die Lesbarkeit verbessern:

function updateRowAndService(var item) {
  updateRow(item);
  Service.call();
}

function updateRow(var item) {
  Database.update(item);
}

Überall dort, wo Sie diese Funktionen aufrufen, können Sie jetzt auf einen Blick feststellen, ob der externe Dienst aufgerufen wird.

Dies ist natürlich nicht immer der Fall. Es ist situativ und Geschmackssache. Das Refactoring einer Funktion, die einen booleschen Parameter in zwei Funktionen umwandelt, ist normalerweise erwägenswert, aber nicht immer die beste Wahl.

Wenn sich UpdateRow in einer kontrollierten Codebasis befindet, würde ich ein Strategiemuster in Betracht ziehen:

public delegate void Request(string query);    
public void UpdateRow(Item item, Request request);

Wobei Request eine Art DAO darstellt (ein Rückruf in trivialem Fall).

Wahrer Fall:

UpdateRow(item, query =>  queryDatabase(query) ); // perform remote call

Falscher Fall:

UpdateRow(item, query => readLocalCache(query) ); // skip remote call

Normalerweise wird die Endpunktimplementierung auf einer höheren Abstraktionsebene konfiguriert, und ich würde sie hier nur verwenden. Als nützlichen kostenlosen Nebeneffekt habe ich die Möglichkeit, einen anderen Weg für den Zugriff auf entfernte Daten zu implementieren, ohne den Code zu ändern:

UpdateRow(item, query => {
  var data = readLocalCache(query);
  if (data == null) {
    data = queryDatabase(query);
  }
  return data;
} );

Im Allgemeinen sorgt eine solche Umkehrung der Steuerung für eine geringere Kopplung zwischen Datenspeicher und Modell.