Аннотация @override

Часть раздела Объектно-ориентированное программирование путешествия по Dart на Coddy. Урок 39 из 110.

Аннотация @override — это маркер лучшей практики, который сообщает Dart (и другим разработчикам), что вы намеренно заменяете метод родительского класса. Хотя переопределение метода работает и без неё, использование @override добавляет важный уровень защиты.

class Animal {
  String name;
  
  Animal(this.name);
  
  void speak() {
    print('$name makes a sound');
  }
}

class Dog extends Animal {
  Dog(String name) : super(name);
  
  @override
  void speak() {
    print('$name barks: Woof!');
  }
}

Аннотация предоставляет два ключевых преимущества. Во-первых, она ясно документирует ваше намерение — любой, кто читает код, сразу понимает, что этот method существует в parent class. Во-вторых, анализатор Dart предупредит вас, если method в parent фактически не существует, что позволяет на раннем этапе обнаружить опечатки и ошибки рефакторинга.

Рассмотрим, что произойдёт, если вы неправильно напишете имя метода без @override:

class Cat extends Animal {
  Cat(String name) : super(name);
  
  void speek() {  // Опечатка! Нет предупреждения без @override
    print('$name meows');
  }
}

Без аннотации Dart предполагает, что вы создаёте новый метод с именем speek(). С помощью @override анализатор сразу сообщит об ошибке: такого метода не существует в родительском классе. Эта простая аннотация предотвращает скрытые ошибки, которые впоследствии бывает трудно обнаружить.

Задание

Легко

Давайте создадим систему медиаплеера, демонстрирующую важность аннотации @override при настройке унаследованного поведения. Вы создадите различные типы медиа, каждый из которых будет воспроизводить Content своим способом.

Вы организуете код в двух файлах:

media.dart: Определите здесь свою иерархию медиа:
- Класс Media со свойством String title, конструктором, принимающим заголовок, и методом play(), который выводит Playing: [title]
- Класс Song, расширяющий Media и добавляющий свойство String artist. Используйте аннотацию @override и переопределите play(), чтобы выводить Playing song: [title] by [artist]
- Класс Video, расширяющий Media и добавляющий свойство int duration (в секундах). Используйте @override и переопределите play(), чтобы сначала вызвать версию parent с помощью super.play(), а затем вывести Duration: [duration] seconds
main.dart: Импортируйте свой медиафайл и продемонстрируйте переопределённые методы:
- Создайте объект Media с заголовком 'Generic Content' и вызовите play()
- Выведите пустую строку
- Создайте Song с заголовком 'Imagine' и исполнителем 'John Lennon', затем вызовите play()
- Выведите пустую строку
- Создайте Video с заголовком 'Dart Tutorial' и длительностью 360, затем вызовите play()

Аннотация @override документирует ваше намерение и помогает обнаруживать ошибки. Если вы случайно напечатаете play() как plya(), аннотация предупредит вас, что в parent class такого метода не существует.

Ожидаемый вывод:

Playing: Generic Content

Playing song: Imagine by John Lennon

Playing: Dart Tutorial
Duration: 360 seconds

Попробуйте сами

import 'media.dart';

void main() {
  // TODO: Create a Media object with title 'Generic Content' and call play()
  
  
  // TODO: Выведите пустую строку
  
  
  // TODO: Создайте Song с названием 'Imagine' и исполнителем 'John Lennon', затем вызовите play()
  
  
  // TODO: Выведите пустую строку
  
  
  // TODO: Create a Video with title 'Dart Tutorial' and duration 360, then call play()
  
}