Métodos de extensión (Guía de programación de C#)
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 a System.Collections.IEnumerable y a los tipos existentes de System.Collections.Generic.IEnumerable<T>. Para usar los operadores de consulta estándar, primero tráigalos en el ámbito con una directiva de 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 una matriz 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 obtener más información, vea Expresiones lambda (Guía de programación de C#).
class ExtensionMethods2
{
static void Main()
{
int[] ints = { 10, 45, 15, 39, 21, 26 };
var result = ints.OrderBy(g => g);
foreach (var i in result)
{
System.Console.Write(i + " ");
}
}
}
//Output: 10 15 21 26 39 45
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:
namespace ExtensionMethods
{
public static class MyExtensions
{
public static int WordCount(this String str)
{
return str.Split(new char[] { ' ', '.', '?' },
StringSplitOptions.RemoveEmptyEntries).Length;
}
}
}
El método de extensión WordCount se puede incluir en el ámbito con esta directiva using:
using ExtensionMethods;
También se puede llamar desde una aplicación con esta sintaxis:
string s = "Hello Extension Methods";
int i = s.WordCount();
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.
Para obtener más información, vea Cómo: Implementar e invocar un método de extensión personalizado (Guía de programación de C#).
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;
(Puede que tenga que agregar también una referencia a System.Core.dll.) Observará que los operadores de consulta estándar ahora aparecen en IntelliSense como métodos adicionales disponibles para la mayoría de los tipos IEnumerable<T>.
[!NOTA]
Aunque no aparezcan operadores de consulta estándar en IntelliSense para String, siguen estando disponibles.
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.
Ejemplo
En el ejemplo siguiente se muestran las reglas que sigue el compilador de C# para determinar si debe establecer un enlace entre una llamada a método y un método de instancia del tipo o 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.
// Define an interface named IMyInterface.
namespace DefineIMyInterface
{
using System;
public interface IMyInterface
{
// Any class that implements IMyInterface must define a method
// that matches the following signature.
void MethodB();
}
}
// Define extension methods for IMyInterface.
namespace Extensions
{
using System;
using DefineIMyInterface;
// The following extension methods can be accessed by instances of any
// class that implements 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)");
}
// This method is never called in ExtensionMethodsDemo1, because each
// of the three classes A, B, and C implements a method named MethodB
// that has a matching signature.
public static void MethodB(this IMyInterface myInterface)
{
Console.WriteLine
("Extension.MethodB(this IMyInterface myInterface)");
}
}
}
// Define three classes that implement IMyInterface, and then use them to test
// the extension methods.
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)
{
// Declare an instance of class A, class B, and class C.
A a = new A();
B b = new B();
C c = new C();
// For a, b, and c, call the following methods:
// -- MethodA with an int argument
// -- MethodA with a string argument
// -- MethodB with no argument.
// A contains no MethodA, so each call to MethodA resolves to
// the extension method that has a matching signature.
a.MethodA(1); // Extension.MethodA(object, int)
a.MethodA("hello"); // Extension.MethodA(object, string)
// A has a method that matches the signature of the following call
// to MethodB.
a.MethodB(); // A.MethodB()
// B has methods that match the signatures of the following
// method calls.
b.MethodA(1); // B.MethodA(int)
b.MethodB(); // B.MethodB()
// B has no matching method for the following call, but
// class Extension does.
b.MethodA("hello"); // Extension.MethodA(object, string)
// C contains an instance method that matches each of the following
// method calls.
c.MethodA(1); // C.MethodA(object)
c.MethodA("hello"); // C.MethodA(object)
c.MethodB(); // C.MethodB()
}
}
}
/* Output:
Extension.MethodA(this IMyInterface myInterface, int i)
Extension.MethodA(this IMyInterface myInterface, string s)
A.MethodB()
B.MethodA(int i)
B.MethodB()
Extension.MethodA(this IMyInterface myInterface, string s)
C.MethodA(object obj)
C.MethodA(object obj)
C.MethodB()
*/
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 (Guía de programación de C#).
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 los métodos de extensión para un tipo determinado, recuerde los followingpoints:
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.
Para una biblioteca de clases que implementó, no debería utilizar métodos de extensión para evitar aumentar el número de versión de un ensamblado.Si desea agregar funcionalidad significativa a una biblioteca que se posee el código fuente, debe seguir las instrucciones estándar de .NET Framework para la versión del ensamblado.Para obtener más información, vea Versiones de los ensamblados.
Vea también
Referencia
Expresiones lambda (Guía de programación de C#)
Conceptos
Información general sobre operadores de consulta estándar
Otros recursos
Parámetros de las reglas de conversión como y su impacto
Interoperabilidad de los métodos de extensión entre los lenguajes