Dart代码生成器PART ONE

本文首发于订阅号:Dart客栈

介绍

在开发Flutter的过程中，会发现：json解析怎么这么麻烦，数据库存储怎么这么多步骤，当你在重复编写这一个又一个步骤时，会发现，复制粘贴过程中因为某一个变量而出错！这个时候，会想，如果可以自动生成多好！这个时候，Dart代码生成器可以帮到你！

Dart代码生成工具

在dart的世界里，存在两个工具：

source_gen

该dart包提供一个友好的api来自动生成代码，它是对其它dart包的封装，例如analyzer 和build，
提供了两个抽象生成器：

Generator：完全控制生成器，继承该类，可访问代码所有元素，因此得到的是完全控制
GeneratorForAnnotation<T>：简单的生成器，继承该类，并传入注解T类，可解析注解对应的类或成员变量或方法等

构建工作部分可以选择

SharedPartBuilder：该构建会生成一个扩展名为：.g.dart文件，用于写部分代码
PartBuilder：该构建可以生成任意名的文件，例如：generator.dart
LibraryBuilder 该构建可以生成一个独立可导入的库

build_runner

该工具可以允许我们在开发阶段运行命令行调用，以下面形式调用：
pub run build_runner <command>
command:

builder：运行单个构建并退出
watch：运行一个守护进程，当代码更改或者必要时重新构建
serve：与watch类似，但也可以作为开发服务器运行
test：用于测试的目的

为了能够与source_gen一起工作，需要配置一个build.yaml文件，以其指定生成器配置的不同细节

代码生成器的库

一些有名的代码生成器库有如下，可以作为参考：

构建代码生成器

下面我们来一起构建一个基于注解的代码生成器，这里先说明一下我们需要编写三个包：

code_generator：dart基础包，一些基本用法，和声明注解
code_generator_gen：dart构建包，用于运行命令行生成代码的逻辑
code_generator_example：上面两个包的使用示例

code_generator 包

该dart包用于编写基础库和注解声明，我们先声明一个注解，用于获取用户注解上的类内容。
我们这里添加一个WebSite注释

class WebSite{
  final String name;
  final String url;

// 注解的构造方法必须使用const关键字申明
  const WebSite({this.name, this.url});
}

好了，我们已经完成了code_generator包的编写（这里只是声明一个注解，如果有其它的业务逻辑，可以继续编写其它的代码）

code_generator_gen包

我们需要在根目录下pubspec.yaml中添加代码生成构建工具依赖包source_gen、build_runner 还有上面的基础包

environment:
  sdk: '>=2.1.0 <3.0.0'

dependencies:
  build: '>=0.12.0 <2.0.0'
  source_gen: ^0.9.0
  code_generator:
    path: ../code_generator/ #code_generator包位于该包的同级目录下

dev_dependencies:
  build_test: ^0.10.0
  build_runner: '>=0.9.0 <0.11.0'
  test: ^1.0.0

添加实现了抽象类GeneratorForAnnotation的实现类

import 'package:analyzer/dart/element/element.dart';
import 'package:build/src/builder/build_step.dart';
import 'package:source_gen/source_gen.dart';
import 'package:code_generator/code_generator.dart';

class CodeGenerator extends GeneratorForAnnotation<WebSite>{
  @override
  generateForAnnotatedElement(Element element, ConstantReader annotation, BuildStep buildStep) {
    return '//添加一条注释';//这里因为测试，只自动生成了一个注释
  }
}

在iib目录下添加文件builder.dart

import 'package:build/build.dart';
import 'package:source_gen/source_gen.dart';
import 'code_generator_gen.dart';

//code_generator 用于区别其它库
Builder codeGenerator(BuilderOptions options)=>
  SharedPartBuilder([CodeGenerator()], 'code_generator');

在根目录下添加build.yaml文件

targets:
  $default: #定义目标库，关键字$default默认为当前库
    builders: #构建的两个库
      code_generator_gen|code_generator:
        enabled: true #可选，是否将构建器应用于此目标

builders:
  code_generator:
    target: ":code_generator_gen" #目标库
    import: "package:code_generator_gen/builder.dart" #build文件
    builder_factories: ["codeGenerator"] #build文件中对应的方法
    build_extensions: {".dart": [".code_generator.g.part"]}
    auto_apply: dependents #将此Builder应用于包，直接依赖于公开构建起的包
    build_to: cache #输出转到隐藏的构建缓存，不会发布
    applies_builders: ["source_gen|combining_builder"] #指定是否可以延迟运行构建器

# 以上参数具体参考 https://github.com/dart-lang/build/blob/master/build_config/README.md

以上是code_generator_gen包的所有内容，下面开始使用build

code_generator_example包

该包将演示上面编写的内容的使用：
根目录下的pubspec.yaml添加如下

environment:
  sdk: '>=2.1.0 <3.0.0'

dependencies:
  code_generator:
    path: ../code_generator/

dev_dependencies:
  test: ^1.0.0
  build_runner: 1.0.0
  code_generator_gen:
      path: ../code_generator_gen/

然后声明一个类添加我们编写的注解

import 'package:code_generator/code_generator.dart';

@WebSite(name: 'baidu',url: 'http://www.baidu.com')
class BaiDu{
}

在命令行下运行pub run build_runner build

输出.png

我们会发现，没有任何的输出，需要按照上面命令行提示，在注解类文件中添加part 'code_generator_example.g.dart'这一行代码，然后重新运行

输出.png

可以看到，没有出现WARNING，然后查看我们的目录，发现多了一个文件

截图.png

成功的生成我们的代码！

以上是今天的所有内容，如需查看本文章的所有示例代码，请到https://github.com/rhymelph/code_generator_demo，下篇文章会分晓如何解释类，请持续关注！