Flutter编译时生成代码之 code_builder

前言

之前学习原生开发的时候使用过各种编译自动生成模板代码的框架,例如ARouter,这些框架其实是借助了JavaPoet 这个框架来自动生成代码的,JavaPoet 可以在编译自动生成模板代码,在flutter,也有这样的框架可以在编译时自动生成代码,这个框架就是 code_builder

代码

code_builder内部提供了一系列的api给开发人员使用,凭借这些api,我们可以创建任何代码。假如我们现在需要创建一个User类,代码如下:

class User {
  User.User([this._name, this._age, this._sex]);

  String _name;

  int _age;

  int _sex;

  String get name => _name;
  int get age => _age;
  get sex => _sex;
  set name(String value) {
    _name = value;
  }

  set age(int value) {
    _age = value;
  }

  set sex(int value) {
    _sex = value;
  }

  @override
  String toString() {
    return "name = $_name; sex = $_sex; age = $_age";
  }
}

那我们该如何调用code_builder提供的api去创建这样一个类呢?可以这么做,如下代码所示:

void getUser() {
  final user = Class((classBuild) => classBuild//生成一个类
    ..name = "User"//这个类的名字叫User
    ..fields.add(Field((fieldBuild) => fieldBuild//添加成员变量
      ..name = "_name"//该变量为私有变量,变量名为_name
      ..type = refer("String")//变量类型为String
    ))
    ..fields.add(Field((fieldBuild) => fieldBuild
      ..name = "_age"
      ..type = refer("int")
    ))
    ..fields.add(Field((fieldBuild) => fieldBuild
      ..name = "_sex"
      ..type = refer("int")
    ))
    ..constructors.add(Constructor((constructorBuilder){//添加构造函数
      constructorBuilder.name = "User";//构造函数的名字为User
      constructorBuilder.optionalParameters.add(Parameter((parameterBuilder) {//给构造函数添加一个参数
        parameterBuilder.name = "_name";// 给构造函数添加一个参数_name
        parameterBuilder.toThis = true;// 将参数_name赋值给成员变量_name
       }));
      constructorBuilder.optionalParameters.add(Parameter((parameterBuilder) {
        parameterBuilder.name = "_age";
        parameterBuilder.toThis = true;
      }));
      constructorBuilder.optionalParameters.add(Parameter((parameterBuilder) {
        parameterBuilder.name = "_sex";
        parameterBuilder.toThis = true;
      }));
    }))
    ..methods.add(Method((methodBuild) {// 创建一个方法
      methodBuild.type = MethodType.getter;// 方法是get类型的方法
      methodBuild.name = "name";// 方法名是name
      methodBuild.returns = refer("String");//方法返回类型是String
      methodBuild.lambda = true;// 方法是一个lambda表达式
      methodBuild.body = const Code("_name");// 创建方法体内的代码
    }))
    ..methods.add(Method((methodBuild){
      methodBuild.type = MethodType.getter;
      methodBuild.name = "age";
      methodBuild.returns = refer("int");
      methodBuild.lambda = true;
      methodBuild.body = const Code("_age");
    }))
    ..methods.add(Method((methodBuild){
      methodBuild.type = MethodType.getter;
      methodBuild.name = "sex";
      methodBuild.lambda = true;
      methodBuild.body = const Code("_sex");
    }))
    ..methods.add(Method((methodBuild) { //创建一个方法
      methodBuild.type = MethodType.setter; // 方法是set类型的方法
      methodBuild.name = "name";  // 方法名是name
      methodBuild.lambda = false; // 不是lambda表达式
      methodBuild.requiredParameters.add(Parameter((parameterBuild) { // 给方法添加参数
        parameterBuild.name = "value"; // 参数名是value
        parameterBuild.type = refer("String"); // 参数类似是String
      }));
      methodBuild.body = const Code("_name = value;"); // 方法体,对_name赋值为value
    }))
    ..methods.add(Method((methodBuild){
      methodBuild.type = MethodType.setter;
      methodBuild.name = "age";
      methodBuild.lambda = false;
      methodBuild.requiredParameters.add(Parameter((parameterBuild){
        parameterBuild.name = "value";
        parameterBuild.type = refer("int");
      }));
      methodBuild.body = const Code("_age = value;");
    }))
    ..methods.add(Method((methodBuild){
      methodBuild.type = MethodType.setter;
      methodBuild.name = "sex";
      methodBuild.lambda = false;
      methodBuild.requiredParameters.add(Parameter((parameterBuild){
        parameterBuild.name = "value";
        parameterBuild.type = refer("int");
      }));
      methodBuild.body = const Code("_sex = value;");
    }))
    ..methods.add(Method((methodBuild) {
      methodBuild.name = "toString";
      methodBuild.lambda = false;
      methodBuild.returns = refer("String");
      methodBuild.annotations.add(TypeReference((build) {// 给方法添加注解
        build.symbol = "override";//注解类型是@override,表示这是一个重写的方法
      }));
      methodBuild.body = const Code("return \"name = \$_name; sex = \$_sex; age = \$_age\"; ");
    }))
  );
  final emitter = DartEmitter();
  print(DartFormatter().format('${user.accept(emitter)}'));
}

void main() {
  getUser();
}

当然,光靠code_builder是不足以生成可以在实际项目中可以使用的类的,因为它只是创建了代码模板而已,我们还需要将这些代码模板写入到工程目录的某一个dart文件中,这个就需要借助source_gen了,source_gen可以在编译时解析注解,然后借助code_builder生成代码模板,最终将这些代码模板写入到工程目录的某一个dart文件中。

QQ交流群

群号码:770892444

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

推荐阅读更多精彩内容