Flutter对象映射插件object_mapper的使用

object_mapper 是一个用于 Dart 语言的包，它简化了模型对象与 JSON 之间的转换。本文将详细介绍如何在 Flutter 项目中使用 object_mapper 插件，并提供完整的示例代码。

安装插件

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

dependencies:
  object_mapper: ^1.0.0

然后运行 flutter pub get 来安装该插件。

实现步骤

Step 1：扩展类

要使用 object_mapper，你需要让你的模型类继承 Mappable mixin。

class TestInfo with Mappable {
    int id;
}

Step 2：重写 mapping 方法

你需要在模型类中重写 mapping 方法，定义属性如何从 JSON 映射到对象以及反之亦然。

class TestInfo with Mappable {
  int id;

  @override
  void mapping(Mapper map) {
    map("id", id, (v) => id = v);
  }
}

Step 3：注册工厂方法

为了能够正确创建实例，需要将你的模型类注册到 Mappable.factories 中。

Mappable.factories = {
  TestInfo: () => TestInfo()
};

使用示例

将 JSON 转换为对象

final json = {
  "id": 2
};

final info = Mapper.fromJson(json).toObject<TestInfo>();
print(info.id); // 输出: 2

将对象转换为 JSON

final info = TestInfo();
info.id = 2;
final json = info.toJson();
print(json); // 输出: { "id": 2 }

高级用法

嵌套对象和列表

如果你的对象包含嵌套对象或列表，你可以这样定义：

class CategoryInfo with Mappable {
  int? id;
  String? name;
  List<BookInfo>? books;

  @override
  void mapping(Mapper map) {
    map("id", id, (v) => id = v);
    map("name", name, (v) => name = v);
    map<List<BookInfo>>("books", books, (v) => books = v);
  }
}

class BookInfo with Mappable {
  int? id;
  String? name;
  String? author;
  DateTime? publishAt;

  @override
  void mapping(Mapper map) {
    map("id", id, (v) => id = v);
    map("name", name, (v) => name = v);
    map("author", author, (v) => author = v);
    map("publish_at", publishAt, (v) => publishAt = v, DateTransform());
  }
}

自定义转换器

你也可以实现自己的转换器来处理特定类型的转换，比如枚举类型：

class EnumTransform<Object extends Enumerable, JSON> with Transformable<Object, JSON> {
  Object fromJson(value) {
    if (value == null || !(value is JSON)) return null;
    return RawRepresentable(Object, value);
  }

  JSON toJson(Object value) {
    if (value == null) return null;
    return value.rawValue;
  }
}

完整示例

以下是完整的示例代码，展示了如何将复杂的 JSON 数据转换为 Dart 对象并反向转换：

import 'package:object_mapper/object_mapper.dart';

void main() async {
  final json = {
    "id": 1,
    "name": "Fantasy",
    "books": [
      {"id": 1, "name": "The Hobbit", "author": "J. R. R. Tolkien", "publish_at": "1937-09-21"},
      {"id": 2, "name": "Harry Potter", "author": "J. K. Rowling", "publish_at": "1997-12-01"}
    ]
  };

  class CategoryInfo with Mappable {
    int? id;
    String? name;
    List<BookInfo>? books;

    @override
    void mapping(Mapper map) {
      map("id", id, (v) => id = v);
      map("name", name, (v) => name = v);
      map<List<BookInfo>>("books", books, (v) => books = v);
    }
  }

  class BookInfo with Mappable {
    int? id;
    String? name;
    String? author;
    DateTime? publishAt;

    @override
    void mapping(Mapper map) {
      map("id", id, (v) => id = v);
      map("name", name, (v) => name = v);
      map("author", author, (v) => author = v);
      map("publish_at", publishAt, (v) => publishAt = v, DateTransform());
    }
  }

  Mappable.factories = {
    CategoryInfo: () => CategoryInfo(),
    BookInfo: () => BookInfo()
  };

  final category = Mapper.fromJson(json).toObject<CategoryInfo>();
  print(category!.toJson());
}

通过以上步骤和示例代码，你应该能够在 Flutter 应用中轻松地使用 object_mapper 进行对象与 JSON 之间的转换。