Ещё одна статья про макросы. Часть 220.09.2024 10:45

Продолжаем предыдущую статью — так что без долгих предисловий идём к примерам. 

Авто-dispose

Зачем?

Удобнее «повесить» аннотацию на поле, которое нужно «выключить» при удалении объекта, чем делать это вручную и спускаться в метод dispose.

Как это должно выглядеть?

Определим сущности, к которым хотим применить макрос — это сущности, у которых есть:

• метод dispose;

• метод close (например, StreamController);

• метод cancel (например, StreamSubscription).

• альтернативный метод «выключения».

Что будет, если мы применим макрос к полю, у которого нет метода dispose/close/cancel? Ничего критичного, просто анализатор сообщит нам, что, сюрприз, метода dispose у поля нет.

@AutoDispose()
class SomeModel {
  @disposable
  final ValueNotifier a;
  @closable
  final StreamController b;
  @cancelable
  final StreamSubscription c;
  @Disposable('customDispose')
  final CustomDep d;

  SomeModel({required this.a, required this.b, required this.c, required this.d});
}

class CustomDep {
  void customDispose() {}
}

augment library 'package:test_macros/3.%20auto_dispose/example.dart';

augment class SomeModel {
	void dispose() {
		a.dispose();
		b.close();
		c.cancel();
		d.customDispose();
	}
}

Как это реализовать?

Для начала самое простое — создадим аннотации disposable, cancelable, closable и Disposable:

const disposeMethod = 'dispose';
const closeMethod = 'close';
const cancelMethod = 'cancel';

const disposableAnnotationName = 'disposable';
const closableAnnotationName = 'closable';
const cancelableAnnotationName = 'cancelable';
const customDisposableAnnotationName = 'Disposable';
const customDisposableFieldName = 'disposeMethodName';


const disposable = Disposable(disposeMethod);
const closable = Disposable(closeMethod);
const cancelable = Disposable(cancelMethod);

class Disposable {
  final String disposeMethodName;
  const Disposable(this.disposeMethodName);
}

Пора создавать макрос. Как и в предыдущих случаях, выберем фазу макроса:

• фаза типов нам не подходит — мы не собираемся создавать новые типы;

• фаза объявления позволяет нам добавлять код внутри класса — мы этого и хотим;

• фаза определения словно бы нам не нужна, потому что всё необходимое мы можем сделать в фазе объявления.

import 'dart:async';

import 'package:macros/macros.dart';

macro class AutoDispose implements ClassDeclarationsMacro {
  const AutoDispose();

  @override
  FutureOr buildDeclarationsForClass(ClassDeclaration clazz, MemberDeclarationBuilder builder) async {
    final fields = await builder.fieldsOf(clazz);
  }
}

Соберём словарь, где ключом будет имя поля, а значением — имя метода, который надо вызвать:

final fields = await builder.fieldsOf(clazz);

    /// Ключ - имя поля, значение - имя метода для вызова.
    final disposables = {};

    for (final field in fields) {
      Object? methodName;

      final annotations = field.metadata;

      /// Ищем аннотацию Disposable с кастомным именем метода.
      final customDispose = annotations.whereType().firstWhereOrNull(
            (element) => element.type.identifier.name == customDisposableAnnotationName,
          );

      if (customDispose != null) {
        methodName = customDispose.namedArguments[customDisposableFieldName];
      } else {
        /// Если аннотация не найдена, ищем стандартные аннотации.
        /// 
        /// - отсеиваем константные аннотации;
        /// - ищем аннотации, которые содержат нужные нам идентификаторы.
        /// - сопоставляем идентификаторы с методами.
        methodName = switch ((annotations.whereType().firstWhereOrNull(
              (element) => [
                disposableAnnotationName,
                closableAnnotationName,
                cancelableAnnotationName,
              ].contains(element.identifier.name),
            ))?.identifier.name) {
          disposableAnnotationName => disposeMethod,
          closableAnnotationName => closeMethod,
          cancelableAnnotationName => cancelMethod,
          _ => null,
        };
      }

      if (methodName != null) {
        disposables[field.identifier.name] = methodName;
      }
    }

Дело за малым — собираем код метода dispose и добавляем его в класс:

final code =