La Escuela del Programador

Para ver cómo Visual Basic implementa los métodos de Extensión, vea el artículo Métodos de extensión (VB). Los métodos de extensión permiten "agregar" métodos a los tipos existentes sin necesidad de crear un nuevo tipo derivado y volver a compilar o sin necesidad de modificar el tipo original.Los métodos de extensión constituyen un tipo especial de método estático, pero se les llama como si se tratasen de métodos de instancia en el tipo extendido.En el caso del código de cliente escrito en C# y Visual Basic, no existe ninguna diferencia aparente entre llamar a un método de extensión y llamar a los métodos realmente definidos en un tipo. Los métodos de extensión más comunes son los operadores de consulta estándar de LINQ que agregan funcionalidad de consulta a los tipos System.Collections.IEnumerable y System.Collections.Generic.IEnumerable(T) existentes. Para usar los operadores de consulta estándar, primero inclúyalos en el ámbito con una directiva using System.Linq.Después, cualquier tipo que implemente IEnumerable(T) parecerá tener métodos de instancia como GroupBy, OrderBy, Average, etc.Puede ver estos métodos adicionales con la característica de finalización de instrucciones IntelliSense al escribir un "punto" después de una instancia de un tipo IEnumerable(T) como List(T) o Array. En el ejemplo siguiente se muestra cómo llamar al método de operador de consulta estándar OrderBy en un arreglo de enteros. La expresión entre paréntesis es una expresión lambda. Muchos operadores de consulta estándar usan expresiones lambda como parámetros, pero no es obligatorio para los métodos de extensión. Para más información sobre expresiones lambda, vea el artículo Expresiones Lambda

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace EjemploOrderBy
{
    class Program
    {
        static void Main(string[] args)
        {
            int[] ints = { 10, 45, 15, 39, 21, 26 };
            var result = ints.OrderBy(g => g);
            foreach (var i in result)
                System.Console.Write(i + " ");
            System.Console.WriteLine("\nPulse cualquier " +
                                  "tecla para terminar...");
            System.Console.ReadKey(true);
        }
    }
}

La salida es la que se muestra en la figura 1:

Como se ve en la figura 2, mediante IntelliSense, Visual Studio muestra el método OrderBy como si fuera un método de instancia, pero aclarando que es un método de extensión:

Los métodos de extensión se definen como métodos estáticos pero se llaman utilizando la sintaxis de los métodos de instancia.El primer parámetro especifica en qué tipo actúa el método y va precedido del modificador this.Los métodos de extensión sólo se incluyen en el ámbito cuando el espacio de nombres se importa explícitamente al código fuente con una directiva using. En el ejemplo siguiente se muestra un método de extensión definido para la clase System.String. Observe que se define dentro de una clase estática no anidada y no genérica:

using System;
namespace ExtensionMethods
{
    public static class MyExtensions
    {
        /// <summary>
        /// Cuenta las palabras que forman una cadena
        /// </summary>
        /// <param name="str">
        ///     Especifica que el método actúa sobre la clase String.
        /// </param>
        /// <returns>
        ///      La cantidad de palabras que componen la cadena
        /// </returns>
        public static int WordCount(this String str)
        {
            return str.Split(new char[] { ' ', '.', '?' },
                  StringSplitOptions.RemoveEmptyEntries).Length;
        }
    }
}

El método de extensión WordCount se incluye en el ámbito, con la directiva using y llamándolo como se muestra a continuación:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using ExtensionMethods;

