¿Qué excepción lanzar de un organizador de propiedades?

Question

Tengo una propiedad de cadena que tiene un requisito de longitud máxima porque los datos están vinculados a una base de datos. ¿Qué excepción debo lanzar si la persona que llama intenta establecer una cadena que excede esta longitud?

Por ejemplo, este código C#:

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

     _MyBackingField = value; 
    } 
} 

que considera ArgumentException, pero simplemente no me parece bien. Técnicamente, es una función - MyProperty_set(string value) - por lo que se puede crear un caso para ArgumentException, pero no se está llamando como una función a los ojos del consumidor: está en el lado derecho de un operador de asignación.

Esta pregunta probablemente también podría extenderse para incluir todos los tipos de validación de datos realizados en los establecedores de propiedades, pero estoy particularmente interesado en el caso anterior.

Answer 1

echar un vistazo a mscorlib.dll con reflector, en una situación similar, como Microsoft System.String.StringBuilder.Capacity utilizar ArgumentOutOfRangeException() similar a:

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

Answer 2

Puede usar InvalidOperationException. Eso es un compromiso. No me molestaría en usar una ArgumentException tampoco.

Answer 3

Para mí ArgumentException (o un niño) tiene más sentido, porque el argumento (valor) que proporcionó no es válido, y esto es para lo que se creó ArgumentException.

Answer 4

No lanzaría ninguna excepción. Más bien, permitiría una cadena de cualquier longitud y luego tendré un método "Validate" separado en la clase a la que se llama antes de guardar. Hay una serie de escenarios, especialmente si utiliza enlaces de datos donde arrojar excepciones de los responsables de la creación de la propiedad puede desordenarlo.

El problema con arrojar excepciones de los establecedores de propiedades es que los programadores se olvidan de atraparlos. Depende de cuán limpio usted espera que sean los datos que obtiene. En este caso, esperaría que las longitudes de cadena largas sean comunes, no excepcionales y, como tal, el uso de una excepción sería "control de flujo con excepciones".

citar Design Guidelines for Developing Class Libraries del Microsoft:

No utilizar excepciones para el flujo normal de de control, si es posible. Excepto por las fallas del sistema y las operaciones con condiciones de carrera potenciales, los diseñadores de framework deben diseñar API para que los usuarios de puedan escribir código que no incluya excepciones. Por ejemplo, puede proporcionar una forma de comprobar las condiciones previas antes de llamar a un miembro para que los usuarios puedan escribir código que no arroje excepciones .

Answer 5

¿Recuerda cuántos problemas en informática se resuelven agregando un nivel extra de indirección?

Un enfoque sería crear un nuevo tipo, FixedLengthString, por ejemplo. Sería casos del tipo que que validan las longitudes de las cadenas con las que se inicializan, con un operador de conversión para realizar una conversión de tipo desde una cadena simple.Si su creador de propiedades toma un tipo como su argumento, cualquier violación se convertiría en una excepción de conversión de tipo en lugar de una excepción de argumento/propiedad.

En la práctica, rara vez hago esto. Huele un poco a tomar OO demasiado lejos, pero en algunos casos puede ser una técnica útil, así que lo menciono aquí para completar.

Answer 6

Trate de usar las excepciones existentes siempre que sea posible. En este caso, use InvalidOperationException porque el valor entrante está llevando el objeto a un estado incoherente. Se pueden crear excepciones personalizadas cuando se necesita un manejo específico con la excepción personalizada. En este caso, solo lanza una excepción con algo de texto, así que use InvalidOperationException.

Al lanzar InvalidOperationException muestra el valor que se ha pasado a este setter.

Answer 7

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

través MSDN