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
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342