Welche Ausnahme von einem Property Setter zu werfen?

Question

Ich habe eine String-Eigenschaft, die eine maximale Länge erfordert, da die Daten mit einer Datenbank verknüpft sind. Welche Ausnahme sollte ich auslösen, wenn der Anrufer versucht, eine Zeichenfolge zu setzen, die diese Länge überschreitet?

Zum Beispiel dieses C# -Code:

public string MyProperty 
{ 
    get 
    { 
     return _MyBackingField; 
    } 
    set 
    { 
     if (value.Length > 100) 
      throw new FooException("MyProperty has a maximum length of 100."); 

     _MyBackingField = value; 
    } 
} 

ich als ArgumentException, aber es scheint einfach nicht richtig. Technisch ist es eine Funktion - MyProperty_set(string value) - so kann ein Fall für ArgumentException gemacht werden, aber es wird nicht als eine Funktion für die Augen des Verbrauchers aufgerufen - es ist auf der rechten Seite eines Zuweisungsoperators.

Diese Frage könnte wahrscheinlich auch auf alle Arten von Datenvalidierung ausgedehnt werden, die in Property Settern gemacht werden, aber ich bin besonders an dem obigen Fall interessiert.

Answer 1

Werfen Sie einen Blick durch mscorlib.dll mit Reflektor, in einer ähnlichen Situation wie System.String.StringBuilder.Capacity Microsoft verwenden ArgumentOutOfRangeException() ähnlich:

public int PropertyA 
{ 
    get 
    { 
     return //etc... 
    } 
    set 
    { 
     if (condition == true) 
     { 
      throw new ArgumentOutOfRangeException("value", "/* etc... */"); 
     } 
     // ... etc 
    } 
} 

Answer 2

Sie können InvalidOperationException verwenden. Das ist ein Kompromiss. Ich würde auch keine ArgumentException verwenden.

Answer 3

Für mich Argument (oder ein Kind) macht mehr Sinn, weil das von Ihnen angegebene Argument (value) nicht gültig ist, und dafür wurde ArgumentException erstellt.

Answer 4

Ich würde keine Ausnahme überhaupt werfen. Stattdessen würde ich eine Zeichenfolge beliebiger Länge zulassen und dann eine separate "Validate" -Methode für die Klasse verwenden, die vor dem Speichern aufgerufen wird. Es gibt eine Reihe von Szenarien, insbesondere wenn Sie Datenbindungen verwenden, bei denen das Auslösen von Ausnahmen von Eigenschaften-Setter Sie in Unordnung bringen kann.

Das Problem mit dem Auslösen von Ausnahmen von Property Settern ist, dass Programmierer vergessen, sie zu fangen. Es hängt davon ab, wie sauber Sie die Daten erwarten, die Sie erhalten. In diesem Fall würde ich erwarten, dass lange String-Längen üblich und nicht außergewöhnlich sind, und als solche eine Ausnahme verwenden würde, wäre "Flusssteuerung mit Ausnahmen".

Um von der Design Guidelines for Developing Class Libraries Microsoft zu zitieren:

Keine Ausnahmen für den normalen Fluss Kontrolle verwenden, wenn möglich. Außer für Systemausfälle und Operationen mit potenziellen Race-Bedingungen, sollten Framework-Designer APIs so entwerfen, dass Benutzer Code schreiben können, der nicht Ausnahmen wirft. Sie können beispielsweise eine Möglichkeit bereitstellen, die Vorbedingungen vor dem Aufrufen eines Mitglieds zu überprüfen, damit Benutzer Code schreiben können, der keine Ausnahmen auslöst.

Answer 5

Denken Sie daran, wie viele Probleme in der Informatik gelöst werden, indem Sie ein zusätzliches Maß an Indirektion hinzufügen?

Ein Ansatz wäre, einen neuen Typ zu erstellen, FixedLengthString, sagen wir. Es wären Instanzen von , die Typ, die Längen von Zeichenfolgen validieren, die sie initialisiert werden - mit einem Konvertierungsoperator, Typ Konvertierung von einer einfachen Zeichenfolge zu tun.Wenn Ihr Eigenschaften-Setter einen solchen Typ wie sein Argument annimmt, wird jeder Verstoß zu einer Typkonvertierungsausnahme anstelle einer Argument-/Eigenschaftenausnahme.

In der Praxis würde ich das selten tun. Es riecht etwas nach OO zu weit - aber in einigen Fällen kann es eine nützliche Technik sein, daher erwähne ich es hier aus Gründen der Vollständigkeit.

Answer 6

Versuchen Sie, vorhandene Ausnahmen wo immer möglich zu verwenden. In diesem Fall verwenden Sie InvalidOperationException, weil der eingehende Wert das Objekt in einen inkonsistenten Zustand bringt. Benutzerdefinierte Ausnahmen können erstellt werden, wenn eine bestimmte Behandlung mit der benutzerdefinierten Ausnahme erforderlich ist. In diesem Fall wird nur eine Ausnahme mit Text ausgelöst. Verwenden Sie daher die InvalidOperationException.

Wenn die InvalidOperationException ausgelöst wird, wird der Wert angezeigt, der an diesen Setter übergeben wurde.

Answer 7

public IPAddress Address 
{ 
    get 
    { 
     return address; 
    } 
    set 
    { 
     if(value == null) 
     { 
      throw new ArgumentNullException("value"); 
     } 
     address = value; 
    } 
} 

über MSDN