Flutter JSON模型转换插件convert_json_model的使用

安装

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

dependencies:
  convert_json_model: #最新版本
  build_runner: ^2.0.1
  json_annotation: ^4.0.1
  json_serializable: ^4.1.1

安装这些依赖可以通过运行pub get命令或者通过Dart VSCode/Android Studio的安装选项。

什么？为什么？怎么用？

什么

这是一个命令行工具，用于将.json文件转换为.dart模型文件，并最终生成.g.dart文件（使用json_serializable）。

为什么

问题

你可能有一个系统或后端REST应用程序，并且想要构建一个Dart应用。你可能开始创建数据模型。但是将Dart Map转换为其他格式需要额外的工作，因此你可以使用json_serializable，但仍然需要手动逐个输入模型。如果你有一个巨大的系统，需要大量的模型，那么编写所有的模型可能会让你感到压力。

解决方案

这个命令行工具可以让现有的.json文件转换为Dart（json_serializable）文件。

为什么不直接使用现有的命令行库json_model？

json_model非常棒，结构也很酷，但它不支持递归导入，这是我想要的功能。我还希望它能自动将变量名转换为驼峰命名法。我可以写一个issue并提交PR，但由于其代码结构不够清晰且可扩展性较差，而且我还看不懂它的注释，最后活跃在这个仓库的贡献者是在六月，我认为我不应该再等待了，所以我创建了一个新的工具。一些核心功能保持不变，但（也许）有更好的结构。

怎么做

它会遍历你的JSON文件，查找可能的类型、变量名、导入URI、装饰器和类名，并将其写入模板。 在项目根目录下创建/复制.json文件到./jsons/目录（默认），然后运行pub run convert_json_model。

示例

{
  "id": 2,
  "title": "Hello Guys!",
  "content": "$content",
  "tags": "$[]tag",
  "user_type": "[@enum](/user/enum):admin,app_user,normal",
  "auth_state": "[@enum](/user/enum):verified(2),authenticated(1),guest(0)",
  "user": "$../user/user",
  "published": true
}

命令

pub run convert_json_model

或者

flutter pub run convert_json_model

输出

import 'package:json_annotation/json_annotation.dart';
import 'content.dart';
import 'tag.dart';
import '../user/user.dart';

part 'examples.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class Examples {
      Examples();

  int id;
  String title;
  Content content;
  List<Tag> tags;
  ExamplesUserTypeEnum 
    get examplesUserTypeEnum => _examplesUserTypeEnumValues.map[userType];
    set examplesUserTypeEnum(ExamplesUserTypeEnum value) => userType = _examplesUserTypeEnumValues.reverse[value];
  [@JsonKey](/user/JsonKey)(name: 'user_type') String userType;
  ExamplesAuthStateEnum 
    get examplesAuthStateEnum => _examplesAuthStateEnumValues.map[authState]!;
    set examplesAuthStateEnum(ExamplesAuthStateEnum value) => authState = _examplesAuthStateEnumValues.reverse[value];
  [@JsonKey](/user/JsonKey)(name: 'auth_state') int authState;
  User user;
  bool published;

  factory Examples.fromJson(Map<String,dynamic> json) => _$ExamplesFromJson(json);
  Map<String, dynamic> toJson() => _$ExamplesToJson(this);
}

enum ExamplesUserTypeEnum { Admin, AppUser, Normal }
enum ExamplesAuthStateEnum { Verified, Authenticated, Guest }

final _examplesUserTypeEnumValues = _ExamplesUserTypeEnumConverter({
  'admin': ExamplesUserTypeEnum.Admin,
  'app_user': ExamplesUserTypeEnum.AppUser,
  'normal': ExamplesUserTypeEnum.Normal,
});

final _examplesAuthStateEnumValues = _ExamplesAuthStateEnumConverter({
  2: ExamplesAuthStateEnum.Verified,
  1: ExamplesAuthStateEnum.Authenticated,
  0: ExamplesAuthStateEnum.Guest,
});

class _ExamplesUserTypeEnumConverter<String, O> {
  Map<String, O> map;
  Map<O, String>? reverseMap;

  _ExamplesUserTypeEnumConverter(this.map);

  Map<O, String> get reverse => reverseMap ??= map.map((k, v) => MapEntry(v, k));
}

class _ExamplesAuthStateEnumConverter<int, O> {
  Map<int, O> map;
  Map<O, int>? reverseMap;

  _ExamplesAuthStateEnumConverter(this.map);

  Map<O, int> get reverse => reverseMap ??= map.map((k, v) => MapEntry(v, k));
}

