[C# Básico] Delegates

Hola a todos! Este es el tercer post de esa “serie” de C# Básico. En el primero vimos las interfaces y en segundo intenté responder a la pregunta de que es la herencia.

Hoy quiero hablaros de un tema sobre el que bastante gente tiene dificultades y sobre el que hay bastante confusión, pero que en el fondo es mucho más simple de lo que parece! Sí, me estoy refiriendo a los delegates (o delegados).

1. La necesidad de los delegates

Cuando queremos enviar valores a un método que son desconocidos para este, lo que hacemos es usar parámetros. Vamos, a nadie le sorprende el código:

int Sumar (int a, int b)
{
   return a + b;
}

El método Sumar recibe dos parámetros y hace con ellos lo que sea (en este caso sumarlos). El uso de parámetros es vital porque sino deberíamos declarar un método por cada combinación posible de valores… En nuestro caso deberíamos hacer un método Sumar1y1 que sumase 1+1, otro Sumar1y2 que sumase 1+2…  ya se ve que eso por un lado es imposible y por otra un poco (bastante) estúpìdo. El uso de parámetros es algo que todos aprendemos más bien pronto al desarrollar y con los que todos nos sentimos cómodos.

Un parámetro tiene básicamente dos cosas:

• Un nombre, que se usa dentro del método para referirse a él



• Y un tipo que indica que clase de valores puede tener el parámetro.

El tipo es lo que me importa ahora: Si el parámetro es de tipo int puede contener cualquier entero, si es un double puede contener cualquier valor en coma flotante y si es FooClass puede contener cualquier objeto de la clase FooClass. Nada nuevo bajo el sol.

Bien, ahora imaginad que teneis una lista de cadenas y queréis ordenarla. Para ello os creais un método tal que:

void SortList(List<string> lst)
{
   // ...
}

El método recibe un parámetro que es la lista a ordenar. Da igual que algoritmo de ordenación implementéis, en algún momento deberéis hacer algo como:

void SortList(List<string> lst)
{
   // En str1 y str2 tenemos dos elementos que debemos comparar
   if (FirstStringGoesBefore(str1, str2)) { ... }
}

El método FirstStringGoesBefore es un método helper vuestro que indica si una cadena va antes que otra según vuestro criterio de ordenación. P.ej. podría ser:

bool FirstString (string first, string second)
{
   return first.Length <= second.Length;
}

Esto ordenaria las cadenas según su número de carácteres.

Vale… ¿observas un pequeño problema? ¿Cuál?

¡Exacto! Nuesta función SortList tiene el criterio de ordenación fijado, siempre ordena las cadenas según su número de caracteres! El algoritmo para ordenar cadenas (implementado en SortList) siempre es igual sea cual sea el criterio. Pero el criterio está en el método FirstStringGoesBefore() que decide, dadas dos cadenas, cual va antes que cual. No se a vosotros pero a mi, criterios de ordenación de cadenas me salen muchísimos: por número de carácteres, alfabéticamente, según representación numérica (es decir “01” antes que “112” porque 1 es menor que 112), etc, etc

La pregunta es debo hacer un método SortList para cada criterio? Es decir debo hacer un SortListByLength, otro SortListByAlphabetic,…

Dicho de otro modo: no le podríamos pasar al método SortList el criterio a utilizar como un parámetro? Ya, pero resulta que el criterio de ordenación resulta que es un método, no un valor (como int) o un objeto. Pues bien si comprendes la necesidad de pasar métodos como parámetros, comprendes la necesidad de los delegates. Y es que un delegate no es nada más que la posibilidad de pasar un método como parámetro.

2. Declración de un delegate

Cuando declaramos un parámetro, el tipo de ese parámetro determina que valores son válidos. Si el parámetro és int el valor 2 es correcto pero el valor 3.14159 no, ya que cae fuera de los valores válidos para int. Si el parámetro es FooClass entonces cualquier objeto FooClass es válido, pero un objeto de cualquier otra clase (p.ej. string) pues no.

Los delegates sirven para poder pasar métodos como parámetros y también hay varios tipos de delegates. Tiene lógica: no es lo mismo un método que espera dos cadenas y devuelve un bool que otra que espera dos ints y no devuelve nada. El primero sería un criterio de ordenación válido, la segunda no. Si yo creo el método SortList y admito un delegate como parámetro para el criterio de ordenación, es lógico que quiera asegurarme que sólo funciones que aceptan dos strings y devuelven bool són válidas. Total: yo voy a usar ese delegate pasándole dos cadenas y esperando un bool.

Por ello, cuando se define un delegate debe definirse que métodos acepta ese delegate: o sea los parámetros y el valor de retorno que los métodos deben tener.

Así no es de extrañar que la definición de un delegate se parezca sospechosamente a la definición de un método:

delegate bool CriterioOrdenacion(string str1, string str2);

Fijaos en el uso de la palabra clave delegate, que indica que lo que viene a continuación es la declaración de un delegate (y no de un método). El ejemplo declara un delegate llamado CriterioOrdenacion que permite pasar como parámetro métodos que acepten dos cadenas y que devuelva bool.

Nota: Que las dos cadenas se llamen str1 y str2 es totalmente superficial y no tiene ninguna importancia. Si yo creo un método que acepte dos cadenas y devuelva un bool podré pasarlo como parámetro usando este delegate aunque las cadenas no se llamen str1 y str2. Personalmente creo que el hecho de que en la declaración de un delegate los parámetros aparezcan nombrados sólo crea confusión.

3. Uso de un delegate

Una vez tengo definido el delegate ya puedo usarlo. Cuando defino un delegate creo un nuevo tipo de datos. Así pues la el método SortList quedaría como:

void SortList(List<string> lst, CriterioOrdenacion criterio)
{
    // ...
    if (criterio(first, second)) {...}
}

Fijaos en dos cosas:

1. El parámetro criterio cuyo tipo es CriterioOrdenacion que es el delegate que habíamos definido antes.



2. La “invocación” al delegate. Para invocar a un delegate se invoca como si fuese un método. Es decir criterio(first, second) llamará realmente al método que hayamos recibido como parámetro. Nosotros no sabemos cual es ese método, pero gracias al delegate
   
   
   
   1. Sabemos que recibe dos cadenas y devuelve un bool
   
   
   
   2. Podemos invocarlo
   
   
   
   

Bien, ahora nos falta ver como podemos llamar al método SortList pasándole un criterio de ordenación en concreto. Para ello hemos de ver como instanciar un delegate.

Imaginad que tengo un método llamado CriterioOrdenacionSegunLength que queremos usar como un criterio de ordenación:

bool CriterioOrdenacionSegunLength(string s1, string s2)
{
    return s1.Length <= s2.Length;
}

Y ahora quiero invocar al método SortList usando el método CriterioOrdenacionSegunLength como criterio de ordenación. Para ello defino una variable de tipo CriterioOrdenacion (el delegate) y la instancío con el método:

CriterioOrdenacion miCriterio = 
new CriterioOrdenacion(CriterioOrdenacionSegunLength);

Para instanciar un delegate se usa new al igual que para instanciar una clase, y se pasa el nombre del método con el que se instancia este delegate.

Y ahora ya puedo llamar a SortList:

SortList(lst, miCriterio);

Y listos! El método SortList usará ahora el criterio de ordenación del delegate miCriterio que es el método CriterioOrdenacionSegunLength.

4. Delegates y eventos

Mucha gente confunde delegates y eventos, aunque no es exactamente lo mismo. Ya hemos visto un delegate, y lo que conocemos como “evento” se basa, ciertamente, en delegates. Lo que pasa es que podemos ver un evento como una lista de delegates (lo que en .NET llamamos un MulticastDelegate). Cuando en C# estamos haciendo:

btn.Click += new EventHandler(btn_Click);

Estáis creando un delegate de tipo EventHandler y lo añadís a “la lista” de delegates del evento. Cuando el botón lanza el evento, lo que hace es invocar uno a uno todos los delegates de la lista, y así es como se llama al método btn_Click. Si mirais como está definido EventHandler vereis que su definición es:

public delegate void EventHandler(object sender, EventArgs e);

De ahí los famosos dos parámetros que tenemos en (casi) todas nuestras funciones gestoras de eventos!

5. Delegates y threads

Hay gente que también confunde delegates con threads. Delegates ya hemos visto que son, y los threads no son nada más que ejecutar un código en segundo plano. La confusión viene porque para crear un thread debemos decirle cual es el código a ejecutar en segundo plano. Es decir que método ejecutar en segundo plano. Es decir, debemos pasarle un delegate.

6. Para ver más…

Me he dejado cosas en tintero, porque sino este post, honestamente, no se terminaría nunca… Si os interesa profundizar sobre el tema, sabed que me he dejado adrede (os dejo algunos links):

1. Delegates y genéricos



2. Delegates y métodos anónimos



3. Lambda expressions



4. Delegates y reflection



5. Reglas de covarianza y contravarianza de los delegates

Si alguien está interesado en profundizar sobre alguno de esos temas, que me lo diga y veremos que podemos hacer al respecto! ;-)

