Versioning with the Override and New Keywords

The C# language is designed so that versioning between base and derived classes in different libraries can evolve and maintain backward compatibility. This means, for example, that the introduction of a new member in a base class with the same name as a member in a derived class is completely supported by C# and does not lead to unexpected behavior. It also means that a class must explicitly state whether a method is intended to override an inherited method, or whether a method is a new method that hides a similarly named inherited method.

In C#, derived classes can contain methods with the same name as base class methods.

· The base class method must be defined virtual.

· If the method in the derived class is not preceded by new or override keywords, the compiler will issue a warning and the method will behave as if the new keyword were present.

· If the method in the derived class is preceded with the new keyword, the method is defined as being independent of the method in the base class.

· If the method in the derived class is preceded with the override keyword, objects of the derived class will call that method instead of the base class method.

· The base class method can be called from within the derived class using the base keyword.

· The override, virtual, and new keywords can also be applied to properties, indexers, and events.

By default, C# methods are not virtual. If a method is declared as virtual, any class inheriting the method can implement its own version. To make a method virtual, the virtual modifier is used in the method declaration of the base class. The derived class can then override the base virtual method by using the override keyword or hide the virtual method in the base class by using the new keyword. If neither the override keyword nor the new keyword is specified, the compiler will issue a warning and the method in the derived class will hide the method in the base class.

To demonstrate this in practice, assume for a moment that Company A has created a class named GraphicsClass, which your program uses. The following is GraphicsClass:

Управление версиями с помощью ключевых слов "Override" и "New"

Функции языка C# позволяют обеспечить и поддерживать обратную совместимость за счет управления версиями между базовыми и производными классами в различных библиотеках. Это означает, например, что если в базовом классе будет создан новый член, имя которого совпадает с именем члена в производном классе, язык C# обработает такую ситуацию, и она не приведет к непредвиденным результатам. Это также означает, что в классе должно быть явно указано, будет ли метод переопределять наследуемый метод, или это новый метод, который будет скрывать наследуемый метод с тем же именем.

В C# производный класс может включать методы с теми же именами, что и у методов базового класса.

· Метод базового класса может быть определен как виртуальный.

· Если перед методом в производном классе не указано ключевое слово new или override, компилятор выдаст предупреждение, и обработка метода будет производиться как в случае наличия ключевого слова new.

· Если перед методом в производном классе указано ключевое слово new, то этот метод определен как независимый от метода в базовом классе.

· Если перед методом в производном классе указано ключевое слово override, то объекты производного класса будут вызывать этот метод вместо метода базового класса.

· Базовый метод можно вызвать из производного класса с помощью ключевого слова base.

· Ключевые слова override, virtual и new могут также применяться к свойствам, индексам и событиям.

По умолчанию методы в языке C# не являются виртуальными. Если метод объявлен как виртуальный, то любой класс, наследующий этот метод, может реализовать собственную версию. Чтобы сделать метод виртуальным, в объявлении метода базового класса используется модификатор virtual. Производный класс может переопределить базовый виртуальный метод с помощью ключевого слова override или скрыть виртуальный метод в базовом классе с помощью ключевого слова new. Если ключевые слова override и new не указаны, компилятор выдаст предупреждение, и метод в производном классе будет скрывать метод в базовом классе.

Чтобы продемонстрировать это на практике, предположим, что компания А создала класс с именем GraphicsClass, используемый вашей программой. Это класс GraphicsClass:

 

class GraphicsClass { public virtual void DrawLine() { } public virtual void DrawPoint() { } }

Your company uses this class, and you use it to derive your own class, adding a new method:

class YourDerivedGraphicsClass: GraphicsClass { public void DrawRectangle() { } }

Your application is used without problems, until Company A releases a new version of GraphicsClass, which resembles the following code:

class GraphicsClass { public virtual void DrawLine() { } public virtual void DrawPoint() { } public virtual void DrawRectangle() { } }

The new version of GraphicsClass now contains a method named DrawRectangle. Initially, nothing occurs. The new version is still binary compatible with the old version. Any software that you have deployed will continue to work, even if the new class is installed on those computer systems. Any existing calls to the method DrawRectangle will continue to reference your version, in your derived class.

However, as soon as you recompile your application by using the new version of GraphicsClass, you will receive a warning from the compiler. For more information, see Compiler Warning (level 2) CS0108.

This warning informs you that you have to consider how you want your DrawRectangle method to behave in your application.

 

 

ß--

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

class YourDerivedGraphicsClass: GraphicsClass { public void DrawRectangle() { } }

Ваше приложение работало без проблем до тех пор, пока компания А не выпустила новую версию класса GraphicsClass со следующим кодом:

class GraphicsClass { public virtual void DrawLine() { } public virtual void DrawPoint() { } public virtual void DrawRectangle() { } }

Новая версия класса GraphicsClass теперь имеет метод с именем DrawRectangle. Сначала ничего особенного не произошло. Новая версия совместима со старой на уровне машинных кодов. Все развернутое программное обеспечение будет продолжать работать, даже если в компьютерных системах будет установлен новый класс. Все существующие вызовы метода DrawRectangle будут продолжать ссылаться на вашу версию в созданном вами производном классе.

Однако как только вы перекомпилируете свое приложение, используя новую версию класса GraphicsClass, компилятор выдаст предупреждение. Дополнительные сведения см. в разделе Предупреждение компилятора (уровень 2) CS0108.

В этом предупреждении вам будет предложено принять решение относительно работы метода DrawRectangle в вашем приложении.

 

If you want your method to override the new base class method, use the override keyword:

class YourDerivedGraphicsClass: GraphicsClass { public override void DrawRectangle() { } }

The override keyword makes sure that any objects derived from YourDerivedGraphicsClass will use the derived class version of DrawRectangle. Objects derived from YourDerivedGraphicsClass can still access the base class version of DrawRectangle by using the base keyword:

base.DrawRectangle();

If you do not want your method to override the new base class method, the following considerations apply. To avoid confusion between the two methods, you can rename your method. This can be time-consuming and error-prone, and just not practical in some cases. However, if your project is relatively small, you can use Visual Studio's Refactoring options to rename the method. For more information, see Refactoring Classes and Types.

Alternatively, you can prevent the warning by using the keyword new in your derived class definition:

class YourDerivedGraphicsClass: GraphicsClass { public new void DrawRectangle() { } }

Using the new keyword tells the compiler that your definition hides the definition that is contained in the base class. This is the default behavior.

 

Если ваш метод должен переопределить новый метод базового класса, используйте ключевое слово override:

class YourDerivedGraphicsClass: GraphicsClass { public override void DrawRectangle() { } }

Ключевое слово override заставляет все объекты, являющиеся производными от YourDerivedGraphicsClass, использовать версию DrawRectangle производного класса. Объекты, являющиеся производными от класса YourDerivedGraphicsClass, могут продолжать использовать версию метода DrawRectangle базового класса, используя ключевое слово "base":

base.DrawRectangle();

Если ваш метод не должен переопределять новый метод базового класса, следуйте приведенным ниже рекомендациям. Чтобы избежать путаницы между двумя методами, вы можете переименовать свой метод. Это отнимает много времени и может привести к возникновению ошибок, поэтому не всегда удобно. Однако, если ваш проект невелик, можно использовать функции оптимизации кода Visual Studio для переименования метода. Дополнительные сведения см. в разделе Оптимизация классов и типов.

Чтобы избежать появления предупреждения, можно также использовать ключевое слово new в определении производного класса:

class YourDerivedGraphicsClass: GraphicsClass { public new void DrawRectangle() { } }

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