Reflectable(翻译)

原文：https://pub.dev/packages/reflectable

介绍

这个库支持部分了语言的反射功能，但有一些反射功能没有支持。没有支持的部分可以参考本文最后一小节。

本库的核心思想是明确定义反射支持级别，定义一个使用边界，在运算时使用反射都要在这个边界范围内。这样设计可以使得整体包体积维持较小的水平。除此之外的其他方面，使用本库同使用dart:mirrors是是否相似的。

反射支持规范中的核心概念是可反射能力。有关功能的更详细讨论，请参阅可反射功能 设计文档 https://github.com/google/reflectable.dart/blob/master/reflectable/doc/TheDesignOfReflectableCapabilities.md 。在本页中，我们只使用几个简单的特殊情况。

此包使用代码生成工具，自动生成满足指定的级别上的反射规范。构建包用于管理代码生成，该包的主要部分与生成代码有关。

当且仅当指定的功能集涵盖了动态反射的使用时，才支持使用动态反射。

一般来说，反射是通过Reflectable类的一个子类提供的（我们将这样的子类的实例称为 reflector）

class Reflector extends Reflectable {
  const Reflector() : super(capability1, capability2, ...);
}

默认情况所有的反射功能都是被禁用的，我们可以通过指定可反射功能来启用反射。对于一个Reflector 我们在定义初始化时通过capability1、capability2来指定其指出的反射功能。使用时可以将其作为注解加载类定义的前面，如下代码所示。类A就被描述成支持Reflector对应的反射功能（具体来说就是capability1与capability2）。

@Reflector()
class A {
  ...
}

只有被一个Reflector（比如R）注解过的类，才能被通过R反射访问，并且只能使用R定义时的反射功能（具体来说就是capability1与capability2）。但是还有一些间接反射访问的情况，比如如果A是C的子类，A被被一个Reflector（比如R）注解过，这C类也可以通过R反射访问。其他的间接情况可以打开上面给出的设计文档链接查看。

因为在编译时，与反射相关的操作的可用范围是被限定的，因此再纯静态编译也是可以支持部分反射能力的。

使用

我们来看一个例子：

import 'package:reflectable/reflectable.dart';
import 'main.reflectable.dart'; // Import 自动生成的代码.

// 定义一个Reflector来启用反射.
class Reflector extends Reflectable {
  const Reflector()
      : super(invokingCapability); // 启用“调用方法”级别的反射能力.
}

const reflector = const Reflector();

@reflector // 注解类 A，标明A可以被反射调用.
class A {
  final int a;
  A(this.a);
  greater(int x) => x > a;
  lessEqual(int x) => x <= a;
}

main() {
  initializeReflectable(); // 配置反射
  A x = new A(10);
  // 使用反射器的const实例来反射x
  InstanceMirror instanceMirror = reflector.reflect(x);
  int weekday = new DateTime.now().weekday;

    // 通过反射调用不同方法:
  String methodName = weekday == DateTime.FRIDAY ? "greater" : "lessEqual";
  print(instanceMirror.invoke(methodName, [3]));
}

我们看到，最开始需要引入一个自动生成的文件，这个文件的文件名是当前文件名中加上.reflectable.构成。其次在反射之前，需要调用initializeReflectable()来配置反射。

那么是如何自动生成文件的呢？

首先，在pubspec.yaml中，需要添加如下依赖：

dependencies:
  reflectable: any

其次在工程目录下需要创建一个build.yaml文件，用来表明编译生成的步骤和内容。可以参考https://github.com/dart-archive/test_reflectable中的例子进行设置。

最后在控制台执行build命令即可生成文件:

flutter pub run build_runner build DIR

未支持的反射功能

目前Reflectable库还有一些不完善的地方，包括：

• Reflection on functions/closures.
• Private declarations.
• uri's of libraries.
• The mirror method libraryDependencies has not yet been implemented