Métodos de extensão (Guia de Programação em C#)Extension Methods (C# Programming Guide)

Os métodos de extensão permitem que você "adicione" tipos existentes sem criar um novo tipo derivado, recompilar ou, caso contrário, modificar o tipo original.Extension methods enable you to "add" methods to existing types without creating a new derived type, recompiling, or otherwise modifying the original type. Os métodos de extensão são um tipo especial de método estático, mas são chamados como se fossem métodos de instância no tipo estendido.Extension methods are a special kind of static method, but they are called as if they were instance methods on the extended type. No caso do código cliente gravado em C#, F# e Visual Basic, não há nenhuma diferença aparente entre chamar um método de extensão e os métodos realmente definidos em um tipo.For client code written in C#, F# and Visual Basic, there is no apparent difference between calling an extension method and the methods that are actually defined in a type.

Os métodos de extensão mais comuns são os operadores de consulta padrão LINQLINQ que adicionam funcionalidade de consulta aos tipos System.Collections.IEnumerable e System.Collections.Generic.IEnumerable<T> existentes.The most common extension methods are the LINQLINQ standard query operators that add query functionality to the existing System.Collections.IEnumerable and System.Collections.Generic.IEnumerable<T> types. Para usar os operadores de consulta padrão, traga-os primeiro ao escopo com uma diretiva using System.Linq.To use the standard query operators, first bring them into scope with a using System.Linq directive. Em seguida, qualquer tipo que implemente IEnumerable<T> parece ter métodos de instância como GroupBy, OrderBy, Average e assim por diante.Then any type that implements IEnumerable<T> appears to have instance methods such as GroupBy, OrderBy, Average, and so on. Você pode exibir esses métodos adicionais no preenchimento de declaração do IntelliSense ao digitar "ponto" após uma instância de um tipo IEnumerable<T> como List<T> ou Array.You can see these additional methods in IntelliSense statement completion when you type "dot" after an instance of an IEnumerable<T> type such as List<T> or Array.

O exemplo a seguir mostra como chamar o método de consulta padrão OrderBy em qualquer matriz de inteiros.The following example shows how to call the standard query operator OrderBy method on an array of integers. A expressão entre parênteses é uma expressão lambda.The expression in parentheses is a lambda expression. Vários operadores de consulta padrão obtêm expressões lambda como parâmetros, mas isso não é um requisito para métodos de extensão.Many standard query operators take lambda expressions as parameters, but this is not a requirement for extension methods. Para obter mais informações, consulte Expressões Lambda.For more information, see Lambda Expressions.

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

Os métodos de extensão são definidos como estáticos, mas são chamados usando a sintaxe do método de instância.Extension methods are defined as static methods but are called by using instance method syntax. Seu primeiro parâmetro especifica em que tipo o método opera e o parâmetro é precedido pelo modificador this.Their first parameter specifies which type the method operates on, and the parameter is preceded by the this modifier. Os métodos de extensão só estarão no escopo quando você importar explicitamente o namespace para seu código-fonte com uma diretiva using.Extension methods are only in scope when you explicitly import the namespace into your source code with a using directive.

O exemplo a seguir mostra um método de extensão definido para a classe System.String.The following example shows an extension method defined for the System.String class. Observe que isso é definido em uma classe estática não aninhada e não genérica:Note that it is defined inside a non-nested, non-generic static class:

namespace ExtensionMethods
{
    public static class MyExtensions
    {
        public static int WordCount(this String str)
        {
            return str.Split(new char[] { ' ', '.', '?' }, 
                             StringSplitOptions.RemoveEmptyEntries).Length;
        }
    }   
}

O método de extensão WordCount pode ser colocado no escopo com esta diretiva using:The WordCount extension method can be brought into scope with this using directive:

using ExtensionMethods;  

E pode ser chamado a partir de um aplicativo usando esta sintaxe:And it can be called from an application by using this syntax:

string s = "Hello Extension Methods";  
int i = s.WordCount();  

Em seu código, você chama o método de extensão com sintaxe de método de instância.In your code you invoke the extension method with instance method syntax. No entanto, a linguagem intermediária (IL) gerada pelo compilador converte seu código em uma chamada no método estático.However, the intermediate language (IL) generated by the compiler translates your code into a call on the static method. Portanto, o princípio de encapsulamento ainda não está realmente sendo violado.Therefore, the principle of encapsulation is not really being violated. De fato, os métodos de extensão não podem acessar variáveis particulares no tipo que estão estendendo.In fact, extension methods cannot access private variables in the type they are extending.

Para obter mais informações, consulte Como implementar e chamar um método de extensão personalizado.For more information, see How to: Implement and Call a Custom Extension Method.

Em geral, provavelmente você chamará métodos de extensão com muito mais frequência do que implementará os seus próprios.In general, you will probably be calling extension methods far more often than implementing your own. Como os métodos de extensão são chamados com a sintaxe do método de instância, nenhum conhecimento especial é necessário para usá-los no código do cliente.Because extension methods are called by using instance method syntax, no special knowledge is required to use them from client code. Para habilitar métodos de extensão para um tipo específico, apenas adicione uma diretiva using para o namespace no qual os métodos estão definidos.To enable extension methods for a particular type, just add a using directive for the namespace in which the methods are defined. Por exemplo, para usar os operadores de consulta padrão, adicione esta diretiva using ao seu código:For example, to use the standard query operators, add this using directive to your code:

using System.Linq;  

(Também pode ser necessário adicionar uma referência a System.Core.dll.) Você observará que os operadores de consulta padrão agora são exibidos no IntelliSense como métodos adicionais disponíveis para a maioria dos tipos IEnumerable<T>.(You may also have to add a reference to System.Core.dll.) You will notice that the standard query operators now appear in IntelliSense as additional methods available for most IEnumerable<T> types.

Associando Métodos de Extensão no Momento da CompilaçãoBinding Extension Methods at Compile Time

Você pode usar métodos de extensão para estender uma classe ou interface, mas não os substituir.You can use extension methods to extend a class or interface, but not to override them. Um método de extensão com o mesmo nome e assinatura que um método de interface ou classe nunca será chamado.An extension method with the same name and signature as an interface or class method will never be called. No tempo de compilação, os métodos de extensão sempre têm menos prioridade que os métodos de instância definidos no próprio tipo.At compile time, extension methods always have lower priority than instance methods defined in the type itself. Em outras palavras, se um tipo possuir um método chamado Process(int i) e se você tiver um método de extensão com a mesma assinatura, o compilador sempre se associará ao método de instância.In other words, if a type has a method named Process(int i), and you have an extension method with the same signature, the compiler will always bind to the instance method. Quando o compilador encontra uma invocação de método, primeiro ele procura uma correspondência nos métodos de instância do tipo.When the compiler encounters a method invocation, it first looks for a match in the type's instance methods. Se nenhuma correspondência for encontrada, ele irá procurar todos os métodos de extensão definidos para o tipo e associará o primeiro método de extensão que encontrar.If no match is found, it will search for any extension methods that are defined for the type, and bind to the first extension method that it finds. O exemplo a seguir demonstra como o compilador determina a qual método de extensão ou método de instância associar.The following example demonstrates how the compiler determines which extension method or instance method to bind to.

ExemploExample

O exemplo a seguir demonstra as regras que o compilador C# segue ao determinar se deve associar uma chamada de método a um método de instância no tipo ou a um método de extensão.The following example demonstrates the rules that the C# compiler follows in determining whether to bind a method call to an instance method on the type, or to an extension method. A classe estática Extensions contém métodos de extensão definidos para qualquer tipo que implementa IMyInterface.The static class Extensions contains extension methods defined for any type that implements IMyInterface. As classes A, B e C implementam a interface.Classes A, B, and C all implement the interface.

O método de extensão MethodB nunca é chamado porque seu nome e assinatura são exatamente iguais aos métodos já implementados pelas classes.The MethodB extension method is never called because its name and signature exactly match methods already implemented by the classes.

Quando o compilador não consegue localizar um método de instância com uma assinatura compatível, ele se associa a um método de extensão correspondente se houver.When the compiler cannot find an instance method with a matching signature, it will bind to a matching extension method if one exists.

// 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(IMyInterface, int)
            a.MethodA("hello");     // Extension.MethodA(IMyInterface, 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(IMyInterface, 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()
 */

Diretrizes geraisGeneral Guidelines

Em geral, recomendamos que você implemente métodos de extensão com parcimônia e somente quando for necessário.In general, we recommend that you implement extension methods sparingly and only when you have to. Sempre que possível, o código do cliente que deve estender um tipo existente deve fazer isso ao criar um novo tipo derivado do tipo existente.Whenever possible, client code that must extend an existing type should do so by creating a new type derived from the existing type. Para obter mais informações, consulte Herança.For more information, see Inheritance.

Ao usar um método de extensão para estender um tipo cujo código-fonte você não pode alterar, há o risco de uma alteração na implementação do tipo fazer com que o método de extensão interrompa.When using an extension method to extend a type whose source code you cannot change, you run the risk that a change in the implementation of the type will cause your extension method to break.

Se você implementar métodos de extensão para um determinado tipo, lembre-se das seguintes considerações:If you do implement extension methods for a given type, remember the following points:

  • Um método de extensão nunca será chamado se possuir a mesma assinatura que um método definido no tipo.An extension method will never be called if it has the same signature as a method defined in the type.

  • Os métodos de extensão são trazidos para o escopo no nível do namespace.Extension methods are brought into scope at the namespace level. Por exemplo, se você tiver várias classes estáticas que contenham métodos de extensão em um único namespace chamado Extensions, todos eles serão trazidos para o escopo pela diretiva using Extensions;.For example, if you have multiple static classes that contain extension methods in a single namespace named Extensions, they will all be brought into scope by the using Extensions; directive.

Para uma biblioteca de classes que você implemente, não use métodos de extensão para evitar incrementar o número de versão de um assembly.For a class library that you implemented, you shouldn't use extension methods to avoid incrementing the version number of an assembly. Se desejar adicionar funcionalidade significativa a uma biblioteca da qual você possua o código-fonte, siga as diretrizes padrão do .NET Framework para controle de versão do assembly.If you want to add significant functionality to a library for which you own the source code, you should follow the standard .NET Framework guidelines for assembly versioning. Para obter mais informações, consulte Controle de versão do assembly.For more information, see Assembly Versioning.

Consulte tambémSee Also