Espero que este post os haya ayudado a tener más claro el concepto de un delegate!

Un saludo! ;-)

PD: Como no… un crosspost desde mi blog de geeks.ms! Pásate por allí mejor!

ASP.NET MVC Q&A: ¿Cómo se usan las cookies?

Buenoooo… sigo esta serie que se inició a raíz de las preguntas que recibí en el webcast que realicé sobre ASP.NET MVC para la gente del DotNetClub de la UOC. Si queréis ver que otros posts de esta serie hay (o habrá) echad un vistazo al post que sirve de índice.

En este caso la pregunta fue “Cómo y desde donde acceder a las cookies en una aplicación MVC”. Este post está muy relacionado con el mismo que hablaba sobre el acceso a la sesión. En particular las normas sobre desde donde acceder serían las mismas:

1. No acceder a las cookies desde las vistas. Las vistas deben ser agnósticas sobre la procedencia de los datos que muestran.
2. (Intentar) no acceder desde el modelo: Esto “ata” el modelo a “objetos http”. Intenta mantener el modelo libre de esas dependencias, y si por alguna razón no puedes encapsula todo este acceso en clases helper y preferiblemente inyecta esas clases usando un contenedor IoC.
3. Acceder desde los controladores. Los controladores ya están atados a todos los objetos http, así que es uno de los mejores lugares para acceder a las cookies.

