IoC o el poder de ceder el control

Hablando con colegas de profesión, me he dado cuenta de que muchos de ellos no terminan de comprender el patrón IoC o las ventajas que su uso comporta… Así que sin ánimo de sentar cátedra he decidido escribir este post, por si le sirve a alguien… J

IoC, que corresponde a las siglas de Inversion Of Control, agrupa a varios patrones que tienen en común que el flujo de ejecución del programa se invierte respecto a los métodos de programación tradicionales (wikipedia dixit). Generalmente el programador especifica las acciones (métodos) que se van llamando, pero en IoC lo que se especifican son las respuestas a determinados eventos o sucesos, dejando en manos de un elemento externo todas las acciones de control necesarias cuando lleguen estos sucesos.

Un claro ejemplo de IoC se encuentra en el modelo de eventos de Windows Forms. Cuando vinculamos una función gestora a un evento (p.ej. el Click de un Button), estamos definiendo la respuesta a un determinado evento y nos despreocupamos cuando se llamará a nuestra función gestora. Es decir, cedemos el control del flujo al framework para que sea él que llame cuando sea necesario a nuestro método.

Una de las principales ventajas de usar patrones IoC es que reducimos el acople entre una clase y las clases de las cuales depende, y eso cuando queremos utilizar por ejemplo tests unitarios es muy importante (no seré yo quien hable ahora de las ventajas de TDD cuando ya lo ha hecho Rodrigo (http://geeks.ms/blogs/rcorral/archive/2006/12/02/beneficios-y-carater-iacute-sticas-de-un-buen-test-unitario.aspx)). De los distintos patrones IoC me interesa comentar específicamente dos: Service Locator y cómo podemos usarlo en .NET. Para más adelante dejo Dependency Injection, otra forma de IoC que también es extremadamente útil.

Id a la nevera, coged una Voll-Damm o cualquier otra cervecilla y sentaos que este post es un poco largo… J

Service Locator

El objetivo de Service Locator es reducir las dependencias que tenga una clase. Imaginemos una clase, que depende de otras dos clases (p.ej. ServicioSeguridad y ServicioLogin). Podríamos tener un código tal como:

class
Client

{

static
void Main(string[] args)

{

new
Client().Run();

}

private
void Run()

{

// En este punto necesitamos objetos de las clases ServicioSeguridad y ServicioLogger


ServicioSeguridad ss = new
ServicioSeguridad();


ServicioLogger sl = new
ServicioLogger();


//…

}

}

En este punto tenemos un fuerte acople entre la clase Client y las clases ServicioSeguridad y ServicioLoggger. Seguiríamos teniendo este mismo acople incluso aunque utilizáramos interfaces porque deberíamos hacer el “new”:

IServicioSeguridad ss = new
ServicioSeguridad();

IServicioLogger sl = new
ServicioLogger();

 

Las principales desventajas de esta situación son:

  1. Las clases que implementan las dependencias (en nuestro caso ServicioSeguridad y ServicioLogger) deben estar disponibles en tiempo de compilación (no nos basta con tener solo las interfaces).
  2. El fuerte acople de la clase con sus dependencias dificulta de sobremanera su testing. Si queremos utilizar Mocks para de ServicioSeguridad o ServicioLogger vamos a tener dificultades

El patrón de ServiceLocator soluciona estos dos puntos, sustituyendo las dependencias de la clase Client por dependencias a los interfaces y a un elemento externo, que llamaremos Contenedor encargado de devolver las referencias que se le piden.

Cuando la clase necesita un objeto en concreto, lo pide al contenedor:

IServicioSeguridad ss = container.Resolve<IServicioSeguridad>(“servicioseguridad”);

IServicioLogger sl = container.Resolve<IServicioLogger>(“serviciologger”);

El método Resolve devolvería una referencia del tipo especificado en el parámetro genérico de acuerdo con un identificador. Evidentemente falta alguien que cree el contenedor y que agregue los servicios a él. Es decir, en algún sitio habrá algo como:

container = new
IoCContainer();

container.Add<IServicioSeguridad, ServicioSeguridad>(new
ServicioSeguridad(), “servicioseguridad”);

container.Add<IServicioLogger, ServicioLogger>(new
ServicioLogger(), “serviciologger”);

La gran diferencia es que esto no tiene porque estar en la clase Client. Simplemente pasándole a la clase Client una referencia al contenedor, eliminamos todas las dependencias de la clase Client con las clases que implementan los servicios. Y donde creamos el contendor? Pues depende… si estamos en nuestra aplicación, lo podemos crear en el método que inicialice la aplicación, pero si queremos probar la clase Client con tests unitarios podemos crear el contenedor en la inicialización del test…. Y lo que es mejor: rellenarlo con Mocks de los servicios!

Así, nuestro programa podría tener una clase Bootstrapper que crea el contenedor de IoC y lo inicializa con los objetos necesarios:

class
Bootstrapper

{

static
void Main(string[] args)

{

IIoCContainer container = new
IoCContainer();

container.Add<IServicioSeguridad, ServicioSeguridad>(new
ServicioSeguridad(), “servicioseguridad”);

container.Add<IServicioLogger, ServicioLogger>(new
ServicioLogger(), “serviciologger”);


new
Client(container).Run();

}

}

Pero si queremos usar tests unitarios de la clase Client, podemos cambiar los objetos por Mocks fácilmente:

[ClassInitialize]

public
static
void Init(TestContext context)

{

container = new
IoCContainer();

container.Add<IServicioSeguridad, ServicioSeguridadMock>(new
ServicioSeguridadMock(), “servicioseguridad”);

container.Add<IServicioLogger, ServicioLoggerMock>(new
ServicioLoggerMock(), “serviciologger”);

}

[TestMethod]

public
void TestMethod1()

{

Client c = new
Client(container);

c.Run(); // Este método Run usará los Mocks!

}

 

Fijaos que podemos lanzar tests unitarios sobre la clase Client, sin necesidad alguna de cambiar su código y utilizando Mocks. Además, la clase Client no tiene ninguna dependencia con las implementaciones de los servicios que utiliza, así que no es necesario ni que existan para poder crear la clase Client (sólo necesitamos las interfaces).

Unity

Aunque existen varios contenedores IoC open source para .NET, Microsoft tiene el suyo, también open source, llamado Unity (http://www.codeplex.com/unity/). Unity proporciona soporte para los patrones Service Locator y Dependency Injection.

Para que veais un poco su uso he dejado un proyecto de herramienta de línea de comandos para listar los ficheros de un directorio (vamos un dir, jejejee…. J).

La solución está dividida en varios proyectos:

  1. DemoIoC: Contiene el Bootstrapper, la clase que inicializa el contenedor de Unity, agrega la clase llamada ServicioFicheros y utiliza un objeto Cliente para realizar las acciones de la línea de comandos.
  2. Cliente: Contiene la implementación de la clase Cliente.
  3. Interfaces: Contiene las interfaces del servicio (en este caso sólo una)
  4. Implementations: Contiene las implementaciones del servicio (en este caso sólo una)
  5. Mocks: Contiene las implementaciones de los Mocks (en este caso sólo una)
  6. UnitTests: Contiene tests sobre la clase Cliente, usando un Mock del servicio ServicioFicheros.

El ejecutable (proyecto DemoIoC, assembly DemoIoC.exe) es un archivo de línea de comandos que acepta dos parámetros:

DemoIoC –l para listar todos los ficheros (del directorio actual)

DemoIoC –e:fichero.ext Indica si el fichero “fichero.ext” existe (en el directorio actual).

Si lo ejecutáis veréis que NO funciona bien: lista los ficheros correctamente, pero devuelve que un fichero existe cuando no es cierto y viceversa. Si miráis el código de la clase Cliente, encontrareis el error, ya que es obvio, pero lo bueno es que el proyecto UnitTest, testea este método de la clase Cliente, usando un Mock del ServicioFicheros y el UnitTest detecta el error. Observad lo fácil que ha sido sustituir el ServicioFicheros por un Mock sin alterar la clase Cliente, gracias al uso del patrón Service Locator!

PD: Estooooo… que me he dejado de adjuntar el código de ejemplo… Lo teneis aquí!!!

Saludos!!!

Referencias

Os dejo algunas referencias para su lectura por si os interesa profundizar un poco en el tema tratado:

[ALM 08] El efecto mariposa en el desarrollo del Software…

… o como la falta de comunicación es una de las principales causas del fracaso de muchos proyectos.

Pero un momento, que me embalo. Esta es la charla que dieron en las ALM Sessions 08, mis compañeros en raona, Jorge Ramo y Juan Carlos Viñas (bueno, el título “oficial” era: Integración entre EPM y TFS). En la charla comentaron las principales causas del fracaso de muchos proyectos haciendo especial incapié en la falta de comunicación. Luego analizaron distintos modelos de comunicación empresarial entre los distintos departamentos con responsabilidad en un proyecto (como dirección, marketing y técnico). Y para finalizar explicaron las herramientas que Microsoft ofrece para ayudar a mantener un mayor control y mejorar la comunicación en la gestión de proyectos. Así comentaron como Project Portfolio Server, Project Server y TFS ayudan a mejorar la comunicación y el seguimiento del conjunto de proyectos de una empresa, permitiendo la toma de decisiones basandose en informaciones concretas y obtenidas en tiempo real.

Aquí teneis la presentación y os recuerdo que como todas las sesiones de este ALM’08 estará grabada y se podrá ver “en diferido”.

Y para que veais un poquillo el ambiente que se respiraba, os dejo un par de fotillos…

Por un lado a Jorge Ramo presentando la charla:

José Luis Montes en el ALM08

y por otro una vista general de la sala:

 Vista general de la presentación de raona en el ALM'08

Ah! Sí!!! Os recuerdo que, como es habitual en este ALM’08, habrá un workshop (en Madrid y en Barcelona) donde se profundizará con más detalle en todos los temas tratados en la charla!!

Saludos!

[WPF] Library project file cannot specify ApplicationDefinition element

Imagina la siguiente situación: Tienes un proyecto en WPF, con varias ventanas o controles WPF creados, y de repente te da por reorganizarlo todo un poco. Así, que añades un proyecto de tipo “Class Library” a la solución, y luego arrastras desde el Solution Explorer, algunas de las ventanas y/o controles al nuevo proyecto.

Cuando más o menos lo tienes todo, le das a compilar y Visual Studio se queja con dos errores:

  • error MC1002: Library project file cannot specify ApplicationDefinition element.
  • error BG1003: The project file contains a property value that is not valid.

Además aunque le des doble-click en la ventana de errores, Visual Studio no está dispuesto a decirte en que línea o al menos que fichero es el causante de los dos errores.

El error se produce cuando al arrastrar los controles xaml al nuevo proyecto, Visual Studio cambia la “Build Action” de los controles que hayas arrastrado de “Page” a “ApplicationDefinition”, y una librería no puede tener ningún control o ventana xaml con “ApplicationDefinition”. Así pues, seleccionas en el “Solution Explorer” los ficheros xaml que hayas arrastrado (si arrastras más de un archivo te los cambia todos) y en propiedades, pones “Build Action” a “Page”… y listos!

Saludos!

PD: El fichero que tiene la Build Action como “ApplicationDefinition” es aquel que proporciona el punto de entrada de la aplicación y por lo tanto solo es válido en ejecutables (suele ser el App.xaml).

El Guille en Igualada

Bueno… ya pasó El Guille por Igualada, en la sexta etapa de la Guille Community Tour.

La verdad  es que para un grupo de usuarios como CatDotNet fue un honor que un ponente de su categoría, se acercara a hacernos una visita, y deleitarnos a todos con su magnífica presentación sobre las novedades que trae Visual Basic 2008 (o VB9), amenizada con numerosas bromas y simpáticos ejemplos. Nos contó la anécdota de “MiAmiguito” con el fondo rosa que menciona Jose Luis Latorre, pero nuestro proyector funcionaba bien, así que no pudimos verla, jejejeee… 😛

Como no podía ser menos batimos todos los récords de asistencia, con unas 35 personas más o menos, y El Guille demostró porque es uno de los mejores ponentes de toda España.

En fin, fue una magnífica presentación (como no podía ser menos)… solo aprovechar para decir que si hay alguien de Igualada o cerquita, o simplemente interesado en saber qué movidas vamos organizando, que se ponga en contacto conmigo o con Jose Luis Torres y vamos hablando!!!!!

Nos vemos!!!!

PD: Uuuuups…. no tengo las fotos a mano ahora, pero tan buen punto las tenga, colgaré algunas para que podais verlas 😉