Методы расширения (Руководство по программированию в C#)Extension Methods (C# Programming Guide)

Методы расширения позволяют "добавлять" методы в существующие типы без создания нового производного типа, перекомпиляции и иного изменения первоначального типа.Extension methods enable you to "add" methods to existing types without creating a new derived type, recompiling, or otherwise modifying the original type. Методы расширения представляют собой особую разновидность статического метода, но вызываются так же, как методы экземпляра в расширенном типе.Extension methods are a special kind of static method, but they are called as if they were instance methods on the extended type. Для клиентского кода, написанного на языках C#, F# и Visual Basic, нет видимого различия между вызовом метода расширения и вызовом методов, фактически определенных в типе.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.

Самые обычные методы расширения — стандартные операторы запросов LINQLINQ, которые добавляют функции запросов в существующие типы System.Collections.IEnumerable и System.Collections.Generic.IEnumerable<T>.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. Для использования стандартных операторов запросов их необходимо ввести в область действия с помощью директивы using System.Linq.To use the standard query operators, first bring them into scope with a using System.Linq directive. Тогда каждый тип, реализующий тип IEnumerable<T>, будет иметь методы экземпляра, в частности GroupBy, OrderBy, Average и т. д.Then any type that implements IEnumerable<T> appears to have instance methods such as GroupBy, OrderBy, Average, and so on. Эти дополнительные методы можно видеть в завершении операторов IntelliSense при вводе точки после экземпляра типа IEnumerable<T>, например List<T> или 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.

В следующем примере показано, как вызывать метод стандартного оператора запроса OrderBy для массива целых чисел.The following example shows how to call the standard query operator OrderBy method on an array of integers. Выражение в скобках называется лямбда-выражением.The expression in parentheses is a lambda expression. Многие стандартные операторы запроса принимают лямбда-выражения в качестве параметров, но это необязательно для методов расширения.Many standard query operators take lambda expressions as parameters, but this is not a requirement for extension methods. Дополнительные сведения см. в разделе Лямбда-выражения.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

Методы расширения определяются как статические методы, но вызываются с помощью синтаксиса обращения к методу экземпляра.Extension methods are defined as static methods but are called by using instance method syntax. Их первый параметр определяет, с каким типом оперирует метод, и параметру предшествует модификатор this.Their first parameter specifies which type the method operates on, and the parameter is preceded by the this modifier. Методы расширения находятся в области действия, только если пространство имен было явно импортировано в исходный код с помощью директивы using.Extension methods are only in scope when you explicitly import the namespace into your source code with a using directive.

В приведенном ниже примере показан метод расширения, определенный для класса System.String.The following example shows an extension method defined for the System.String class. Обратите внимание, что этот метод определяется внутри невложенного, неуниверсального статического класса.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;
        }
    }   
}

Метод расширения WordCount можно ввести в область действия с помощью следующей директивы using:The WordCount extension method can be brought into scope with this using directive:

using ExtensionMethods;  

Его можно вызвать из приложения с помощью следующего синтаксиса:And it can be called from an application by using this syntax:

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

В созданном коде метод расширения вызывается с помощью синтаксиса обращения к методу экземпляра.In your code you invoke the extension method with instance method syntax. Однако промежуточный язык (IL), создаваемый компилятором, преобразует код в вызов статического метода.However, the intermediate language (IL) generated by the compiler translates your code into a call on the static method. Поэтому принцип инкапсуляции фактически не нарушается.Therefore, the principle of encapsulation is not really being violated. Фактически, методы расширения не могут получать доступ к частным переменным типа, для расширения которого они используются.In fact, extension methods cannot access private variables in the type they are extending.

Дополнительные сведения см. в разделе Практическое руководство. Реализация и вызов пользовательского метода расширения.For more information, see How to: Implement and Call a Custom Extension Method.

Вообще, обычно гораздо чаще вызываются методы расширения, чем реализуются собственные методы.In general, you will probably be calling extension methods far more often than implementing your own. Так как методы расширения вызываются с помощью синтаксиса обращения к методу экземпляра, для использования их из клиентского кода специальные знания не требуются.Because extension methods are called by using instance method syntax, no special knowledge is required to use them from client code. Чтобы включить методы расширения для определенного типа, необходимо просто добавить директиву using для пространства имен, в котором эти методы определяются.To enable extension methods for a particular type, just add a using directive for the namespace in which the methods are defined. Например, чтобы использовать стандартные операторы запроса, нужно добавить в код следующую директиву using:For example, to use the standard query operators, add this using directive to your code:

using System.Linq;  

(Также может потребоваться добавить ссылку на библиотеку System.Core.dll.) Обратите внимание, что стандартные операторы запроса теперь появляются в IntelliSense в виде дополнительных методов, доступных для большинства типов 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.

Примечание

