Flutter JSON映射与序列化插件dart_json_mapper_built的使用

Flutter JSON映射与序列化插件dart_json_mapper_built的使用

本篇文档介绍了如何在Flutter项目中使用dart_json_mapper_built插件来处理JSON映射和序列化。dart_json_mapper_built是一个与dart-json-mapper配套使用的包，它支持对built_collection类型进行序列化和反序列化。

基础设置

首先，请确保阅读dart-json-mapper的基本设置部分。

在你的pubspec.yaml文件中添加以下依赖项：

dependencies:
  dart_json_mapper:
  dart_json_mapper_built:
dev_dependencies:
  build_runner:

使用示例

下面是一个简单的例子，展示如何使用dart_json_mapper_built插件。

文件结构

  • lib/main.dart

lib/main.dart

import 'package:built_collection/built_collection.dart';
import 'package:dart_json_mapper/dart_json_mapper.dart' show JsonMapper, jsonSerializable;
import 'package:dart_json_mapper_built/dart_json_mapper_built.dart' show builtAdapter;

// 导入生成的映射器
import 'main.mapper.g.dart' show initializeJsonMapper;

// 定义一个不可变类
@jsonSerializable
class ImmutableClass {
  final BuiltList<int> list;

  const ImmutableClass(this.list);
}

void main() {
  // 初始化映射器
  initializeJsonMapper(adapters: [builtAdapter]);

  // 序列化对象并打印结果
  print(JsonMapper.serialize(
    ImmutableClass(BuiltList.of([1, 2, 3]))
  ));
}

输出结果

{
  "list": [1,2,3]
}

更多关于Flutter JSON映射与序列化插件dart_json_mapper_built的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter JSON映射与序列化插件dart_json_mapper_built的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter项目中使用dart_json_mapper_built插件来进行JSON映射与序列化的示例代码。dart_json_mapper_built结合了dart_json_mapper和built_value，提供强大的JSON序列化和反序列化功能，同时利用built_value的不可变性特性。

步骤 1: 添加依赖

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

dependencies:
  flutter:
    sdk: flutter
  dart_json_mapper: ^2.0.0 # 请检查最新版本
  dart_json_mapper_built: ^2.0.0 # 请检查最新版本
  built_collection: ^5.0.0 # 通常与dart_json_mapper_built一起使用
  built_value: ^8.0.0 # 通常与dart_json_mapper_built一起使用

dev_dependencies:
  build_runner: ^2.0.0 # 用于生成代码

步骤 2: 配置build.yaml

在项目根目录下创建或编辑build.yaml文件，添加以下配置以启用dart_json_mapper的代码生成：

targets:
  $default:
    builders:
      dart_json_mapper:
        enabled: true

步骤 3: 定义数据模型

接下来，定义一个使用built_value的数据模型。例如，我们定义一个User类：

import 'package:built_collection/built_collection.dart';
import 'package:built_value/built_value.dart';
import 'package:built_value/serializer.dart';
part 'user.g.dart';

abstract class User implements Built<User, UserBuilder> {
  String get name;
  int get age;
  BuiltList<String> get hobbies;

  // 序列化器
  static Serializer<User> get serializer => _$userSerializer;

  // 工厂构造方法
  factory User([void Function(UserBuilder) updates]) = _$User;
}

运行flutter pub run build_runner build命令生成user.g.dart文件。

步骤 4: 注册序列化器

在你的应用入口文件（通常是main.dart）中，注册dart_json_mapper的序列化器：

import 'package:dart_json_mapper/dart_json_mapper.dart';
import 'user.dart'; // 导入你定义的模型文件

void main() {
  // 注册User类的序列化器
  JsonMapper.registerValueSerializer(User.serializer);

  // 你的Flutter应用代码
  runApp(MyApp());
}

步骤 5: 使用序列化与反序列化

现在你可以使用JsonMapper来序列化和反序列化User对象了：

import 'package:flutter/material.dart';
import 'user.dart';

void main() {
  JsonMapper.registerValueSerializer(User.serializer);
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter JSON Mapping Example'),
        ),
        body: Center(
          child: UserExample(),
        ),
      ),
    );
  }
}

class UserExample extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // 创建一个User对象
    User user = User((b) => b
      ..name = 'John Doe'
      ..age = 30
      ..hobbies = BuiltList<String>(['Reading', 'Traveling']));

    // 序列化User对象为JSON字符串
    String jsonString = JsonMapper.serialize(user);
    print('Serialized JSON: $jsonString');

    // 反序列化JSON字符串为User对象
    User deserializedUser = JsonMapper.deserialize(jsonString, User());
    print('Deserialized User: ${deserializedUser.name}, Age: ${deserializedUser.age}');

    return Text('Check console for JSON serialization/deserialization output.');
  }
}

总结

通过上述步骤，你已经成功在Flutter项目中集成了dart_json_mapper_built插件，并实现了JSON的序列化和反序列化。这种方式不仅提供了强大的功能，还利用了built_value的不可变性，使你的代码更加健壮和易于维护。

回到顶部