¿Cómo puedo demostrar que un método nunca devolverá nulo (diseño por contrato) en C#

Question

Tengo un método que nunca devuelve un objeto nulo. Quiero que quede claro para que los usuarios de mi API no tienen que escribir código como este:

if(Getxyz() != null) 
{ 
    // do stuff 
} 

¿Cómo puedo mostrar esta intención?

Answer 1

Unforutnately no hay manera integrada en C#

Se puede documentar este hecho, pero esto no se comprobará automáticamente.

Si está utilizando el reafilamiento, se puede configurar para comprobarlo correctamente cuando el método está marcado con un atributo [NotNull].

De lo contrario, puede utilizar la biblioteca Microsoft Contracts y agregar algo similar a lo siguiente a su método, pero esto es bastante verborrea adicional para una anotación tan simple.

Contract.Ensures(Contract.Result<string>() != null) 

SpeC# resolvió este problema al permitir a! después del tipo para marcarlo como un tipo no nulo, por ejemplo

string! foo 

pero SpeC# sólo puede ser utilizado para orientar .NET2, y ha sido usurpada por el Código contratos biblioteca.

Answer 2

A menos que esté utilizando un tipo basado en System.ValueType, creo que no tiene suerte. Probablemente sea mejor documentar esto claramente en el comentario de XML/metadatos para la función.

Answer 3

Si sus usuarios tienen su código fuente usando un diseño estándar por contrato API como: http://www.codeproject.com/KB/cs/designbycontract.aspx puede aclarar las cosas.

De lo contrario, su mejor apuesta es a través de la documentación.

Answer 4

O bien documentarlo bien (tal vez con el sistema de documentación estándar .NET) o tiene que usar alguna API de contrato. Éstos son algunos: http://geekswithblogs.net/Podwysocki/archive/2008/01/22/118770.aspx http://www.codeproject.com/KB/cs/designbycontract.aspx

Answer 5

Puede incluir un método Debug.Assert(). Si bien esto ciertamente no hará cumplir la condición, debería dejar en claro (junto con la documentación) que un valor nulo no es aceptable.

Answer 6

No sé si hay una práctica recomendada para hacerlo desde una API, ya que seguiría programando a la defensiva y verificando si es nulo como consumidor. Creo que esta sigue siendo la mejor práctica en este caso, ya que tiendo a no querer confiar en que otro código siempre haga lo correcto.

Answer 7

Documéntelo y proporcione el código fuente.

Answer 8

Me gusta pensar que es al revés: si mi función puede devolver un valor nulo, es mejor asegurarse de que el usuario de la función lo sepa.

Answer 9

La única forma revisada de comprobar que un objeto C# nunca devuelve nulo es utilizar una estructura. Las estructuras pueden tener miembros que contengan valores nulos, pero nunca pueden ser nulos.

Todos los demás objetos C# pueden ser nulos.

código Ejemplo:

public struct StructExample 
{ 
    public string Val; 
} 

public class MyClass 
{ 
    private StructExamle example; 

    public MyClass() 
    { 
     example = null; // will give you a 'Cannot convert to null error 
    } 

    public StructExample GetXyz() 
    { 
     return null; // also gives the same error 
    } 
} 

El ejemplo anterior no se compilará. Si el uso de una estructura es aceptable (se convierte en un tipo de valor, se pasa en la pila, no se puede subclasificar), entonces esto podría funcionar para usted.