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

Статья
03/12/2013

Метода расширения позволяют "добавлять" методы в существующие типы без создания нового производного типа, перекомпиляции или иного изменения исходного типа.Методы расширения являются особым видом статического метода, но они вызываются, как если бы они были методами экземпляра в расширенном типе.Для клиентского кода, написанного на языках C# и Visual Basic, нет видимого различия между вызовом метода расширения и вызовом методов, фактически определенных в типе.

Наиболее распространенные методы расширения стандартных операторов запросов LINQ, которые используют функцию запроса на существующие типы System.Collections.IEnumerable и System.Collections.Generic.IEnumerable<T>. Для использования стандартных операторов запросов необходимо вернуть их в область с помощью директивы using System.Linq.Затем каждый тип, который реализует тип IEnumerable<T>, будет иметь методы экземпляра, такие как GroupBy, OrderBy, Average и т.д.Эти дополнительные методы можно видеть в завершении операторов IntelliSense, когда вводится точка после экземпляра типа IEnumerable<T>, например List<T> или Array.

В следующем примере показано, как вызывать метод стандартного оператора запроса OrderBy для массива целых чисел.Выражение в скобках называется лямбда-выражением.Многие стандартные операторы запроса принимают лямбда-выражения в качестве параметров, но это не является обязательным для методов расширения.Дополнительные сведения см. в разделе Лямбда-выражения (Руководство по программированию в 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

Методы расширения определяются как статические методы, но вызываются с помощью синтаксиса обращения к методу экземпляра.Их первый параметр определяет, с каким типом оперирует метод, и перед параметром идет модификатор this.Методы расширения находятся в области действия, только если пространство имен было явно импортировано в исходный код с помощью директивы using.

В приведенном ниже примере показан метод расширения, определяемый для класса System.String.Обратите внимание, что этот метод определяется внутри не вложенного, не универсального статического класса.

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

Метод расширения WordCount может быть добавлен в область действия с помощью директивы using.

using ExtensionMethods;

И он может вызываться из приложения с помощью следующего синтаксиса.

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

В созданном коде метод расширения вызывается с помощью синтаксиса обращения к метода экземпляра.Однако промежуточный язык (IL), генерируемый компилятором, переводит созданный код в вызов статического метода.Поэтому принцип инкапсуляции фактически не нарушается.В действительности, методы расширения не могут получить доступ к закрытым переменным типа, для расширения которого они используются.

Для получения дополнительной информации см. Практическое руководство. Реализация и вызов пользовательского метода расширения (Руководство по программированию в C#).

Вообще, обычно гораздо чаще приходится вызывать методы расширения, чем реализовывать собственные методы.Так как методы расширения вызываются с помощью синтаксиса обращения к методу экземпляра, для использования их из клиентского кода специальные знания не требуются.Чтобы включить методы расширения для определенного типа необходимо просто добавить директиву using для пространства имен, в котором эти методы определяются.Например, чтобы использовать стандартные операторы запроса, необходимо добавить директиву using в создаваемый код.

using System.Linq;

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

Примечание
Хотя стандартные операторы запросов не появляются в списке IntelliSense для типа String, они все равно доступны.

Привязка методов расширения во время компиляции

Методы расширения можно использовать для расширения класса или интерфейса, но не для их переопределения.Метод расширения, имеющий то же имя и сигнатуру, что и интерфейс или метод класса, никогда не вызывается.Во время компиляции методы расширения всегда имеют более низкий приоритет, чем методы экземпляра, определенные в самом типе.Другими словами, если тип имеет метод Process(int i), а также есть метод расширения с такой же сигнатурой, компилятор будет всегда выполнять привязку к методу экземпляра.Если компилятор обнаруживает вызов метода, то сначала выполняется поиск совпадения с методами экземпляра типа.Если такое совпадение не найдено, компилятор выполняет поиск методов расширения, определенных для соответствующего типа, и делает привязку к первому найденному методу расширения.В следующем примере кода демонстрируется, как компилятор определяет, к какому методу расширения или методу экземпляра необходимо выполнить привязку.

Пример

В следующем примере демонстрируются правила, которые компилятор C# соблюдает при определении того, к чему необходимо привязать вызов метода — к методу экземпляра типа или к методу расширения.Статический класс Extensions содержит методы расширения, определяемые для любого типа, реализующего интерфейс IMyInterface.Все три класса — A, B и C — реализуют этот интерфейс.

Метод расширения MethodB никогда не вызывается, потому что его имя и сигнатура точно совпадают с методами, уже реализованными этими классами.

Когда компилятор не может найти метод экземпляра с совпадающей сигнатурой, он выполняет привязку к совпадающему методу расширения, если такой существует.

// 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()
 */

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

В общем, рекомендуется реализовывать методы расширения ограниченно, только когда это необходимо.Когда это возможно, клиентский код, который используется для расширения существующего типа, должен осуществлять расширение путем создания нового типа, производного от существующего.Для получения дополнительной информации см. Наследование (Руководство по программированию на C#).

При использовании метода расширения для расширения типа, исходный код которого невозможно изменить, возникает риск того, что изменение в реализации типа вызовет сбой метода расширения.

При реализации методов расширения для заданного типа следует помнить followingpoints:

Метод расширения никогда не будет вызван, если он имеет ту же самую сигнатуру, что и метод, определенный в типе.
Методы расширения добавляются в область действия на уровне пространства имен.Например, при наличии нескольких статических классов, которые содержат методы расширения в единственном пространстве имен с названием Extensions, все они будут добавлены в область действия директивной using Extensions;.

Для библиотеки классов, которая будет реализован, не следует использовать методы расширения, чтобы избежать увеличить номер версии сборки.Если необходимо добавить важные функции в библиотеку, для которой имеется исходный код, необходимо выполнить стандартные правила .NET Framework для управления версиями сборок.Дополнительные сведения см. в разделе Управление версиями сборок.

См. также

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

Привязка методов расширения во время компиляции

Пример

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

См. также

Ссылки

Основные понятия

Другие ресурсы

Дополнительные ресурсы