Язык программирования C#9 и платформа .NET5 - Эндрю Троелсен

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

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

За счет применения расширяющих методов появляется возможность модифицировать типы, не создавая подклассов и не изменяя код типа напрямую. Загвоздка в том, что новая функциональность предлагается типом, только если в текущем проекте будут присутствовать ссылки на расширяющие методы.

Определение расширяющих методов

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

В целях иллюстрации создайте новый проект консольного приложения под названием ExtensionMethods. Предположим, что создается класс по имени МуExtensions, в котором определены два расширяющих метода. Первый расширяющий метод позволяет объекту любого типа взаимодействовать с новым методом DisplayDefiningAssembly(), который использует типы из пространства имен System.Reflection для отображения имени сборки, содержащей данный тип.

На заметку! API-интерфейс рефлексии формально рассматривается в главе 17. Если эта тема для вас нова, тогда просто запомните, что рефлексия позволяет исследовать структуру сборок, типов и членов типов во время выполнения.

Второй расширяющий метод по имени ReverseDigits() позволяет любому значению типа int получить новую версию самого себя с обратным порядком следования цифр. Например, если целочисленное значение 1234 вызывает ReverseDigits(), то в результате возвратится 4321. Взгляните на следующую реализацию класса (не забудьте импортировать пространство имен System.Reflection):

using System;

using System.Reflection;

namespace MyExtensionMethods

{

  static class MyExtensions

  {

    // Этот метод позволяет объекту любого типа

    // отобразить сборку, в которой он определен

    public static void DisplayDefiningAssembly(this object obj)

    {

      Console.WriteLine("{0} lives here: => {1}n",

        obj.GetType().Name,

        Assembly.GetAssembly(obj.GetType()).GetName().Name);

    }

    // Этот метод позволяет любому целочисленному значению изменить

    // порядок следования десятичных цифр на обратный.

    // Например, для 56 возвратится 65.

    public static int ReverseDigits(this int i)

    {

      // Транслировать int в string и затем получить все его символы.

      char[] digits = i.ToString().ToCharArray();

      // Изменить порядок следования элементов массива.

      Array.Reverse(digits);

      // Поместить обратно в строку.

      string newDigits = new string(digits);

      // Возвратить модифицированную строку как int.

      return int.Parse(newDigits);

    }

  }

}

Снова обратите внимание на то, что первый параметр каждого расширяющего метода снабжен ключевым словом this, находящимся перед определением типа параметра. Первый параметр расширяющего метода всегда представляет расширяемый тип. Учитывая, что метод DisplayDefiningAssembly() был прототипирован для расширения System.Object, этот новый член теперь присутствует в каждом типе, поскольку Object является родительским для всех типов платформы .NET Core. Однако метод ReverseDigits() прототипирован для расширения только целочисленных типов, и потому если к нему обращается какое-то другое значение, то возникнет ошибка на этапе компиляции.

На заметку! Запомните, что каждый расширяющий метод может иметь множество параметров, но только первый параметр разрешено помечать посредством this. Дополнительные параметры будут трактоваться как нормальные входные параметры, применяемые методом.

Вызов расширяющих методов

Располагая созданными расширяющими методами, рассмотрим следующий код, в котором они используются с разнообразными типами из библиотек базовых классов:

using System;

using MyExtensionMethods;

Console.WriteLine("***** Fun with Extension Methods *****n");

//  В int появилась новая отличительная черта!

int myInt = 12345678;

myInt.DisplayDefiningAssembly();

//  И в SoundPlayer!

System.Data.DataSet d = new System.Data.DataSet();

d.DisplayDefiningAssembly();

// Использовать новую функциональность int.

Console.WriteLine("Value of myInt: {0}", myInt);

Console.WriteLine("Reversed digits of myInt: {0}",

  myInt.ReverseDigits());

Console.ReadLine();

Ниже показан вывод:

***** Fun with Extension Methods *****

Int32 lives here: => System.Private.CoreLib

DataSet lives here: => System.Data.Common

Value of myInt: 12345678

Reversed digits of myInt: 87654321 

Импортирование расширяющих методов

Когда определяется класс, содержащий расширяющие методы, он вне всяких сомнений будет принадлежать какому-то пространству имен. Если это пространство имен отличается от пространства имен, где расширяющие методы применяются, тогда придется использовать ключевое слово using языка С#, которое позволит файлу кода иметь доступ ко всем расширяющим методам интересующего типа. Об этом важно помнить, потому что если явно не импортировать корректное пространство имен, то в таком файле кода C# расширяющие методы будут недоступными.

Хотя на первый взгляд может показаться, что расширяющие методы глобальны по своей природе, на самом деле они ограничены пространствами имен, где определены, или пространствами имен, которые их импортируют. Вспомните, что вы поместили класс MyExtensions в пространство имен MyExtensionMethods, как показано ниже:

namespace MyExtensionMethods

{

  static class MyExtensions

  {

    ...

  }

}

Для использования расширяющих методов класса MyExtensions необходимо явно импортировать пространство имен MyExtensionMethods, как делалось в рассмотренных ранее примерах операторов верхнего уровня. 

Расширение типов, реализующих специфичные интерфейсы

К настоящему моменту вы видели, как расширять классы (и косвенно структуры, которые следуют тому же синтаксису) новой функциональностью через расширяющие методы. Также есть возможность определить расширяющий метод, который способен расширять только класс или структуру, реализующую корректный интерфейс. Например, можно было бы заявить следующее: если класс или структура реализует интерфейс IEnumerable<T>,