Методы расширения (Руководство по программированию в 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 static methods, but they're 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's no apparent difference between calling an extension method and the methods defined in a type.

Самые распространенные методы расширения — стандартные операторы запросов LINQ, которые добавляют функции запросов в существующие типы System.Collections.IEnumerable и System.Collections.Generic.IEnumerable<T>.The most common extension methods are the LINQ 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.

Пример OrderByOrderBy Example

В следующем примере показано, как вызывать метод стандартного оператора запроса 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 isn't 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. Их первый параметр определяет, с каким типом оперирует метод.Their first parameter specifies which type the method operates on. Параметру предшествует модификатор this.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. Этот метод определяется внутри невложенного, неуниверсального статического класса:It's 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();

В созданном коде метод расширения вызывается с помощью синтаксиса обращения к методу экземпляра.You invoke the extension method in your code with instance method syntax. Промежуточный язык (IL), создаваемый компилятором, преобразует код в вызов статического метода.The intermediate language (IL) generated by the compiler translates your code into a call on the static method. Принцип инкапсуляции фактически не нарушается.The principle of encapsulation is not really being violated. Методы расширения не могут получать доступ к частным переменным типа, для расширения которого они используются.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'll 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'll notice that the standard query operators now appear in IntelliSense as additional methods available for most IEnumerable<T> types.

Привязка методов расширения во время компиляции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 can't 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()
 */

Общие варианты использованияCommon Usage Patterns

Функциональные возможности коллекцийCollection Functionality

В прошлом было распространено создание классов коллекций, которые реализовали интерфейс System.Collections.Generic.IEnumerable<T> для данного типа и содержали функциональные возможности, действующие на коллекции этого типа.In the past, it was common to create "Collection Classes" that implemented the System.Collections.Generic.IEnumerable<T> interface for a given type and contained functionality that acted on collections of that type. Хотя в создании этого типа объекта коллекции нет ничего плохого, те же функциональные возможности можно получить, используя расширение System.Collections.Generic.IEnumerable<T>.While there's nothing wrong with creating this type of collection object, the same functionality can be achieved by using an extension on the System.Collections.Generic.IEnumerable<T>. Преимущество расширений заключается в том, что они позволяют вызывать функциональные возможности из любой коллекции, например System.Array или System.Collections.Generic.List<T>, которая реализует System.Collections.Generic.IEnumerable<T> для этого типа.Extensions have the advantage of allowing the functionality to be called from any collection such as an System.Array or System.Collections.Generic.List<T> that implements System.Collections.Generic.IEnumerable<T> on that type. Пример использования массива Int32 описан ранее в этой статье.An example of this using an Array of Int32 can be found earlier in this article.

Функциональные возможности конкретного слояLayer-Specific Functionality

При использовании многослойной архитектуры или другой многослойной модели приложения обычно используется набор сущностей предметной области или объектов передачи данных, которые можно использовать для обмена данными между границами приложений.When using an Onion Architecture or other layered application design, it's common to have a set of Domain Entities or Data Transfer Objects that can be used to communicate across application boundaries. Обычно эти объекты содержат только минимальные функциональные возможности (или вовсе их не содержат), применимые ко всем слоям приложения.These objects generally contain no functionality, or only minimal functionality that applies to all layers of the application. Методы расширения можно использовать, чтобы добавить функциональные возможности для каждого конкретного слоя приложения без загрузки объекта с помощью методов, которые не нужны или не требуются для других слоев.Extension methods can be used to add functionality that is specific to each application layer without loading the object down with methods not needed or wanted in other layers.

public class DomainEntity
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

static class DomainEntityExtensions
{
    static string FullName(this DomainEntity value)
        => $"{value.FirstName} {value.LastName}";
}

Расширение предопределенных типовExtending Predefined Types

Если необходимо создать многократно используемые функциональные возможности, вы можете расширить существующий тип, например .NET Framework или тип CLR, чтобы не создавать дополнительные объекты.Rather than creating new objects when reusable functionality needs to be created, we can often extend an existing type such as a .NET Framework or CLR type. Например, если методы расширения не используются, можно создать класс Engine или Query, чтобы выполнить запрос к SQL Server, который можно вызвать из нескольких расположений в коде.As an example, if we don't use extension methods, we might create an Engine or Query class to do the work of executing a query on a SQL Server that may be called from multiple places in our code. Однако вместо этого можно расширить класс System.Data.SqlClient.SqlConnection с помощью методов расширения, чтобы выполнить этот запрос из любого расположения, где установлено подключение с SQL Server.However we can instead extend the System.Data.SqlClient.SqlConnection class using extension methods to perform that query from anywhere we have a connection to a SQL Server. В качестве второго примера можно привести добавление общих функциональных возможностей в класс System.String, расширение возможностей обработки данных объектов System.IO.File и System.IO.Stream, а также объектов System.Exception для функциональных возможностей обработки конкретных ошибок.Other examples might be to add common functionality to the System.String class, extend the data processing capabilities of the System.IO.File and System.IO.Stream objects, and System.Exception objects for specific error handling functionality. Сценарии использования ограничиваются только воображением и здравым смыслом.These types of use-cases are limited only by your imagination and good sense.

Расширение предопределенных типов с помощью типов struct может быть сложным, так как они передаются методам по значению.Extending predefined types can be difficult with struct types because they're passed by value to methods. Это означает, что любые изменения структуры вносятся в ее копию.That means any changes to the struct are made to a copy of the struct. Эти изменения не отображаются после выхода из метода расширения.Those changes aren't visible once the extension method exits. Начиная с C# 7.2, вы можете добавить модификатор ref к первому аргументу метода расширения.Beginning with C# 7.2, you can add the ref modifier to the first argument of an extension method. Добавление модификатора ref означает, что первый аргумент передается по ссылке.Adding the ref modifier means the first argument is passed by reference. Это позволяет создавать методы расширения, изменяющие состояние расширяемой структуры.This enables you to write extension methods that change the state of the struct being extended.

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

Хотя по-прежнему предпочтительнее добавлять функциональные возможности путем изменения кода объекта или создания производного типа, когда это целесообразно и возможно, методы расширения стали ключевым вариантом для создания многократно используемых функциональных возможностей во всей экосистеме .NET.While it's still considered preferable to add functionality by modifying an object's code or deriving a new type whenever it's reasonable and possible to do so, extension methods have become a crucial option for creating reusable functionality throughout the .NET ecosystem. Методы расширения также являются отличным выбором, если вы не управляете исходным источником, если производный объект недопустим или невозможен или если функциональные возможности должны быть недоступными за пределами применимой области.For those occasions when the original source isn't under your control, when a derived object is inappropriate or impossible, or when the functionality shouldn't be exposed beyond its applicable scope, Extension methods are an excellent choice.

Дополнительные сведения о производных типах см. в статье Наследование (Руководство по программированию на C#).For more information on derived types, see Inheritance.

При использовании метода расширения для расширения типа, исходный код которого невозможно изменить, возникает риск того, что изменение в реализации типа вызовет сбой метода расширения.When using an extension method to extend a type whose source code you aren't in control of, 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'll 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