开始使用

1. 在项目的根目录下创建一个名为jsons的目录（默认）。
2. 将所有或创建的json文件放入jsons目录。
3. 运行pub run convert_json_model。如果是Flutter项目，可以使用flutter packages pub run convert_json_model。

使用方法

该包将读取.json文件，并生成.dart文件，将值的类型作为变量类型，并将键作为变量名。

示例

你可以复制以下JSON，并使用pub run convert_json_model命令生成。

基本示例

源文件

./jsons/user.json

{
  "id": 2,
  "username": "John Doe",
  "blocked": false
}

生成的文件

./lib/models/user.dart

import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';
[@JsonSerializable](/user/JsonSerializable)()
class User {
      User();

  int id;
  String username;
  bool blocked;

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

之后，json_serializable会自动生成.g.dart文件。

./lib/models/user.g.dart

part of 'user.dart';
User _$UserFromJson(Map<String, dynamic> json) {
  return User()
    ..id = json['id'] as int
    ..username = json['username'] as String
    ..blocked = json['blocked'] as bool;
}

Map<String, dynamic> _$UserToJson(User instance) => <String, dynamic>{
      'id': instance.id,
      'username': instance.username,
      'blocked': instance.blocked,
    };

指定类型变量

你可以使用$来指定变量的类型。

源文件

./jsons/user.json

{
  "id": 2,
  "username": "John Doe",
  "blocked": false,
  "addresses": "$address" // 前缀 $
}

在这种情况下，$address类似于告诉生成器导入address.dart并将标题大小写的Address作为变量addresses的类型。

生成的文件

./lib/models/user.dart

import 'package:json_annotation/json_annotation.dart';
import 'address.dart';  // 自动导入
part 'user.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class User {
  User();
  int id;
  String username;
  bool blocked;
  Address addresses;  // $address 转换为 Address 类型
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

指定列表类型变量

你可以使用$[]来指定变量的列表类型。

源文件

./jsons/user.json

{
  "id": 2,
  "username": "John Doe",
  "blocked": false,
  "addresses": "$[]address" // 前缀 $[]
}

生成的文件

./lib/models/user.dart

import 'package:json_annotation/json_annotation.dart';
import 'address.dart'; // 编写地址作为导入
part 'user.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class User {
  User();
  int id;
  String username;
  bool blocked;
  List<Address> addresses; // 列表类型
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

使用json_serializable [@JsonKey](/user/JsonKey)

你可以在key中使用[@JsonKey](/user/JsonKey)来指定[@JsonKey](/user/JsonKey)。

源文件

./jsons/cart.json

{
  "[@JsonKey](/user/JsonKey)(ignore: true) dynamic": "md", // jsonKey别名
  "[@JsonKey](/user/JsonKey)(name: '+1') int": "loved", // jsonKey别名
  "name": "wendux",
  "age": 20
}

生成的文件

./lib/models/cart.dart

import 'package:json_annotation/json_annotation.dart';

part 'cart.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class Cart {
      Cart();

  [@JsonKey](/user/JsonKey)(ignore: true) dynamic md; // 生成jsonKey
  [@JsonKey](/user/JsonKey)(name: '+1') int loved; // 生成jsonKey
  String name;
  int age;

  factory Cart.fromJson(Map<String,dynamic> json) => _$CartFromJson(json);
  Map<String, dynamic> toJson() => _$CartToJson(this);
}

词汇表

实体

• imports: 导入语句字符串。从.json文件中获取前缀为$的值，后缀为.dart并插入import '$import';\n。
• fileName: 文件名。从.json文件中获取前缀为$的值，但非单词字符（\W）被移除，并转换为驼峰命名法。
• className: 类名。基本上是fileName，但转换为标题大小写。
• declarations: 声明语句字符串。基本上是<a href="https://github.com/linlak/convert_json_model/blob/master/lib/core/dart_declaration.dart" rel="ugc">DartDeclaration</a>对象的列表，并转换为toString()。
• enums: 任何标记为[@enum](/user/enum)的语句将被解析并添加到生成的dart语句中。
• enumConverters: 为了自动绑定枚举字符串值到实际枚举使用转换器。

模板

String defaultTemplate({
    imports,
    fileName,
    className,
    declarations,
    enums,
  }) =>  """
import 'package:json_annotation/json_annotation.dart';

$imports

part '$fileName.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class $className {
      $className();

  $declarations

  factory $className.fromJson(Map<String,dynamic> json) => _\$${className}FromJson(json);
  Map<String, dynamic> toJson() => _\$${className}ToJson(this);

}

$enums
""";