Flutter代码生成插件code_builder的使用

code_builder 是一个用于生成有效的Dart代码的流利、基于构建器的库。它具有窄而用户友好的API，可以轻松地创建类、方法、枚举等Dart代码结构。以下是关于如何使用 code_builder 的详细指南和示例。

使用示例

创建一个带有方法的类

下面的例子展示了如何使用 code_builder 创建一个继承自 Organism 的 Animal 类，并为该类添加一个名为 eat 的方法。

import 'package:code_builder/code_builder.dart';
import 'package:dart_style/dart_style.dart';

void main() {
  final animal = Class((b) => b
    ..name = 'Animal'
    ..extend = refer('Organism')
    ..methods.add(Method.returnsVoid((b) => b
      ..name = 'eat'
      ..body = const Code("print('Yum!');"))));
  final emitter = DartEmitter();
  print(
    DartFormatter(languageVersion: DartFormatter.latestLanguageVersion)
        .format('${animal.accept(emitter)}'),
  );
}

输出结果：

class Animal extends Organism {
  void eat() => print('Yum!');
}

处理复杂的依赖关系

当生成的代码有复杂的依赖关系时，code_builder 支持自动作用域管理，以避免符号冲突。以下是一个例子：

import 'package:code_builder/code_builder.dart';
import 'package:dart_style/dart_style.dart';

void main() {
  final library = Library((b) => b.body.addAll([
        Method((b) => b
          ..body = const Code('')
          ..name = 'doThing'
          ..returns = refer('Thing', 'package:a/a.dart')),
        Method((b) => b
          ..body = const Code('')
          ..name = 'doOther'
          ..returns = refer('Other', 'package:b/b.dart')),
      ]));
  final emitter = DartEmitter.scoped();
  print(
    DartFormatter(languageVersion: DartFormatter.latestLanguageVersion)
        .format('${library.accept(emitter)}'),
  );
}

输出结果：

import 'package:a/a.dart' as _i1;
import 'package:b/b.dart' as _i2;

_i1.Thing doThing() {}
_i2.Other doOther() {}

生成带有注解的枚举

你可以使用 code_builder 来生成带有注解的枚举，例如 JSON 序列化的键值对。

import 'package:code_builder/code_builder.dart';
import 'package:dart_style/dart_style.dart';

final _dartfmt = DartFormatter(
  languageVersion: DartFormatter.latestLanguageVersion,
);

String jsonEnum() {
  final values = <EnumValue>[
    EnumValue((b) => b
      ..name = 'metric'
      ..annotations.addAll([
        refer('JsonKey').call([literalString('m')])
      ])),
    EnumValue((b) => b
      ..name = 'imperial'
      ..annotations.addAll([
        refer('JsonKey').call([literalString('i')])
      ])),
  ];
  final e = Enum((b) => b
    ..name = 'Unit'
    ..values.addAll(values));
  return _dartfmt.format('${e.accept(DartEmitter())}');
}

void main() {
  print('jsonEnum():\n${'=' * 40}\n${jsonEnum()}');
}

输出结果：

enum Unit {
  @JsonKey('m')
  metric,
  @JsonKey('i')
  imperial
}

完整示例Demo

为了更好地理解 code_builder 的用法，这里提供了一个完整的示例项目，包含了上述所有功能。

import 'package:code_builder/code_builder.dart';
import 'package:dart_style/dart_style.dart';

final _dartfmt = DartFormatter(
  languageVersion: DartFormatter.latestLanguageVersion,
);

void main() {
  print('animalClass():\n${'=' * 40}\n${animalClass()}');
  print('scopedLibrary():\n${'=' * 40}\n${scopedLibrary()}');
  print('jsonEnum():\n${'=' * 40}\n${jsonEnum()}');
}

/// Outputs:
///
/// ```dart
/// class Animal extends Organism {
///   void eat() => print('Yum!');
/// }
/// ```
String animalClass() {
  final animal = Class((b) => b
    ..name = 'Animal'
    ..extend = refer('Organism')
    ..methods.add(Method.returnsVoid((b) => b
      ..name = 'eat'
      ..body = refer('print').call([literalString('Yum!')]).code)));
  return _dartfmt.format('${animal.accept(DartEmitter())}');
}

/// Outputs:
///
/// ```dart
/// import 'package:a/a.dart' as _i1;
/// import 'package:b/b.dart' as _i2;
///
/// _i1.Thing doThing() {}
/// _i2.Other doOther() {}
/// ```
String scopedLibrary() {
  final methods = [
    Method((b) => b
      ..body = const Code('')
      ..name = 'doThing'
      ..returns = refer('Thing', 'package:a/a.dart')),
    Method((b) => b
      ..body = const Code('')
      ..name = 'doOther'
      ..returns = refer('Other', 'package:b/b.dart')),
  ];
  final library = Library((b) => b.body.addAll(methods));
  return _dartfmt.format('${library.accept(DartEmitter.scoped())}');
}

/// Outputs:
///
/// ```dart
/// enum Unit {
///  @JsonKey('m')
///  metric,
///  @JsonKey('i')
///  imperial
/// }
/// ```
String jsonEnum() {
  final values = <EnumValue>[
    EnumValue((b) => b
      ..name = 'metric'
      ..annotations.addAll([
        refer('JsonKey').call([literalString('m')])
      ])),
    EnumValue((b) => b
      ..name = 'imperial'
      ..annotations.addAll([
        refer('JsonKey').call([literalString('i')])
      ])),
  ];
  final e = Enum((b) => b
    ..name = 'Unit'
    ..values.addAll(values));
  return _dartfmt.format('${e.accept(DartEmitter())}');
}

通过这个完整的示例，你可以看到 code_builder 如何帮助你快速生成复杂的 Dart 代码结构，同时保持代码的可读性和可维护性。希望这些示例能帮助你更好地理解和使用 code_builder 插件。