Acceso a las cookies de forma manual

Para establecer una cookie basta con usar la clase HttpCookie y la colección Cookies que está en la Response:

string valor = "valor de cookie";
HttpCookie cookie1 = new HttpCookie("foo_one", valor);
ControllerContext.HttpContext.Response.SetCookie(cookie1);

Aquí estamos estableciendo la cookie llamada foo_one con el valor contenido en la variable valor. La colección Cookies que está en la Response contiene las cookies que se envían del servidor al cliente.

Para leer una cookie que el cliente nos envía, debemos acceder a la colección cookies, pero ahora debemos usar la que está en la Request:

var c1 = ControllerContext.HttpContext.Request.Cookies["foo_one"];
if (c1 != null)
{
   string valor = c1.Value;
}

En el código recuperamos la cookie foo_one que nos ha enviado el cliente.

Acceso a las cookies via Value Provider

Bien… que os parece este código?

public ActionResult GeCookieManual()
{
    var c1 = ControllerContext.HttpContext.Request.Cookies["foo_one"];
    var c2 = ControllerContext.HttpContext.Request.Cookies["foo_two"];
    FooData fd = null;

    if (c1 != null && c2 != null)
    {
        fd = new FooData()
        {
            OneValue = c1.Value,
            AnotherValue = c2.Value
        };
    }

    return View("Details", fd);
}

Fijaos en lo que hace… obtiene dos cookies y con ellas crea un objeto de la clase FooModel.

¿Y bien? ¿No os suena mucho al binding todo eso? Si los datos estuviesen en la querystring (GET) o bien en POST ASP.NET MVC seria capaz de crear automáticamente el objeto FooModel… y con las cookies no puede?

Pues no. Al menos no “de serie”… pero por suerte ASP.NET MVC es tan extensible que introducirle esta capacidad es muy, muy fácil…

La clave está en crearnos un IValueProvider propio, que trabaje con las cookies. Ya he comentado en anteriores posts que los value providers son los encargados de “parsear” la request del cliente, recoger los datos y dejarlos todos en un mismo sitio para que el model binder pueda realizar el binding. Por defecto hay value providers para querystring y para POST (además de alguno más rarito que no nos importa ahora), pero no lo hay para cookies. Veamos como podríamos crearlo.

No voy a entrar mucho en detalle, solo comentaré que es necesario crear la clase que implementa IValueProvider y luego crear la factoría (la clase que creará nuestro value provider). En mi post sobre Value Providers tenéis más detalles.

La clase que implementa IValueProvider es muy simple:

public class CookieValueProvider : IValueProvider
 {
     private readonly HttpCookieCollection cookies;

     public CookieValueProvider(HttpCookieCollection cookies)
     {
         this.cookies = cookies;
     }

     public bool ContainsPrefix(string prefix)
     {
         return this.cookies[prefix] != null;
     }

     public ValueProviderResult GetValue(string key)
     {
         var cookie = this.cookies[key];
         return cookie != null ?
             new ValueProviderResult(cookie.Value, cookie.Value, CultureInfo.CurrentUICulture) : null;
     }
 }

Básicamente ContainsPrefix debe devolver si la clave existe dentro de este value provider y GetValue debe devolver el valor asociado a la clave. En nuestro caso simplemente debemos mirar dentro de la colección de cookies que recibimos del constructor.

Ahora toca la factoria, que lo único que debe hacer es crear un CookieValueProvider y pasarle la colección Cookies de la Request:

public override IValueProvider GetValueProvider(ControllerContext controllerContext)
{
    return new CookieValueProvider(controllerContext.HttpContext.Request.Cookies);
}

Y finalmente, en el Application_Start (en Global.asax) registramos esa factoría de value providers:

ValueProviderFactories.Factories.Add(new CookieValueProviderFactory());

Ahora si tenemos la clase FooData deifnida como:

public class FooData
{
    public string OneValue { get; set; }
    public string AnotherValue { get; set; }
}

Y si hemos establecido cookies que se llaman igual que las propiedades (OneValue y AnotherValue), podemos obtener los valores dejando que actúe el binding de ASP.NET MVC:

public ActionResult GetCookieAuto(FooData data)
{
    // data está rellenado con el valor de las cookies
}

Y listos! Nuestro value provider obtiene el valor de las cookies y el model binder se encarga del resto! :)