Хотя стандартные операторы запросов не появляются в IntelliSense для типа String, они все равно доступны.Although standard query operators do not appear in IntelliSense for String, they are still available.

Привязка методов расширения во время компиляцииBinding Extension Methods at Compile Time

Методы расширения можно использовать для расширения класса или интерфейса, но не для их переопределения.You can use extension methods to extend a class or interface, but not to override them. Метод расширения, имеющий те же имя и сигнатуру, что и интерфейс или метод класса, никогда не вызывается.An extension method with the same name and signature as an interface or class method will never be called. Во время компиляции методы расширения всегда имеют более низкий приоритет, чем методы экземпляра, определенные в самом типе.At compile time, extension methods always have lower priority than instance methods defined in the type itself. Другими словами, если тип имеет метод Process(int i), а также есть метод расширения с такой же сигнатурой, компилятор будет всегда выполнять привязку к методу экземпляра.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. Если компилятор обнаруживает вызов метода, он сначала ищет совпадения с методами экземпляра типа.When the compiler encounters a method invocation, it first looks for a match in the type's instance methods. Если такое совпадение не найдено, компилятор выполняет поиск методов расширения, определенных для соответствующего типа, и создает привязку к первому обнаруженному методу расширения.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. В следующем примере кода демонстрируется, как компилятор определяет, к какому методу расширения или методу экземпляра необходимо выполнить привязку.The following example demonstrates how the compiler determines which extension method or instance method to bind to.

ПримерExample

В следующем примере демонстрируются правила, которые компилятор C# соблюдает при определении того, к чему необходимо привязать вызов метода — к методу экземпляра типа или к методу расширения.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. Статический класс Extensions содержит методы расширения, определяемые для любого типа, реализующего интерфейс IMyInterface.The static class Extensions contains extension methods defined for any type that implements IMyInterface. Все три класса — A, B и C — реализуют этот интерфейс.Classes A, B, and C all implement the interface.

Метод расширения MethodB никогда не вызывается, потому что его имя и сигнатура точно совпадают с методами, уже реализованными этими классами.The MethodB extension method is never called because its name and signature exactly match methods already implemented by the classes.

Если компилятор не может найти метод экземпляра с совпадающей сигнатурой, он выполняет привязку к совпадающему методу расширения, если такой существует.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()
 */

Общие рекомендацииGeneral Guidelines

В общем, методы расширения рекомендуется реализовывать в ограниченном количестве и только при необходимости.In general, we recommend that you implement extension methods sparingly and only when you have to. Когда это возможно, клиентский код, служащий для расширения существующего типа, должен осуществлять расширение путем создания нового типа, производного от существующего.Whenever possible, client code that must extend an existing type should do so by creating a new type derived from the existing type. Дополнительные сведения см. в разделе Наследование.For more information, see Inheritance.

При использовании метода расширения для расширения типа, исходный код которого невозможно изменить, возникает риск того, что изменение в реализации типа вызовет сбой метода расширения.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.

В случае реализации методов расширения для какого-либо типа необходимо помнить о следующих фактах:If you do implement extension methods for a given type, remember the following points:

  • Метод расширения никогда не будет вызван, если он имеет ту же сигнатуру, что и метод, определенный в типе.An extension method will never be called if it has the same signature as a method defined in the type.

  • Методы расширения вводятся в область действия на уровне пространства имен.Extension methods are brought into scope at the namespace level. Например, при наличии нескольких статических классов, содержащих методы расширения в единственном пространстве имен с именем Extensions, все они будут введены в область действия директивой 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.

Для реализованной библиотеки классов не следует использовать методы расширения во избежание увеличения номера версии сборки.For a class library that you implemented, you shouldn't use extension methods to avoid incrementing the version number of an assembly. Если требуется добавить значительную функциональность в библиотеку, владельцем исходного кода которой вы являетесь, необходимо соблюдать стандартные правила .NET Framework по управлению версиями сборок.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. Дополнительные сведения см. в разделе Версии сборок.For more information, see Assembly Versioning.

См. такжеSee Also

Руководство по программированию на C#C# Programming Guide
Parallel Programming Samples (Образцы параллельного программирования, включают множество примеров методов расширения)Parallel Programming Samples (these include many example extension methods)
Лямбда-выраженияLambda Expressions
Общие сведения о стандартных операторах запросаStandard Query Operators Overview
Conversion Rules for Instance Parameters and their Impact (Правила преобразования для параметров экземпляра и их влияние)Conversion rules for Instance parameters and their impact
Extension Methods Interoperability between Languages (Взаимодействие между языками с помощью методов расширения)Extension methods Interoperability between languages
Extension Methods and Curried Delegates (Методы расширения и каррированные делегаты)Extension methods and Curried Delegates
Extension method Binding and Error reportingExtension method Binding and Error reporting