Extendiendo ASP.NET MVC 3

Buenas!

En esta serie de post vamos a estar revisando con ejemplos los principales puntos de extensibilidad de ASP.NET MVC 3.

La lista a revisar es la siguiente:

•Model:

–Value Providers

–Model Binders

•View:

–View Engines

–Html Helpers

–Razor Helpers

•Controller:

–Action Name Selectors

–Action Methods Selectors

–Action Filters

–Exceptions Filters

–Custom Results

Así que empecemos!!

Value Providers:

Model Binding es el proceso de transformar los datos que se obtienen al momento del Request (como por ejemplo valores de Forms, Query Strings, etc.) en Modelos.

Para esto durante el Model Binding es necesario contar con un mecanismo que nos permita entender de donde provienen los datos para poder acceder a estos y utilizarlos para crear o actualizar objetos del Modelo. Este mecanismo son los Value Providers.

El propósito de un Value Provider es simple, proveer acceso a la información que se puede utilizar para el proceso de Model Binding. MVC posee varios Value Providers que el Default Model Binder utiliza, entre estos FormValueProvider, QueryStringValueProvider y RouteDataValueProvider.

En nuestro ejemplo crearemos un Value Provider que accede a las Cookies para obtener valores.

Para esto, vamos a agregar una nueva clase llamada CookieValueProvider que implementa la interfaz IValueProvider.
Esta interfaz posee dos métodos:
- ContainsPrefix: Se utiliza para determinar si el Value Provider puede obtener los valores solicitados bajo ese prefijo / clave. Si puede, MVC lo va a utilizar para obtener el valor utilizando el método GetValue. Devuelve un boolean.
- GetValue: Obtiene le valor a través de la clave solicitada. Devuelve una instancia de ValueProviderResult la cual es básicamente un Wrapper del valor, que se encarga de resolver algunas cuestiones como conversiones o manejo de cultura.

La siguiente seria nuestra implementación de CookieValueProvider. Al construirse utiliza la colección de HttpCookies para crear un diccionario donde se almacenan los valores de las cookies indexadas por sus claves. Con esta información, el método ContainsPrefix verifica si en la colección existe la clave. Si existe devuelve True y entonces MVC va a utilizar este Value Provider para obtener el valor a través el método GetValue, el cual va a acceder al diccionario de valores de cookies para obtener el valor y devolverlo como una instancia de ValueProviderResult

public class CookieValueProvider : IValueProvider
{
   
private Dictionary<string, string
> _cookiesKeys =
       
new Dictionary<string, string
>();

   
public CookieValueProvider(HttpCookieCollection
cookieCollection)
    {
       
foreach (string cookieName in
cookieCollection)
        {
           
var
cookie = cookieCollection.Get(cookieName);

           
foreach (var key in
cookie.Values.AllKeys)
            {
               
if (key != null
&& !_cookiesKeys.ContainsKey(key))
                    _cookiesKeys.Add(key, cookie.Values.Get(key));
            }
        }
    }

   
public bool ContainsPrefix(string
prefix)
    {
       
var
containsPrefix = _cookiesKeys.Keys.Any(x => x == prefix);

       
return
containsPrefix;

    }

   
public ValueProviderResult GetValue(string
key)
    {
       
var
value = _cookiesKeys[key];

       
return value != null
?
           
new ValueProviderResult(value, value, CultureInfo
.CurrentUICulture)
            :
null;
    }
}

Con esto, tenemos completo nuestro Custom Value Provider para acceder a las Cookies y obtener valores desde allí. Ahora el siguiente paso es “decirle” a MVC que existe un nuevo Value Provider y que tiene que ser considerado para ser utilizado al momento de obtener valores durante el proceso de Model Binding.

Para esto necesitamos implementar una clase que derive de la clase abstracta ValueProviderFactory e implemente el método GetValueProvider. Esta fábrica se va encargar de devolver nuestro nuevo Value Provider construido basándose en la información de contexto.
La siguiente seria nuestra implementación de la CookieValueProviderFactory, la cual en el método GetValueProvider se encarga de devolver una nueva instancia de CookieValueProvider, pasándole por parámetro de constructor la colección de Cookies que se están utilizando en el Request.

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

Una vez creada nuestra fabrica, el ultimo punto es registrarla dentro de la coleción de fábricas de Value Providers que posee MVC. Esto lo podemos hacer dentro del archivo Global.asax, en el método Application_Start, como se ve a continuación:

protected void Application_Start()
{
   
//....         
    ValueProviderFactories
.Factories.Add(new CookieValueProviderFactory
());          
   
//....
}

Con este último punto, nuestra aplicación esta lista para utilizar nuestro nuevo ValueProvider!

En la próxima semana continuaremos con el siguiente punto de extensibilidad: Model Binders.

Nos leemos!!

No Comments