Os dejo el link de un post de donde vi hace algún tiempo el value provider para cookies en ASP.NET MVC.

Un saludo a todos!!!

PD: Como siempre… esto es un crosspost desde mi blog de geeks.ms

[C# Básico] Interfaces

Hola a todos! El otro día recibí un correo que decía lo siguiente:

¿Podrías escribir algo sobre el uso de Interfaces? Yo por ahi he leido que es algo recomendado crear interfaces que es como un patrón.. Yo la verdad no las uso en mis proyectos pero me gustaría saber para qué sirven y porque se deberían usar y en qué casos.

Reconozco que es un correo para reflexionar: muchas veces tendemos a escribir sobre lo más: lo más avanzado, lo más novedoso, lo más cool… y quizá nos olvidamos de que hay gente que lo que busca son artículos para iniciarse. Es cierto que Tutoriales de C# los hay a patadas en internet, pero una cosa es un tutorial planteado como un curso y otra un pequeño post sobre algún tema básico concreto.

Por esto me he decidido a hacer este post. Como digo en el título es C# básico, pero si como quien me mandó el correo, tienes dudas sobre como funcionan las interfaces en C#… bienvenido a bordo! ;-)

Seguiré la serie [C# Básico] si veo que hay demanda de ella, es decir que si alguien me propone que escriba sobre temas concretos (a nivel de introducción) no tengo ningún problema en hacerlo! :)

1.¿ Que es la interfaz de una clase?

En teoría de orientación a objetos, la interfaz de una clase es todo lo que podemos hacer con ella. A efectos prácticos: todos los métodos, propiedades y variables públicas (aunque no deberían haber nunca variables públicas, debemos usar propiedades en su lugar) de la clase conforman su interfaz.

Dada la siguiente clase:

class Contenedor
{
   public int Quitar();
   public void Meter(int v);
   private bool EstaRepetido(int v);
}

Su interfaz está formada por los métodos Quitar y Meter. El método EstaRepetido no forma parte de la interfaz de dicha clase, ya que es privado.

En orientación a objetos decimos que la interfaz de una clase define el comportamiento de dicha clase, ya que define que podemos y que no podemos hacer con objetos de dicha clase: dado un objeto de la clase Contenedor yo puedo llamar al método Quitar y al métdo Meter pero no puedo llamar al método EstaRepetido.

Así pues: toda clase tiene una interfaz que define que podemos hacer con los objetos de dicha clase.

2. Interfaces idénticas no significa clases intercambiables

Fíjate en estas dos clases:

class Contenedor
{
   public int Quitar() { ... }
   public void Meter (int v) { ... }
}
class OtroContenedor
{
   public int Quitar() { ... }
   public void Meter (int v) { ... }
}

Que puedes deducir de ellas? Exacto! Su inerfaz es la misma: con ambas clases podemos hacer lo mismo: llamar al método Quitar y al método Meter.

Ahora imagina que en cualquier otro sitio tienes un método definido tal y como sigue:

public void foo (Contenedor c)
{
   // Hacer cosas con c como p.ej:
   int i = c.Quitar();
   c.Meter(10);
}

El método recibe un Contenedor y opera con él. Ahora dado que las interfaces de Contenedor y OtroContenedor son iguales, uno podría esperar que lo siguiente funcionase:

OtroContenedor oc = new OtroContenedor();
foo(oc);

Pero esto no va a compilar. ¿Por que? Pues aunque nosotros somos capaces leyendo el código de comparar la interfaz de ambas clases, el compilador no puede hacer esto. Para el compilador Contenedor y OtroContenedor son dos clases totalmente distintas sin ninguna relación. Por lo tanto un método que espera un Contenedor no puede aceptar un objeto de la clase OtroContenedor.

Quiero recalcar que el hecho de que el compilador no compare las interfaces de las clases no se debe a una imposibilidad técnica ni nada parecido: se debe a que no tiene sentido hacerlo.

¿Por que? Pues simplemente porque las interfaces son idénticas por pura casualidad. Supón que fuese legal llamar a foo con un objeto OtroContenedor, ok?

Entonces podría pasar lo siguiente:

1. Alguien añade un método público a la clase Contenedor.



2. Se modifica el método foo para que llame a dicho método nuevo. Eso es legal porque foo espera un Contenedor como parámetro



3. La llamada a foo(oc) donde oc es OtroContenedor… como debe comportarse ahora? OtroContenedor no tiene el método nuevo que se añadió a Contenedor!

Así pues: dos clases con la misma interfaz no tienen relación alguna entre ellas y por lo tanto no se pueden intercambiar.

3. Implementación de interfaces

El ejemplo anterior ejemplifica un caso muy común: tener dos clases que hacen lo mismo pero de diferente manera. P.ej. imagina que Contenedor está implementado usando un array en memoria y OtroContenedor está implementando usando, que sé yo, pongamos un fichero en disco. La funcionalidad (la interfaz) es la misma, lo que varía es la implementación. Es por ello que en programación orientada a objetos decimos que las interfaces son funcionalidades (o comportamientos) y las clases representen implementaciones.

Ahora bien, si dos clases representan dos implementaciones distintas de la misma funcionalidad, es muy enojante (y estúpido) que no las podamos intercambiar. Para que dicho intercambio sea posible C# (y en general cualquier lenguaje orientado a objetos) permite explicitar la interfaz, es decir separar la declaración de la interfaz de su implementación (de su clase). Para ello usamos la palabra clave interface:

interface IContenedor
{
   int Quitar();
   void Meter(int i);
}

Este código declara una interfaz IContenedor que declara los métodos Quitar y Meter. Fíjate que los métodos no se declaran como public (en una interfaz la visibilidad no tiene sentido, ya que todo es public) y que no se implementan los métodos.

Las interfaces son un concepto más teórico que real. No se pueden crear interfaces. El siguiente código NO compila:

IContenedor c = new IContenedor();
// Error: No se puede crear una interfaz!

Es lógico que NO podamos crear interfaces, ya que si se nos dejara, y luego hacemos c.Quitar()… que método se llamaría si el método Quitar() no está implementado?

Aquí es donde volvemos a las clases: podemos indicar explícitamente que una clase implementa una interfaz, es decir proporciona implementación (código) a todos y cada uno de los métodos (y propiedades) declarados en la interfaz:

class Contenedor : IContenedor
{
   public int Quitar() { ... }
   public void Meter(int i) { ... }
}

La clase Contenedor declara explícitamente que implementa la interfaz IContenedor. Así pues la clase debe proporcionar implementación para todos los métodos de la interfaz. El siguiente código p.ej. no compila:

class Contenedor : IContenedor
{
   public void Meter(int i) { ... }
}
// Error: Y el método Quitar()???

Es por esto que en orientación a objetos decimos que las interfaces son contratos, porque si yo creo la clase la interfaz me obliga a implementar ciertos métodos y si yo uso la clase, la interfaz me dice que métodos puedo llamar.

Y ahora viene lo bueno: Si dos clases implementan la misma interfaz son intercambiables. Dicho de otro modo, en cualquier sitio donde se espere una instancia de la interfaz puede pasarse una instancia de cualquier clase que implemente dicha interfaz.

Podríamos declarar nuestro método foo anterior como sigue:

void foo(IContenedor c)
{
   // Cosas con c...
   c.Quitar();
   c.Meter(10);
}

Fíjate que la clave es que el parámetro de foo está declarado como IContenedor, no como Contenedor o OtroContenedor, con esto indicamos que el método foo() trabaja con cualquier objeto de cualquier clase que implemente IContenedor.

Y ahora, si supones que tanto Contenedor como OtroContenedor implementan la interfaz IContenedor el siguiente código es válido:

Contenedor c = new Contenedor();
foo(c);    // Ok. foo espera IContenedor y Contenedor implementa IContenedor
OtroContenedor oc = new OtroContenedor();
foo(oc); // Ok. foo espera IContenedor y OtroContenedor implementa IContenedor
// Incluso esto es válido:
IContenedor ic = new Contenedor();
IContenedor ic2 = new OtroContenedor();

4. ¿Cuando usar interfaces?

En general siempre que tengas, o preveas que puedes tener más de una clase para hacer lo mismo: usa interfaces. Es mejor pecar de exceso que de defecto en este caso. No te preocupes por penalizaciones de rendimiento en tu aplicación porque no las hay.´

No digo que toda clase deba implementar una interfaz obligatoriamente, muchas clases internas no lo implementarán, pero en el caso de las clases públicas (visibles desde el exterior) deberías pensarlo bien. Además pensar en la interfaz antes que en la clase en sí, es pensar en lo que debe hacerse en lugar de pensar en como debe hacerse. Usar interfaces permite a posteriori cambiar una clase por otra que implemente la misma interfaz y poder integrar la nueva clase de forma mucho más fácil (sólo debemos modificar donde instanciamos los objetos pero el resto de código queda igual).

5. Segregación de interfaces

Imagina que tenemos un sistema que debe trabajar con varios vehículos, entre ellos aviones y coches, así que declaramos la siguiente interfaz:

interface IVehiculo
{
    void Acelerar(int kmh);   
    void Frenar();   
    void Girar(int angulos);   
    void Despegar();   
    void Aterrizar();
}

Luego implementamos la clase avión:

class Avion : IVehiculo
{
    public void Acelerar(int kmh) { ... }
    public void Frenar() { ... }
    public void Girar (int angulos) { ... }
    public void Despegar() { ... }
    public void Aterrizar() { ... }
}

Y luego vamos a por la clase coche… y aquí surge el problema:

class Coche : IVehiculo
{
    public void Acelerar(int kmh) { ... }
    public void Frenar() { ... }
    public void Girar (int angulos) { ... }
    public void Despegar() {throw new NotImplementedException("Coches no vuelan"); }
    public void Aterrizar(){throw new NotImplementedException("Coches no vuelan"); }
}

La interfaz IVehiculo tiene demasiados métodos y no define el comportamiento de todos los vehículos, dado que no todos los vehículos despegan y aterrizan. En este caso es mejor dividir la interfaz en dos:

interface IVehiculo
{
    void Acelerar(int kmh);
    void Frenar();
    void Girar (int angulos);
}

interface IVehiculoVolador : IVehiculo
{
    void Despegar();
    void Aterrizar();
}

Fíjate además que IVehiculoVolador deriva de IVehiculo (en orientación a objetos decimos que hay una relación de herencia entre IVehiculoVolador y IVehiculo), eso significa que una clase que implemente IVehiculoVolador debe implementar también IVehiculo forzosamente. Por lo tanto podemos afirmar que todos los vehículos voladores son también vehículos.

Ahora si que la clase Coche puede implementar IVehiculo y la clase Avion puede implementar IVehiculoVolador (y por lo tanto también IVehiculo). Si un método foo() recibe un objeto IVehiculoVolador puede usar métodos tanto de IVehiculoVolador como de IVehiculo:

void foo (IVehiculoVolador vv)
{
   vv.Acelerar(10);   // Ok. Acelerar es de IVehiculo y IVehiculoVolador deriva de IVehiculo
   vv.Despegar();     // Ok. Despegar es de IVehiculoVolador
}

Al reves no! Si un método foo recibe un IVehiculo no puede llamar a métodos de IVehiculoVolador. Lógico: todos los vehículos voladores son vehículos pero al revés no… no todos los vehículos son vehículos voladores!

Siempre que haya segregación no tiene por que haber herencia de interfaces. Imagina el caso de que además de vehículos debemos tratar con Armas de guerra. Tenemos otra interfaz:

interface IArmaDeGuerra
{
    void Apuntar();
    void Disparar();
}

Ahora podrían existir clases que implementen IArmaDeGuerra como p.ej. una torreta defensiva:

class TorretaDefensiva : IArmaDeGuerra
{
    public void Apuntar() { ... }
    public void Disparar() { ... }
}

Pero claro… también tenemos vehículos que pueden ser a la vez armas de guerra, p.ej. un tanque! Que hacemos? Ningún problema: una clase puede implementar más de una interfaz a la vez! Para ello debe implementar todos los métodos de todas la interfaces:

class Tanque : IVehiculo, IArmaDeGuerra
{
    public void Acelerar(int kmh) { ... }
    public void Frenar() { ... }
    public void Girar (int angulos) { ... }
    public void Apuntar() { ... }
    public void Disparar() { ... }
}

Ahora si un método foo() recibe un IVehiculo le puedo pasar un Tanque y si otro método foo2 recibe un IArmaDeGuerra también le puedo pasar un Tanque. O dicho de otro modo, los tanques se comportan como vehículos y como armas de guerra a la vez!

Así pues, es importante segregar bien nuestras interfaces porque en caso contrario vamos a tener dificultades a la hora de implementarlos. La segregación de interfaces es uno de los 5 principios SOLID (concretamente la letra I: interface segregation principle).

Bueno… espero que este post os haya ayudado a comprender mejor que son las interfaces y como usarlas!

Un saludo a todos!

PD: Recuerda que esto, para variar, es un crosspost desde mi blog en geeks.ms!

ASP.NET MVC Q&A: ¿Como reciben parámetros los controladores?

Este es el segundo post de la serie que nace a raíz de las preguntas que se me realizaron en el Webcast que di sobre ASP.NET MVC.

Estaba explicando la tabla de rutas por “defecto” de ASP.NET MVC, indicando que el primer valor era el controlador, el segundo la acción y el tercero un parámetro llamado id:

routes.MapRoute(
    "Default", // Nombre de la ruta
    "{controller}/{action}/{id}",  // Formato de url /Controlador/Accion/Id
    new { controller = "Home", action = "Index", id = UrlParameter.Optional } // Valores x defecto
);

Comenté que dada esa tabla de rutas una url /Home/Index/100 se mapeaba a l’acción Index del controlador Home con un parámetro id a valor 100 (parámetro que era opcional).

En el Webcast no comenté nada más… voy a ampliar el tema ahora, porque es realmente interesante.

1. Acciones y tabla de rutas

Vamos a aclarar algunos puntos que son fundamentales relativos a las acciones y la tabla de rutas:

1. Las acciones se distinguen por su nombre, sin tener en cuenta sus parámetros. Eso significa que un controlador no puede definir dos veces la misma acción con parámetros distintos, salvo que se responda a verbos http distintos (p.ej. una acción responda a GET y otra a POST).



2. La tabla de rutas mapea una URL a una única acción de un controlador.



3. La tabla de rutas tiene una o más rutas, que se evalúan en orden. Cuando una URL hace matching con una ruta, se termina la evaluación.

Así el siguiente código es erróneo:

public class HomeController : Controller
{
    public ActionResult Index()
    {
        return View();
    }
    public ActionResult Index(int id)
    {
        return View();
    }
}

Uno podría pensar que la tabla de rutas enrutaría /Home/Index al método Index() sin parámetros y /Home/Index/100 al método Index() que acepta un entero, pero no. La tabla de rutas enruta tanto /Home/Index/ como /Home/Index/100 a la acción Index. Luego el framework cuando va a invocarla se encuentra con dos métodos que la implementan y da un error: The current request for action 'Index' on controller type 'HomeController' is ambiguous between the following action methods: System.Web.Mvc.ActionResult Index() on type MvcControllerParams.Controllers.HomeController System.Web.Mvc.ActionResult Index(Int32) on type MvcControllerParams.Controllers.HomeController

2. Parámetros opcionales en las rutas

¿Y que ocurriría con el siguiente código?

public class HomeController : Controller
{
    public ActionResult Index(int id)
    {
        return View();
    }
}

La tabla de rutas enruta /Home/Index/100 a dicha acción y el parámetro id vale 100… pero que ocurre si entramos /Home/Index?

Pues que da error: El parámetro id está declarado como opcional en la ruta, eso significa que puede no aparecer en la url. Así pues la url /Home/Index es válida y se enruta a la acción Index. Y cuando el framework se encuentra que quiere pasarle un valor al parámetro id, no puede porque no hay parámetro id en la url y int no es nullable. El mensaje de error que da es:

The parameters dictionary contains a null entry for parameter 'id' of non-nullable type 'System.Int32' for method 'System.Web.Mvc.ActionResult Index(Int32)' in 'MvcControllerParams.Controllers.HomeController'. An optional parameter must be a reference type, a nullable type, or be declared as an optional parameter.

La solución? Pues declarar que el parámetro id sea nullable:

public class HomeController : Controller
{
    public ActionResult Index(int? id)
    {
        return View();
    }
}

Fíjate en el uso de int? (que es la sintaxis que da C# para usar Nullable<int>).

Otra posible opción seria modificar la tabla de rutas para que en lugar de declarar el parámetro simplemente como opcional, asignarle un valor por defecto:

routes.MapRoute(
    "Default", // Route name
    "{controller}/{action}/{id}", // URL with parameters
    new { controller = "Home", action = "Index", id = 0 } // Parameter defaults
);

Fíjate que donde antes ponía id = UrlParameter.Optional ahora pone id = 0. La diferencia es sutil pero importante: antes si id no aparecía el framework asumía que no tenía valor, ahora si el parámetro no aparece el framework le asigna un valor por defecto de 0. Así, ahora en el controlador podemos volver a usar int en lugar de Nullable<int> (int? en c#).

El “pero” de esta opción es que no puedes distinguir entre /Home/Index y /Home/Index/0. Ambas URLs invocan la acción Index con el valor id=0.

Bien… ¿y que ocurrirá si entro la url /Home/Index/eiximenis? Pues que la tabla de rutas mapeará esta url a la acción Index y cuando el framework vaya a invocarla intentará convertir “eiximenis” a int y dicha conversión devolverá null al no ser posible. Así:

• Si teníamos Index(int id) el framework dará error, indicando que no puede asignar “null” a int.



• Si teníamos Index (int? id) recibiremos el valor null en el parámetro id. Efectivamente en este caso es lo mismo /Home/Index que /Home/Index/eiximenis

Si en lugar de declarar la acción con un parámetro int la declaro que recibe una cadena:

public ActionResult Index(string id)
{
    return View();
}

Todo es mucho más sencillo:

• /Home/Index –> Invoca Index() con id = null



• /Home/Index/100 –> Invoca Index() con id = “100”



• /Home/Index/eiximenis –> Invoca Index() con id=”eiximenis”

3. Acciones sin parámetros opcionales

Vamos a cambiar de nuevo la tabla de rutas para que quede:

routes.MapRoute(
    "Default", // Route name
    "{controller}/{action}/{id}", // URL with parameters
    new { controller = "Home", action = "Index" } // Parameter defaults
);

Fíjate que hemos eliminado la parte donde ponía id = UrlParameter.Optional. Así ahora el parámetro id es obligatorio en la ruta.

La url /Home/Index/eiximenis nos invoca la acción Index() con id=”eiximenis” pero que hace la url /Home/Index? Pues devuelve un 404. ¿Por que? Bien, cuando una URL no satisface ninguna de las entradas de la tabla de rutas, el framework devuelve un 404 para indicar que la URL no se corresponde a ningún recurso. En nuestro caso la tabla de rutas tiene una sola entrada que obliga que las urls tengan la forma /controlador/accion/id. Y dado que id no se ha declarado opcional ni se le ha dado ningún valor por defecto, debe aparecer explícitamente en la URL. Como en nuestro caso no aparece, la URL /Home/Index no cumple esta entrada en la tabla de rutas y por eso recibimos el 404.

4. Rutas con más de un parámetro

La pregunta explícita que me hicieron en el Webcast fue “Y se puede pasar más de un parámetro”? Mi respuesta en aquel momento fue simplemente que sí, añadiendolos a la tabla de rutas:

routes.MapRoute(
    "Default", // Route name
    "{controller}/{action}/{id}/{desc}", // URL with parameters
    new { controller = "Home", action = "Index", 
        id = UrlParameter.Optional, desc = UrlParameter.Optional } // Parameter defaults
);

Ahora la ruta tiene dos parámetros (ambos opcionales) id y desc.

En el controlador definimos la acción con los dos parámetros:

public ActionResult Index(string id, string desc)
{
    return View();
}

Tal y como lo tenemos:

• /Home/Index –> Invoca a Index con id=null y desc=null



• /Home/Index/eiximenis –> Invoca a Index con id=”eiximenis” y desc=null



• /Home/Index/eiximenis/edu –> Invoca a Index con id=”eiximenis” y desc=”edu”

De esta manera podemos pasar más de un parámetro a los controladores.

5. Otros parámetros (querystrings,…)

Bueno… vamos a liarla un poco más! Tal y como lo tenemos que ocurre con la url /Home/Index/eiximenis?desc=edu ?

Pues veamos: La tabla de rutas no usa la querystring, así que para la tabla de rutas es como si hubiesemos entrado /Home/Index/eiximenis, lo que se mapea a la acción Index. Luego cuando el framework va a invocar dicha acción:

• Pone el valor de id a “eiximenis” (primer valor de la url)



• El valor de la ruta para desc és null (recordad: la tabla de rutas no entiende de querystring). Entonces se analiza la querystring y el framework ve que el controlador acepta otro parámetro llamado desc y que en la querystring aparece dicho parámetro, así que le asigna valor.

Así por lo tanto, la url /Home/Index/eiximenis?desc=edu llama a l’acción Index con el valor de id a “eiximenis” y el valor de desc a “edu”.

Fijaos pues que las urls /Home/Index/eiximenis/edu y /Home/Index/eiximenis?desc=edu son equivalentes, puesto que ambas terminan llamando a la misma acción con los dos parámetros… pero que sean equivalentes no quiere decir que sean indistinguibles. Desde el controlador podemos saber si los parámetros nos vienen via ruta o bien via querystring:

public ActionResult Index(string id, string desc)
{
    var routedesc = this.RouteData.Values["desc"];
    return View();
}

El valor de routdesc será “edu” si venimos por la url /Home/Index/eiximenis/edu y null si venimos por la url /Home/Index/eiximenis?desc=edu

Nota: Todo lo que hemos dicho sobre la querystring aplica también a parámetros POST.

6. Bindings

Y vamos ya con la última… Imagina que tenemos una clase así:

public class FooModel
{
    public string id { get; set; }
    public string desc { get; set; }
}

Y declaramos nuestra acción para que reciba, no dos strings sinó un objeto FooModel:

public ActionResult Index(FooModel m)
{
    return View();
}

Ahora en este caso la url:

• /Home/Index –> Invoca a Index() con un objeto FooModel con id=null y desc=null



• /Home/Index/eiximenis –> Invoca a Index() con un objeto FooModel con id=”eiximenis” y desc=null



• /Home/Index/eiximenis/edu –> Invoca a Index() con un objeto FooModel con id=”eiximenis” y desc=”edu”



• /Home/Index/eiximenis?desc=edu –> Invoca a Index() con un objeto FooModel con id=”eiximenis” y desc=”edu”

Que te parece? El framework es capaz de convertir los parámetros (vengan de la ruta o del querystring) en el objeto que espera la acción, instanciando sus propiedades!

Y bueno… vamos a dejarlo aquí por el momento :) Espero que ahora tengáis un poco más claro como funciona el “paso de parámetros” a los controladores.

Un saludo a todos! ;-)

Una postdata para quien quiera profundizar

Si quieres profundizar en este tema, antes que nada ten presente los siguientes puntos:

• A través de la tabla de rutas el framework decide que acción implementa la URL



• Antes de invocar una acción, los Value Providers entran en acción, procesando los valores de la request. Los valores de la request pueden estar en:
  
  
  
  • RouteData (puestos por la tabla de rutas)
  
  
  
  • QueryString
  
  
  
  • POST
  
  
  
  • Cualquier otro sitio (p.ej. cookies). Se pueden crear value providers propios.
  
  
  
  



• Antes de invocar la acción, el ModelBinder entra en acción: coge los valores que han procesado los Value Providers y los intenta mapear a los parámetros de la acción.



• Se invoca la acción del controlador.

Ahora algunos links:

• La tabla de rutas (por Sott Guthrie). Es sobre MVC1 pero es útil igualmente (aunque recuerda que no hay UrlParameter.Optional)



• Post mío sobre los Value Providers.



• Post mío sobre el DefaultModelBinder (el Model Binder por defecto que usa el framework)



• Interesantes posts de MehdiGolchin sobre Model binders y value providers.

PD: Este post es un crosspost desde mi blog de geeks.ms!