Dart typedef и типы функций

typedef — это механизм псевдонимов типов в Dart, который позволяет определять короткие, удобочитаемые имена для сложных типов.

В этой главе рассматриваются два применения typedef: традиционный псевдоним типа функции и обобщённый псевдоним типа, представленный в Dart 3.0.


typedef — псевдоним типа функции

Когда тип функции используется часто, typedef может дать ему понятное имя.

Это особенно полезно в таких сценариях, как функции обратного вызова и обработчики событий.

Пример

// Определить псевдоним типа функции
// Представляет: функция, которая принимает два параметра int и возвращает int
typedef IntOperation = int Function(int a, int b);

// Определите тип обратного вызова
// Представляет: функцию, которая принимает String message и не возвращает значение
typedef MessageCallback = void Function(String message);

// Используйте typedef как тип параметра
int performOperation(int x, int y, IntOperation operation) {
  return operation(x, y);
}

void logMessage(String msg, MessageCallback callback) {
  print('Подготовка к выводу сообщения...');
  callback('[ПРИМЕР] $msg');
}

void main() {
  // Передайте функцию, соответствующую сигнатуре IntOperation
  int add(int a, int b) => a + b;
  int multiply(int a, int b) => a * b;

  print('10 + 5 = ${performOperation(10, 5, add)}');
  print('10 × 5 = ${performOperation(10, 5, multiply)}');

  // Вы также можете напрямую передать анонимную функцию
  int result = performOperation(20, 4, (a, b) => a ~/ b);
  print('20 ÷ 4 = $result');

  // Используйте MessageCallback
  logMessage('Операция завершена', (msg) {
    print('Получено сообщение: $msg');
  });
}
10 + 5 = 15
10 × 5 = 50
20 ÷ 4 = 5
准备输出消息...
收到消息: [EXAMPLE] 操作完成

Без typedef вам приходится повторно писать подробные сигнатуры типов функций в каждой позиции параметра.

С typedef объявления типов становятся понятными и единообразными, а изменения нужно вносить только в одном месте.

typedef — это всего лишь псевдоним для типа; он не создаёт новый тип. IntOperation и int Function(int, int) полностью эквивалентны в системе типов.


Тип функции как параметр

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

Пример

// Используйте функциональные типы напрямую для объявления параметров (без typedef)
void processNumbers(
  List<int> numbers,
  bool Function(int) filter,
  String Function(int) formatter,
) {
  var filtered = numbers.where(filter);
  for (var n in filtered) {
    print(formatter(n));
  }
}

// Функция высшего порядка, возвращающая функцию
int Function(int) makeMultiplier(int factor) {
  // Возвращаемое замыкание захватывает factor
  return (int n) => n * factor;
}

void main() {
  var scores = [55, 78, 92, 60, 45, 88];

  print('--- Проходной балл ---');
  processNumbers(
    scores,
    (n) => n >= 60,                    // Условие фильтрации
    (n) => 'ПРИМЕР Счёт: $n очков',       // Форматирование
  );

  print('--- Лучшие результаты (> 80) ---');
  processNumbers(
    scores,
    (n) => n > 80,
    (n) => 'Лучший результат: $n очков',
  );

  // Функция как возвращаемое значение
  var doubler = makeMultiplier(2);
  var tripler = makeMultiplier(3);
  print('5 × 2 = ${doubler(5)}');
  print('5 × 3 = ${tripler(5)}');
}
--- 及格分数 ---
EXAMPLE 分数: 78 分
EXAMPLE 分数: 92 分
EXAMPLE 分数: 60 分
EXAMPLE 分数: 88 分
--- 高分(> 80)---
高分: 92 分
高分: 88 分
5 × 2 = 10
5 × 3 = 15

Паттерн обратного вызова

Паттерн обратного вызова — наиболее распространённый сценарий применения функциональных типов.

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

Пример

// Определение типа обратного вызова
typedef ResultCallback<T> = void Function(T result);
typedef ErrorCallback = void Function(String error);

