Flutter如何实现code generator功能

在Flutter中如何实现一个code generator功能？目前需要根据自定义的注解自动生成一些重复性代码，但不太清楚具体该怎么做。是否有推荐的库或工具可以实现这个功能？最好能提供简单的示例说明实现步骤。

2 回复

Flutter中可通过build_runner和source_gen库实现代码生成。步骤如下：

  1. 在pubspec.yaml中添加依赖；
  2. 创建注解类；
  3. 编写生成器，继承Generator或GeneratorForAnnotation；
  4. 注册生成器到build.yaml；
  5. 运行flutter pub run build_runner build生成代码。

更多关于Flutter如何实现code generator功能的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在Flutter中实现代码生成功能主要通过 source_gen 库结合 build_runner 完成。以下是实现步骤：

1. 添加依赖

在 pubspec.yaml 中添加：

dev_dependencies:
  build_runner: ^2.4.0
  source_gen: ^1.3.0

2. 创建生成器

继承 Generator 或 GeneratorForAnnotation 类：

import 'package:source_gen/source_gen.dart';
import 'package:analyzer/dart/element/element.dart';

class MyGenerator extends GeneratorForAnnotation<MyAnnotation> {
  @override
  String generateForAnnotatedElement(
    Element element,
    ConstantReader annotation,
    BuildStep buildStep,
  ) {
    return '''

// 生成的扩展方法
extension ${element.name}Ext on ${element.name} {
  String get generatedMessage => 'Generated for ${element.name}';
}
''';
  }
}

3. 注册生成器

创建 builder.dart：

import 'package:build_runner/build_runner.dart';
import 'package:source_gen/source_gen.dart';
import 'my_generator.dart';

final builders = [
  LibraryBuilder(
    MyGenerator(),
    generatedExtension: '.g.dart',
  ),
];

4. 创建注解

class MyAnnotation {
  const MyAnnotation();
}

5. 使用注解

@MyAnnotation()
class MyClass {}

6. 运行生成命令

flutter pub run build_runner build

核心要点：

  • source_gen：提供代码生成基础框架
  • build_runner：执行构建流程
  • 支持增量生成，提高开发效率
  • 生成的代码会输出到 .g.dart 文件中

典型应用场景：

  • JSON序列化（json_serializable）
  • 路由生成（go_router）
  • 状态管理代码生成
  • 依赖注入配置

通过这种方式，可以自动生成重复性代码，提高开发效率和代码质量。

回到顶部