Flutter反射与分发插件reflector_dispatcher的使用

Flutter反射与分发插件reflector_dispatcher的使用

ReflectorDispatcher 是通过 package:reflectable 对类实例进行内省来实现的 [Dispatcher]。package:reflectable 允许您通过方法名字符串调用一个实例的方法。

要构造一个 [ReflectorDispatcher]，需要一个类实例及其预构建的内省数据（这些数据是在根据 Reflectable 的说明进行构建时创建的）。ReflectorDispatcher.dispatch("someMethod") 将返回一个包含该方法返回值的 Future。

这适用于 JSON-RPC，因此有一些限制。一个方法只能通过位置参数或命名参数调用，不能同时使用两者。可选参数应该按预期工作。

ReflectorDispatcher 主要是一个围绕 package:reflectable 的包装器，作为对不兼容 Flutter 的 dart:mirrors 的替代。对于任何分派的方法，Dispatcher 返回该方法的返回值或三个“异常”类之一的实例。大多数错误将被收集到这些对象中，这样运行时异常不会被抛出，而是以有序的方式返回。

使用

以下是一个简单的使用示例：

import 'package:reflector_dispatcher/reflector_dispatcher.dart';
import 'package:reflectable/reflectable.dart';

/// 这个导入在运行构建器之前不存在
/// （假设这是在一个 'example' 文件夹中）
/// > pub run build_runner build example
/// 或者 > flutter pub run build_runner build example
import 'reflector_dispatcher_example.reflectable.dart';

// 使用此类注解启用反射。
class Reflector extends Reflectable {
  const Reflector()
      : super(
            invokingCapability, // 请求调用方法的能力。
            declarationsCapability); // 需要用于内省方法。
}

const reflectable = Reflector();

/// 查看 test/reflector_dispatcher_test.dart 获取更多示例。

/// 创建一个具有所需 API 的类。一些愚蠢但有教育意义的东西。
///
/// 在 Foo 中保存计数。
[@reflectable](/user/reflectable)
class Foo {
  num _count = 0;

  /// 使用计数初始化
  Foo(this._count);

  /// 带有一个可选位置参数的增量
  void increment([num aNumber = 1]) => _count += aNumber;

  /// 带有一个必需命名参数的减量
  void decrement({required num aNumber}) => _count -= aNumber;

  /// 获取当前计数值
  num getCount() => _count;

  /// 我们经常减去2。
  num goTwoLess() {
    _count -= 2;
    return _count;
  }
}

void main() async {
  // 在使用 ReflectorDispatcher 之前执行此操作
  initializeReflectable();

  /// 使用 Foo 类的一个已初始化实例及其内省数据创建一个调度器
  var dispatcher = ReflectorDispatcher(Foo(29), reflectable);

  /// 调用带有参数的方法
  await dispatcher.dispatch('increment', 4);

  /// 获取新值
  var c = await (dispatcher.dispatch('getCount'));
  printCount(c); // 输出: the currentCount is 33

  /// 调用带有命名参数的方法
  await dispatcher.dispatch('decrement', {'aNumber': 18});
  var d = await (dispatcher.dispatch('getCount'));
  printCount(d); // 输出: the currentCount is 15

  /// 调用不带参数的方法
  await dispatcher.dispatch('increment');
  var e = await (dispatcher.dispatch('getCount'));
  printCount(e); // 输出: the currentCount is 16

  var f = await dispatcher.dispatch('goTwoLess');
  printCount(f); // 输出: the currentCount is 14
}

void printCount(num aCount) {
  print('the currentCount is $aCount');
}