Flutter編譯時(shí)生成代碼之 code_builder

前言

之前學(xué)習(xí)原生開發(fā)的時(shí)候使用過各種編譯自動(dòng)生成模板代碼的框架桶雀,例如ARouter,這些框架其實(shí)是借助了JavaPoet 這個(gè)框架來自動(dòng)生成代碼的儒喊,JavaPoet 可以在編譯自動(dòng)生成模板代碼祠肥,在flutter纸镊,也有這樣的框架可以在編譯時(shí)自動(dòng)生成代碼鸵闪,這個(gè)框架就是 code_builder檐晕。

代碼

code_builder內(nèi)部提供了一系列的api給開發(fā)人員使用,憑借這些api蚌讼,我們可以創(chuàng)建任何代碼棉姐。假如我們現(xiàn)在需要?jiǎng)?chuàng)建一個(gè)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";
  }
}

那我們?cè)撊绾握{(diào)用code_builder提供的api去創(chuàng)建這樣一個(gè)類呢?可以這么做伞矩,如下代碼所示:

void getUser() {
  final user = Class((classBuild) => classBuild//生成一個(gè)類
    ..name = "User"http://這個(gè)類的名字叫User
    ..fields.add(Field((fieldBuild) => fieldBuild//添加成員變量
      ..name = "_name"http://該變量為私有變量,變量名為_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){//添加構(gòu)造函數(shù)
      constructorBuilder.name = "User";//構(gòu)造函數(shù)的名字為User
      constructorBuilder.optionalParameters.add(Parameter((parameterBuilder) {//給構(gòu)造函數(shù)添加一個(gè)參數(shù)
        parameterBuilder.name = "_name";// 給構(gòu)造函數(shù)添加一個(gè)參數(shù)_name
        parameterBuilder.toThis = true;// 將參數(shù)_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) {// 創(chuàng)建一個(gè)方法
      methodBuild.type = MethodType.getter;// 方法是get類型的方法
      methodBuild.name = "name";// 方法名是name
      methodBuild.returns = refer("String");//方法返回類型是String
      methodBuild.lambda = true;// 方法是一個(gè)lambda表達(dá)式
      methodBuild.body = const Code("_name");// 創(chuàng)建方法體內(nèi)的代碼
    }))
    ..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) { //創(chuàng)建一個(gè)方法
      methodBuild.type = MethodType.setter; // 方法是set類型的方法
      methodBuild.name = "name";  // 方法名是name
      methodBuild.lambda = false; // 不是lambda表達(dá)式
      methodBuild.requiredParameters.add(Parameter((parameterBuild) { // 給方法添加參數(shù)
        parameterBuild.name = "value"; // 參數(shù)名是value
        parameterBuild.type = refer("String"); // 參數(shù)類似是String
      }));
      methodBuild.body = const Code("_name = value;"); // 方法體夏志,對(duì)_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乃坤,表示這是一個(gè)重寫的方法
      }));
      methodBuild.body = const Code("return \"name = \$_name; sex = \$_sex; age = \$_age\"; ");
    }))
  );
  final emitter = DartEmitter();
  print(DartFormatter().format('${user.accept(emitter)}'));
}

void main() {
  getUser();
}

當(dāng)然,光靠code_builder是不足以生成可以在實(shí)際項(xiàng)目中可以使用的類的沟蔑,因?yàn)樗皇莿?chuàng)建了代碼模板而已湿诊,我們還需要將這些代碼模板寫入到工程目錄的某一個(gè)dart文件中,這個(gè)就需要借助source_gen了瘦材,source_gen可以在編譯時(shí)解析注解厅须,然后借助code_builder生成代碼模板,最終將這些代碼模板寫入到工程目錄的某一個(gè)dart文件中食棕。

QQ交流群

群號(hào)碼:770892444

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末朗和,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子簿晓,更是在濱河造成了極大的恐慌眶拉,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,542評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件憔儿,死亡現(xiàn)場(chǎng)離奇詭異忆植,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)谒臼,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門朝刊,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人蜈缤,你說我怎么就攤上這事拾氓。” “怎么了劫樟?”我有些...
    開封第一講書人閱讀 163,912評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵痪枫,是天一觀的道長。 經(jīng)常有香客問我叠艳,道長奶陈,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,449評(píng)論 1 293
  • 正文 為了忘掉前任附较,我火速辦了婚禮吃粒,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘拒课。我一直安慰自己徐勃,他們只是感情好事示,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,500評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著僻肖,像睡著了一般肖爵。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上臀脏,一...
    開封第一講書人閱讀 51,370評(píng)論 1 302
  • 那天劝堪,我揣著相機(jī)與錄音,去河邊找鬼揉稚。 笑死秒啦,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的搀玖。 我是一名探鬼主播余境,決...
    沈念sama閱讀 40,193評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼灌诅!你這毒婦竟也來了芳来?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,074評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤延塑,失蹤者是張志新(化名)和其女友劉穎绣张,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體关带,經(jīng)...
    沈念sama閱讀 45,505評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡侥涵,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,722評(píng)論 3 335
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了宋雏。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片芜飘。...
    茶點(diǎn)故事閱讀 39,841評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖磨总,靈堂內(nèi)的尸體忽然破棺而出嗦明,到底是詐尸還是另有隱情,我是刑警寧澤蚪燕,帶...
    沈念sama閱讀 35,569評(píng)論 5 345
  • 正文 年R本政府宣布娶牌,位于F島的核電站,受9級(jí)特大地震影響馆纳,放射性物質(zhì)發(fā)生泄漏诗良。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,168評(píng)論 3 328
  • 文/蒙蒙 一鲁驶、第九天 我趴在偏房一處隱蔽的房頂上張望鉴裹。 院中可真熱鬧,春花似錦、人聲如沸径荔。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽总处。三九已至狈惫,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間辨泳,已是汗流浹背虱岂。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評(píng)論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留菠红,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,962評(píng)論 2 370
  • 正文 我出身青樓难菌,卻偏偏與公主長得像试溯,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子郊酒,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,781評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容