namespace Ej_MetExtension
{
    class Program
    {
        static void Main(string[] args)
        {
            String cadena = "Esta es una prueba.Está seguro?Si";
            int cantPalabras = cadena.WordCount();
            System.Console.WriteLine("La cadena '{0}' tiene: " + 
                       {1} palabras", cadena, cantPalabras);
            System.Console.WriteLine("\nPulse cualquier " +
                         "tecla para terminar...");
            System.Console.ReadKey(true);
        }
    }
}

En el código, el método de extensión se invoca con sintaxis de método de instancia.Sin embargo, el lenguaje intermedio (IL) generado por el compilador convierte el código en una llamada en el método estático.Por lo tanto, no se infringe realmente el principio de encapsulación.De hecho, los métodos de extensión no pueden tener acceso a las variables privadas del tipo que extienden. En general, probablemente llamará a métodos de extensión con mayor frecuencia de lo que implementará los suyos propios.Dado que se llama a los métodos de extensión con sintaxis de método de instancia, no se requieren conocimientos especiales para usarlos desde el código de cliente.Para habilitar los métodos de extensión para un tipo determinado, simplemente agregue una directiva using para el espacio de nombres en el que se definen los métodos.Por ejemplo, para utilizar los operadores de consulta estándar, agregue esta directiva using a su código:

using System.Linq;

Enlazar métodos de extensión en tiempo de compilación

Puede utilizar métodos de extensión para extender una clase o una interfaz, pero no para invalidarlas.Nunca se llamará a un método de extensión que tenga el mismo nombre y firma que un método de interfaz o clase.En tiempo de compilación, los métodos de extensión siempre tienen menos prioridad que los métodos de instancia definidos en el propio tipo.En otras palabras, si un tipo tiene un método denominado Process(int i) y hay un método de extensión con la misma firma, el compilador siempre establecerá el enlace con el método de instancia.Cuando el compilador encuentra una invocación de método, busca primero una coincidencia entre los métodos de instancia del tipo.Si no la encuentra, buscará cualquier método de extensión definido para el tipo y establecerá el enlace con el primer método de extensión que encuentre.En el ejemplo siguiente se muestra cómo el compilador determina con qué método de extensión o método de instancia establecerá el enlace.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

// Una interface llamada IMyInterface.
namespace DefineIMyInterface
{
    using System;

    public interface IMyInterface
    {
        // Cualquier clase que implemente IMyInterface debe definir
        // un método que cumpla con la siguiente signatura.
        void MethodB();
    }
}

// Definimos métodos de extensión para IMyInterface.
namespace Extensions
{
    using System;
    using DefineIMyInterface;

    // Los siguientes métodos de extensión pueden ser accesados 
    // por instancias de cualquier clase que implementa IMyInterface.
    public static class Extension
    {
        public static void MethodA(this IMyInterface myInterface, 
                                   int i)
        {
            Console.WriteLine
                ("Extension.MethodA(
                         this IMyInterface myInterface, int i)");
        }

        public static void MethodA(this IMyInterface myInterface, 
                                   string s)
        {
            Console.WriteLine
                ("Extension.MethodA(
                        this IMyInterface myInterface, string s)");
        }

        // Este método nunca es llamado en ExtensionMethodsDemo1, 
        // debido a que cada una de las 3 clases A, B, y C 
        // implementan un método llamado MethodB que tiene la 
        // misma signatura.
        public static void MethodB(this IMyInterface myInterface)
        {
            Console.WriteLine
                ("Extension.MethodB(this IMyInterface myInterface)");
        }
    }
}

// Definimos 3 clases que implementan IMyInterface, y las usamos
// para probar los métodos de extensión.
namespace ExtensionMethodsDemo1
{
    using System;
    using Extensions;
    using DefineIMyInterface;

    class A : IMyInterface
    {
        public void MethodB() { Console.WriteLine("A.MethodB()"); }
    }

    class B : IMyInterface
    {
        public void MethodB() 
        { 
            Console.WriteLine("B.MethodB()"); 
        }
        public void MethodA(int i) 
        { 
            Console.WriteLine("B.MethodA(int i)"); 
        }
    }

    class C : IMyInterface
    {
        public void MethodB() { Console.WriteLine("C.MethodB()"); }
        public void MethodA(object obj)
        {
            Console.WriteLine("C.MethodA(object obj)");
        }
    }