// Имитация асинхронной операции
void fetchUserData(
  String userId, {
  required ResultCallback<Map<String, dynamic>> onSuccess,
  required ErrorCallback onError,
}) {
  // Имитация сетевого запроса
  print('Получение данных пользователя...');

  // Имитация успеха/неудачи
  if (userId == 'example') {
    var data = {
      'id': 'example',
      'name': 'EXAMPLE user',
      'level': 'VIP',
    };
    onSuccess(data);
  } else {
    onError('Пользователь $userId не существует');
  }
}

void main() {
  // Используйте callback для обработки результата
  fetchUserData(
    'example',
    onSuccess: (data) {
      print('Данные успешно получены!');
      print('Имя пользователя: ${data['name']}');
      print('Уровень: ${data['level']}');
    },
    onError: (error) {
      print('Не удалось получить данные: $error');
    },
  );

  print('---');

  // Сценарий сбоя теста
  fetchUserData(
    'неизвестно',
    onSuccess: (data) {
      print('Получение успешно');
    },
    onError: (error) {
      print('Не удалось получить данные: $error');
    },
  );
}
正在获取用户数据...
获取成功!
用户名: EXAMPLE 用户
等级: VIP
---
正在获取用户数据...
获取失败: 用户 unknown 不存在

Типичные сценарии применения паттерна обратного вызова:

СценарииТип обратного вызова Пример
Сетевой запросonSuccess(data) / onError(error)
Событие UIonTap() / onLongPress()
Преобразование данныхОбратные вызовы в map(), where(), reduce()
ТаймерTimer(callback, duration)
Анимация завершенаonComplete()

Хотя паттерн обратного вызова гибок, он приводит к «аду обратных вызовов» при обработке многоуровневых асинхронных операций. Dart предоставляет async/await для более элегантной обработки асинхронных потоков, что мы подробно рассмотрим в главе 17.


Dart 3.0: псевдоним обобщённого типа

Dart 3.0 расширяет возможности typedef; теперь можно создавать псевдонимы для любого типа, а не только для типов функций.

Пример

// Dart 3.0: typedef может создавать псевдонимы для любого типа

// Псевдонимы для сложных типов коллекций
typedef JsonMap = Map<String, dynamic>;
typedef UserList = List<Map<String, dynamic>>;

// Обобщённые псевдонимы
typedef Result<T> = ({T data, String? error});

// Псевдонимы типов функций (традиционное использование)
typedef Validator<T> = String? Function(T value);

// Использование псевдонимов типов
void processJson(JsonMap json) {
  print('Обработка JSON: $json');
  print('Количество ключей: ${json.length}');
}

void validateAndPrint<T>(T value, Validator<T> validator) {
  var error = validator(value);
  if (error != null) {
    print('Ошибка валидации: $error');
  } else {
    print('Проверка пройдена: $error');
  }
}

void main() {
  // Использование псевдонима JsonMap
  JsonMap userData = {
    'name': 'пример',
    'age': 10,
    'isVip': true,
  };
  processJson(userData);

  // Использование псевдонима Result
  Result<String> successResult = (data: 'Операция выполнена успешно', error: null);
  Result<String> errorResult = (data: '', error: 'Истекло время ожидания сетевого подключения');
  print('Успех: ${successResult.data}');
  print('Ошибка: ${errorResult.error}');

  // Использование обобщённого Validator
  Validator<String> nameValidator = (value) {
    if (value.isEmpty) return 'Имя не может быть пустым';
    if (value.length < 3) return 'Имя должно содержать не менее 3 символов';
    return null;  // null означает, что валидация пройдена
  };

  validateAndPrint('EXAMPLE', nameValidator);
  validateAndPrint('AB', nameValidator);
}
处理 JSON: {name: example, age: 10, isVip: true}
键的数量: 3
Success: 操作成功
失败: 网络连接超时
验证通过: EXAMPLE
验证失败: 名称至少 3 个字符

Псевдонимы типов в Dart 3.0 значительно сокращают многословные объявления типов, делая код более кратким и читаемым.

Псевдонимы типов (typedef) и сами типы полностью эквивалентны во время выполнения; они являются лишь «прозвищами» на этапе компиляции. Это означает, что вы не можете использовать typedef, чтобы различать два типа, которые структурно идентичны, но семантически различны, — они рассматриваются как один и тот же тип.

Другие расширения