Precondiciones y Microsoft Code Contracts v1.0

¿Alquien dice que de un departamento de I+D no sale nunca nada provechoso?. Microsoft tiene su departamento de investigación y desarrollo, conocido como Microsoft Research, y en él, se han creado algunas «criaturas» dignas de mención.

Una de ellas es Microsoft Code Contracts, pero… ¿alguién sabe lo que es o para qué sirve realmente Microsoft Code Contracts?.

En la sección de referencias, os pongo unos enlaces que explican mejor que lo que yo pueda hacer, qué es y para qué sirve Code Contract. De todos los modos… lo intentaré…

Como introducción enmarañada diré que Code Contracts nos permite expresar en modo lenguaje, partes o precondiciones de código que queremos asumir de un modo determinado.

Por decirlo de una forma más clara. Nos permite acercar todas las ventajas de la metodología de diseño por contrato a los lenguajes de .NET y que es utilizada en el lenguaje de programación Eiffel.

No obstante, el diseño por contrato tiene como fondo el sacar mayor provecho y rendimiento a los lenguajes orientados a objetos y a los propios programas desarrollados con .NET.

Algunos pueden ver en Microsoft Code Contracts, ese aliado perfecto a caballo entre la programación y los Unit Test.

Sobre los planes de Microsoft con Code Contracts, Microsoft incluirá Microsoft Code Contracts en el BCL de .NET Framework 4.0, pero por el momento… ¿qué hacer si queremos utilizarlo en Visual Studio 2008?.

Dentro de .NET Framework 3.5, podemos instalar, incluir y utilizar Microsoft Code Contracts sin complicaciones.

Con Microsoft Code Contracts podemos realizar diferentes tareas. A continuación, mostraré alguna de ellas…

Para muestra, como dice el dicho, un botón.

Instalación

Lo primero que he hecho es instalar Microsoft Code Contracts.

Encontrareis dos versiones, una estándar y otra para VSTS, dependiendo de la versión de Visual Studio 2008 que tengáis instalada.

La instalación se hace en unos minutos y la descarga no llega a 5 Mb.

En su instalación, se integran dentro de Visual Studio 2008 algunas características para asumir y trabajar con Code Contracts.

Programación

He iniciado un nuevo proyecto de tipo Aplicación Windows y he insertado en el formulario un control Button.

Lo primero que he hecho es agregar una nueva referencia al proyecto. La referencia añadida es a Microsoft.Contracts.Library.

A continuación, agregaremos el namespace al código:

 using System.Diagnostics.Contracts;

 Una vez hecho esto, pasaremos a preparar el código de nuestra aplicación.

Lo primero que haremos será preparar una clase de prueba de nombre Access.

El código de esta clase es:

public

class Access

{

    public int Age { get; set; }

 

   public Access(int age)

   {

       Contract.Requires(18 <= age);

       this.Age = age;

   }

 

   public bool HasAccess()

   {

       return true;

   }

}

Como podemos ver, dentro del constructor de la clase hemos utilizado Contract.Requires(condición). Nuestra clase tiene como misión aceptar aquellas personas que tienen una edad igual o superior de 18 años. Es una clase muy simple, pero que puede reflejar el uso teórico/práctico de Code Contracts.

De esta forma, podemos establecer una condición en nuestra clases de acuerdo a Code Contracts.

Antes de continuar, no olvidemos acceder a las propiedades del proyecto y habilitar en la solapa Code Contracts, solapa nueva agregada en Visual Studio 2008, la opción Runtime Checking > Perform Runtime Contract Checking (Full).

El siguiente paso será instanciar nuestra clase y ejecutarla.

Haremos doble clic sobre el control Button y escribiremos el siguiente código asociado al evento:

 private void button1_Click(object sender, EventArgs e)

{

  

try

   {

      Access access = new Access(-18);

      bool flag = access.HasAccess();

      MessageBox.Show(flag.ToString());

   }

   catch (ContractException contractException)

   {

      MessageBox.Show(contractException.Message.ToString() +            

                  Environment.NewLine +            

                  «La condición: (« + contractException.Condition.ToString() + «) generó un error.»);

    }

}

Al ejecutar esta porción de código, Code Contracts nos devuelve una excepción de tipo ContractException.

Aún y así, la precondición de Code Contract, la podemos utilizar donde queramos. No es necesario usarla en el constructor de la clase.

Así, podemos escribir la siguiente variante de nuestra clase Access.

public class Access

{

   public int Age { get; set; }

 

   public Access(int age)

   {

      this.Age = age;

   }

 

   public bool HasAccess()

   {

       Contract.Requires(18 <= this.Age);

      return true;

   }

}

En este segundo caso, no se cumple la condición marcada y devuelve una excepción.

Existen más características relacionadas con Code Contracts, pero sirva esta entrada como aperitivo del uso de este nombre de espacio y ensamblado, que estará disponible dentro del BCL de .NET Framework 4.0.

Referencias

Enlace Web: Diseño por contrato (Wikipedia).

Enlace Web: Información en español sobre Microsoft Code Contracts (traducción en español del blog de Somasegar).

Enlace Web: Información de Microsoft Research sobre Microsoft Code Contracts.

Enlace Web: Página web de descargas de Microsoft Code Contracts.