Flutter数据构建插件data_builder的使用

Flutter数据构建插件data_builder的使用

data_builder 插件用于使用 data_annotation 创建不可变的数据类。

使用

带空安全的简单用法示例

import 'package:data_annotation/data_annotation.dart';

part 'example.data.dart';

// 定义一个枚举类型
enum ExampleEnum { example }

// 定义一个普通模型类
class Model {
  Model.fromJson(Map<String, dynamic> json);

  Map<String, dynamic> toJson() => {};
}

// 使用data_annotation创建一个不可变数据类
[@data](/user/data)
abstract class ExampleDataClass with _$ExampleDataClass {
  const ExampleDataClass._();

  // 定义构造函数
  const factory ExampleDataClass({
    double? field,          // 可选双精度浮点数字段
    String? field1,         // 可选字符串字段
    int? field2,            // 可选整数字段
    bool? field3,           // 可选布尔字段
    ExampleEnum? field4,    // 可选枚举字段
    @DataKey('model') Model? field5, // 可选模型字段，使用@DataKey注解
    Uri? field6,            // 可选Uri字段
    BigInt? field7,         // 可选BigInt字段
    DateTime? field8,       // 可选日期时间字段
    Duration? field9,       // 可选持续时间字段
    @DataKey('models') List<Model>? field10, // 可选模型列表字段
    @DataKey('modelByKey') Map<String, Model>? field11, // 可选模型映射字段
  }) = _ExampleDataClass;

  // 从JSON对象创建实例
  factory ExampleDataClass.fromJson(Map<String, dynamic> json) = _ExampleDataClass.fromJson;

  // 将实例转换为JSON对象
  Map<String, dynamic> toJson();
}

不带空安全的简单用法示例

import 'package:data_annotation/data_annotation.dart';

part 'example.data.dart';

// 定义一个枚举类型
enum ExampleEnum { example }

// 定义一个普通模型类
class Model {
  Model.fromJson(Map<String, dynamic> json);

  Map<String, dynamic> toJson() => {};
}

// 使用data_annotation创建一个不可变数据类
[@data](/user/data)
abstract class ExampleDataClass with _$ExampleDataClass {
  const ExampleDataClass._();

  // 定义构造函数
  const factory ExampleDataClass({
    double field,           // 双精度浮点数字段
    String field1,          // 字符串字段
    int field2,             // 整数字段
    bool field3,            // 布尔字段
    ExampleEnum field4,     // 枚举字段
    @DataKey('model') Model field5, // 模型字段，使用@DataKey注解
    Uri field6,             // Uri字段
    BigInt field7,          // BigInt字段
    DateTime field8,        // 日期时间字段
    Duration field9,        // 持续时间字段
    @DataKey('models') List<Model> field10, // 模型列表字段
    @DataKey('modelByKey') Map<String, Model> field11, // 模型映射字段
  }) = _ExampleDataClass;

  // 从JSON对象创建实例
  factory ExampleDataClass.fromJson(Map<String, dynamic> json) = _ExampleDataClass.fromJson;

  // 将实例转换为JSON对象
  Map<String, dynamic> toJson();
}

更多关于Flutter数据构建插件data_builder的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter数据构建插件data_builder的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


data_builder 是 Flutter 中的一个代码生成工具，它可以帮助开发者自动生成数据模型类、序列化和反序列化代码，从而减少手动编写样板代码的工作量。它通常与 json_annotation 和 json_serializable 等插件一起使用。

1. 安装依赖

首先，你需要在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter
  json_annotation: ^4.8.0

dev_dependencies:
  build_runner: ^2.3.3
  json_serializable: ^6.6.0
  data_builder: ^1.0.0

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

2. 创建数据模型类

假设你有一个 JSON 数据结构如下：

{
  "id": 1,
  "name": "John Doe",
  "email": "john.doe@example.com"
}

你可以创建一个 Dart 类来表示这个数据结构，并使用 @JsonSerializable 注解来标记它：

import 'package:json_annotation/json_annotation.dart';

part 'user.g.dart';

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

  User({required this.id, required this.name, required this.email});

  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. 使用 data_builder

data_builder 可以进一步简化数据模型的构建过程。你可以使用 @Data 注解来自动生成构造函数、copyWith 方法等。

首先，确保你已经安装了 data_builder，然后在你的数据模型类上使用 @Data 注解：

import 'package:data_builder/data_builder.dart';
import 'package:json_annotation/json_annotation.dart';

part 'user.g.dart';

@Data()
@JsonSerializable()
class User {
  final int id;
  final String name;
  final String email;

  User({required this.id, required this.name, required this.email});

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

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

再次运行 flutter pub run build_runner build，data_builder 将会生成以下代码：

  • 一个带有命名参数的构造函数
  • copyWith 方法，用于创建对象的副本并修改某些字段
  • == 和 hashCode 的重载
  • toString 方法的重载

5. 使用生成的方法

现在你可以像这样使用生成的代码：

void main() {
  var user = User(id: 1, name: "John Doe", email: "john.doe@example.com");

  // 使用 copyWith 方法
  var updatedUser = user.copyWith(name: "Jane Doe");

  print(updatedUser.toJson()); // 输出: {id: 1, name: Jane Doe, email: john.doe@example.com}
}
回到顶部