Flutter 中的代码生成：使用 build_runner

Flutter 中的代码生成：使用 build_runner

5 回复

Flutter中使用build_runner进行代码生成，提升开发效率。

更多关于Flutter 中的代码生成：使用 build_runner的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在 Flutter 中，使用 build_runner 可以自动生成代码。首先在 pubspec.yaml 中添加依赖，然后运行 flutter pub run build_runner build 生成代码。

在 Flutter 中，build_runner 是一个常用的代码生成工具，通常与 json_serializable、freezed 等库配合使用。通过 build_runner，你可以自动生成序列化、反序列化、数据类等代码，减少手动编写的工作量。

使用步骤：

  1. 在 pubspec.yaml 中添加依赖：
    dependencies:
  json_annotation: ^4.8.0
dev_dependencies:
  build_runner: ^2.1.0
  json_serializable: ^6.5.0
  2. 创建需要生成代码的类，并添加注解：
    import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class User {
  final String name;
  final int age;

  User(this.name, this.age);

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}
  3. 运行 build_runner 生成代码：
    flutter pub run build_runner build
    这会生成 user.g.dart 文件，包含序列化和反序列化的代码。

注意：如果需要持续监听文件变化并自动生成代码，可以使用 watch 命令：

flutter pub run build_runner watch

Flutter中使用build_runner进行代码生成，提高开发效率。

在Flutter中，代码生成是一种常见的实践，特别是在处理如序列化、路由生成、依赖注入等任务时。build_runner 是一个常用的工具，用于自动化生成代码。它通常与 json_serializable、freezed、injectable 等包一起使用。

1. 安装 build_runner

首先，你需要在 pubspec.yaml 文件中添加 build_runner 作为开发依赖：

dev_dependencies:
  build_runner: ^2.1.0

然后运行 flutter pub get 来安装依赖。

2. 使用 build_runner 生成代码

假设你正在使用 json_serializable 来自动生成 JSON 序列化和反序列化代码。你可以在你的 Dart 文件中定义模型类，并添加必要的注解：

import 'package:json_annotation/json_annotation.dart';

part 'user.g.dart';

@JsonSerializable()
class User {
  final String name;
  final int age;

  User(this.name, this.age);

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

  Map<String, dynamic> toJson() => _$UserToJson(this);
}

3. 运行 build_runner

在终端中运行以下命令来生成代码：

flutter pub run build_runner build

这会生成 user.g.dart 文件，其中包含 _$UserFromJson 和 _$UserToJson 的实现。

4. 自动重建

如果你希望在代码更改时自动重新生成代码，可以使用：

flutter pub run build_runner watch

这将监视你的文件变化，并在需要时自动重新生成代码。

5. 清理生成的文件

如果你想清理生成的文件，可以使用：

flutter pub run build_runner clean

这将删除所有生成的文件。

总结

build_runner 是一个强大的工具，可以帮助你自动化生成代码，减少手动编写重复代码的工作量。通过结合 json_serializable 等包，你可以轻松处理 JSON 序列化、路由生成等任务。

回到顶部