Flutter 注解处理及代码生成，Android攻防实战电子书

方法名随意，重点需要关注的是返回的对象。

示例中我们返回的是 LibraryBuilder 对象，构造方法的参数是我们上一步创建的TestGenerator对象。

实际上根据不同的需求，我们还

《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》

【docs.qq.com/doc/DSkNLaERkbnFoS0ZF】 完整内容开源分享

有其他Builder对象可选，Builder 的继承树：

• Builder
• _Builder
• PartBuilder
• LibraryBuilder
• SharedPartBuilder
• MultiplexingBuilder

PartBuilder 与 SharedPartBuilder 涉及到 dart-part 关键字的使用，这里我们暂时不做展开，通常情况下 LibraryBuilder 已足以满足我们的需求。 MultiplexingBuilder 支持多个Builder的添加。

5.创建配置文件

在项目根目录创建 build.yaml 文件，其意义在于 配置 Builder 的各项参数：

builders:
testBuilder:
import: “package:flutter_annotation/test.dart”
builder_factories: [“testBuilder”]
build_extensions: {".dart": [".g.part"]}
auto_apply: root_package
build_to: source

配置信息的详细含义我们后面解释。重点关注的是，通过 import 和 builder_factories 两个标签，我们指定了上一步创建的 Builder。

6.运行 Builder

命令行中执行命令，运行我们的 Builder

$ flutter packages pub run build_runner build

受限于Flutter 禁止反射的缘故，你不能再像Android中使用编译时注解那样，coding 阶段使用接口，编译阶段生成实现类，运行阶段通过反射创建实现类对象。在Flutter中，你只能先通过命令生成代码，然后再直接使用生成的代码。

可以看到命令还是偏长的，一个可行的建议是将命令封装成一个脚本。

不出意外的话，命令执行成功后将会生成一个新的文件：TestModel.g.dart 其内容：

// GENERATED CODE - DO NOT MODIFY BY HAND

// **************************************************************************
// TestGenerator
// **************************************************************************

class Tessss {}

代码生成成功！

清理生成的文件无需手动删除，可执行以下命令：

flutter packages pub run build_runner clean

Dart-APT Api详解

• 1.注解创建与使用
• 2.创建生成器 Generator
• 3.generateForAnnotatedElement 参数: element
• 4.generateForAnnotatedElement 参数: annotation
• 5.generateForAnnotatedElement 参数: buildStep
• 6.模板代码生成技巧
• 7.配置文件字段含义

1.注解创建与使用

Dart的注解创建和普通的class创建没有任何区别，可以 extends, 可以 implements ，甚至可以 with。

唯一必须的要求是：构造方法需要用 const 来修饰。

不同于java注解的创建需要指明@Target（定义可以修饰对象范围）

Dart 的注解没有修饰范围，定义好的注解可以修饰类、属性、方法、参数。

但值得注意的是，如果你的 Generator 直接继承自 GeneratorForAnnotation， 那你的 Generator 只能拦截到 top-level 级别的元素，对于类内部属性、方法等无法拦截，类内部属性、方法修饰注解暂时没有意义。（不过这个事情扩展一下肯定可以实现的啦~）

2.创建生成器 Generator

Generator 为创建代码而生。通常情况下，我们将继承 GeneratorForAnnotation，并在其泛型参数中添加目标 annotation。然后复写 generateForAnnotatedElement 方法，最终 return 一个字符串，便是我们要生成的代码。

class TestGenerator extends GeneratorForAnnotation {
@override
generateForAnnotatedElement(
Element element, ConstantReader annotation, BuildStep buildStep) {
return “class Tessss{}”;
}
}

GeneratorForAnnotation的注意点有：

2.1 GeneratorForAnnotation与annotation的对应关系

GeneratorForAnnotation是单注解处理器，每一个 GeneratorForAnnotation 必须有且只有一个