Flutter表达式解析插件meta_expression的使用

meta_expression简介

meta_expression 是一种基于代码生成的宏（macros）。
版本：0.2.1（实验性）

什么是meta_expression？

meta_expression 是一种宏。这种宏以返回表达式源代码的函数形式表示。宏在构建时执行，宏返回的结果（即源代码）会在其被使用的地点进行替换（展开）。

为了使宏能够在构建时执行，宏由两部分声明组成。第一部分定义了源代码表达式的类型，并用作 <code>macro</code>。第二部分是宏的实现，即返回源代码。宏的实现是在构建时执行的。

如何定义meta_expression？

要定义一个宏，你需要声明两个函数。

import 'package:meta_expression_annotation/meta_expression_annotation.dart';

@MetaExpression(addImpl)
external int Function() add(int x, int y);

String addImpl(MetaContext context) => '''
() => x + y
''';

add 函数是一个占位符（macro）函数。它的作用是在程序代码中调用此函数。

示例：

@pragma('meta_expression:build')
library template;

@pragma('meta_expression:import')
import 'macros.dart';

void main() {
  final x = add(add(1, 2)() * 3, 4)();
  print(x);
}

经过代码生成后，这段代码会被转换为以下代码：

library template;

void main() {
  final x = (() => ((() => 1 + 2)() * 3) + 4)();
  print(x);
}

如何构建使用meta_expression的库？

在Dart中引入增强功能之前，只能通过单独的文件进行代码生成。
为了构建一个单独的库，你需要为构建器添加特殊的注解。

@pragma('meta_expression:build')
library my_library;

@pragma('meta_expression:import')
import 'my/cool/macros.dart';

你还需要将以下包作为 <code>dev_dependencies</code> 添加到 <code>pubspec.yaml</code> 文件中：

• build_runner
• meta_expression

启动构建过程，你需要运行以下命令：

dart run build_runner build

就这样！

转换后的代码是否卫生？

是的。生成的源代码是卫生的。
根据以下术语，代码可以被认为保证不会导致标识符的意外捕获。

卫生宏

通过分析标识符的声明和使用位置来避免名称冲突。
所有内容都会被转换，包括类型参数。

示例：

void _testTypeArgumentExpansion() {
  test('Test type argument expansion', () {
    {
      const source = '''
() {
  var l1 = <O>[];
  var l2 = <T>[];
  foo<X>() {
    var l3 = <X>[];
    var l4 = <O>[];
    var l5 = <T>[];
  }
}''';
      const source2 = r'''
() {
  var l1 = <X>[];
  var l2 = <Foo<baz>>[];
  foo<X$>() {
    var l3 = <X$>[];
    var l4 = <X>[];
    var l5 = <Foo<baz>>[];
  }
}''';
      final arguments = {
        'O': 'X',
        'T': 'Foo<baz>',
      };
      final transformer = MetaExpressionTransformer(
        arguments: arguments,
        source: source,
      );
      final result = transformer.transform();
      expect(result.compact, source2.compact);
    }
  });
}