    class ExtMethodDemo
    {
        static void Main(string[] args)
        {
            // Declaramos una instancia de cada clase (A, B, y C).
            A a = new A();
            B b = new B();
            C c = new C();

            // Para las 3 clases (a, b, y c), llamamos 
            // los siguientes métodos:
            //      -- MethodA con un argumento int
            //      -- MethodA con un argumento string 
            //      -- MethodB sin argumentos.

            // A no contiene MethodA, así que cada llamado al método
            // MethodA ejecuta el método de extensión que tiene la
            // signatura correspondiente.
            a.MethodA(1);        // Extension.MethodA(object, int)
            a.MethodA("hello");  // Extension.MethodA(object, string)

            // A tiene un método de instancia que se corresponde 
            // con la signatura del siguiente llamado al 
            // método MethodB.
            a.MethodB();            // A.MethodB()

            // B tiene un método de instancia que se corresponde 
            // con la signatura del siguiente llamados.
            b.MethodA(1);           // B.MethodA(int)
            b.MethodB();            // B.MethodB()

            // B no tiene un método de instancia que se corresponde 
            // con la signatura del siguiente llamado, pero la 
            // clase Extension si.
            b.MethodA("hello");  // Extension.MethodA(object, string)

            // C contiene un método de instancia que coincide 
            // con cada uno de los siguientes llamados.
            c.MethodA(1);           // C.MethodA(object)
            c.MethodA("hello");     // C.MethodA(object)
            c.MethodB();            // C.MethodB()

              System.Console.WriteLine("\nPulse cualquier " +
                         "tecla para terminar...");
            System.Console.ReadKey(true);
        }
    }
}

La salida se ve en la figura 3:

En el ejemplo anterior se muestran las reglas que sigue el compilador de C# para determinar si debe ligar una llamada a un método a un método de instancia del tipo, o a un método de extensión.La clase estática Extensions contiene métodos de extensión definidos para cualquier tipo que implementa IMyInterface.Las clases A, B y C implementan la interfaz. Nunca se llama al método de extensión MethodB, porque su nombre y firma coinciden exactamente con métodos ya implementados por las clases. Si el compilador no encuentra un método de instancia con una firma coincidente, establecerá el enlace con un método de extensión coincidente, en caso de que exista.

Instrucciones generales

En general, recomendamos que implemente métodos de extensión en contadas ocasiones, sólo cuando sea necesario.Siempre que sea posible, cuando el código de cliente debe extender un tipo existente, debe hacerlo creando un nuevo tipo derivado del existente.Para obtener más información, vea Herencia (C#) y Herencia (VB) Al utilizar un método de extensión para extender un tipo cuyo código fuente no se puede cambiar, corre el riesgo de que un cambio en la implementación del tipo interrumpa su método de extensión. Si implementa métodos de extensión para un tipo determinado, recuerde los dos puntos siguientes:

• Nunca se llamará a un método de extensión si tiene la misma firma que un método definido en el tipo.
• Los métodos de extensión se incluyen en el ámbito en el nivel de espacio de nombres.Por ejemplo, si tiene varias clases estáticas que contienen métodos de extensión en un espacio de nombres único denominado Extensions, la directiva using Extensions; los incluirá a todos en el ámbito.

Pasos para definir y llamar a un método de extensión

1. Defina una clase estática que contenga el método de extensión. La clase debe estar visible para el código cliente. Vea Modificadores de acceso (C#)> para saber más sobre Reglas de accesibilidad.
2. Implemente el método de extensión como método estático que tenga al menos la misma visibilidad que la clase contenedora.
3. El primer parámetro del método especifica el tipo en el que funciona el método; debe estar precedido del modificador this.
4. En el código de llamada, agregue una directiva using para especificar el espacio de nombres que contiene la clase del método de extensión.
5. Llame a los métodos como si fueran métodos de instancia en el tipo. Observe que el código de llamada no especifica el primer parámetro porque éste representa el tipo en el que se aplica el operador y el compilador ya conoce el tipo del objeto.Sólo tiene que proporcionar argumentos para segundos parámetros a través de n.

Un ejemplo completo

En el ejemplo siguiente se implementa un método de extensión denominado WordCount en la clase MyExtensions.StringExtension.El método funciona en la clase String, que se especifica como primer parámetro de método.El espacio de nombres MyExtensions se importa al espacio de nombres de la aplicación y se llama al método desde el método Main:

using System.Linq;
using System.Text;
using System;

namespace CustomExtensions
{
    //Extension methods must be defined in a static class
    public static class StringExtension
    {
        // This is the extension method.
        // The first parameter takes the "this" modifier
        // and specifies the type for which the method is defined.
        public static int WordCount(this String str)
        {
            return str.Split(new char[] {' ', '.','?'}, 
                       StringSplitOptions.RemoveEmptyEntries).Length;
        }
    }
}
namespace Extension_Methods_Simple
{
    //Import the extension method namespace.
    using CustomExtensions;
    class Program
    {
        static void Main(string[] args)
        {
            string s = "Panamá tiene muchos lugares para visitar.";
            //  Call the method as if it were an 
            //  instance method on the type. Note that the first
            //  parameter is not specified by the calling code.
            int i = s.WordCount();
            System.Console.WriteLine("Cantidad de palabras de s " +
                                     "es {0}", i);
        }
    }
}

Para ejecutar este código, debe copiarlo y pegarlo en un proyecto de aplicación de consola de Visual C# creado en Visual Studio.De manera predeterminada, el proyecto tiene como destino la versión 4.0 de .NET Framework y contiene una referencia a System.Core.dll y una directiva using para System.Linq.

Seguridad

• Los métodos de extensión no presentan vulnerabilidades de seguridad concretas.
• No se pueden utilizar para suplantar los métodos existentes en un tipo, ya que todas las colisiones de nombre se resuelven a favor de la instancia o el método estático definido por el propio tipo.
• Los métodos de extensión no pueden obtener acceso a los datos privados de la clase extendida.