Flutter 使用 json_serializable 解析 JSON 最佳方案

·  阅读 643

Flutter 官方推荐的 json_serializable JSON 解析方案,之前感觉比较麻烦就没有使用,使用的是通过 app.quicktype.io 在线生成,具体可以查看之前写的一篇介绍文章: juejin.cn/post/693126…

app.quicktype.io 迟迟不支持空安全,我们又把解析方案换成了 FlutterJsonBeanFactory,这个插件会对 JSON 数据类型进行兼容处理,是个不错的亮点。

最近 FlutterJsonBeanFactory 也出现了一些小问题,生成的类中会导入不相关的包,这让我开始重新考虑官方方案。

毕竟官方方案一直有专人维护,功能也最全。

首页,我们先 介绍一下使用官方方案的步骤:

一、在 pubspec.yaml 文件中添加依赖

dependencies:
  json_annotation: ^4.5.0
 
dev_dependencies:
  json_serializable: ^6.2.0
  build_runner: ^2.1.11
复制代码

二、手动创建模型类

import 'package:json_annotation/json_annotation.dart';
 
part 'user.g.dart';
 
@JsonSerializable()
class User {
  User({
    this.name,
    this.email,
    this.userId,
  });
 
  String? name;
  String? email;
  @JsonValue("user_id") 
  String? userId;
 
   
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
 
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

复制代码

字段少的话,还可以接受,如果有几十个字段,这块就很耗时间,这个也是我们之前没有选择官方方案的原因

三、执行构建命令

然后执行命令 flutter pub run build_runner build ,就可以生成解析 JSON 的代码。

最近几天,我发现一个插件:AutoJson

这个插件可以自动执行 flutter pub run build_runner build 命令,这给了我一个想法:那有没有一个插件,能够把上面三个步骤都给执行了?

就像 Android 开发者使用的 GsonFormat 一样,输入类名,复制 JSON 数据到输入框。然后点击确定按钮,能够帮我们把上面三个步骤给自动执行了,那我们在使用官方方案时,不就省事省力了?

我搜索了一圈,居然没有发现这样的插件。

由于我就借鉴(chaoxi)一些插件,开发了一个可以自动生成 json_serializable Android Studio 插件,目前插件已经上传,在 Android Studio Plugin 搜索 FlutterJsonToDart 即可下载使用

插件功能截图:

fluttertodart.gif

插件介绍:

  • 输入 JSON 数据自动生成带 json_serializable 注解的 dart 模型类
  • 如果 pubspec.yaml 文件中没有添加 json_annotation、json_serializable、build_runner 依赖,会自动帮你添加
  • 自动执行命令 flutter pub run build_runner build --delete-conflicting-outputs

这个插件可以帮助大家简化使用 json_serializable,底层解析逻辑是 json_serializable 来处理的,这样即便以后不使用该插件,相关代码不受影响。

如果对插件生成的模型类,不满意,可以自己进行调整:比如一些状态字段改成枚举,或者有些模型类已经定义过,想进行复用。

修改完字段后,你可以通过快捷键 alt + j 或者通过菜单 Build -> Run flutter pub run build_runner watch 运行 watch 命令,在后台监控字段变化,如果字段发生变化,它会重新生成 xxx.g.dart。

如果大家对使用 json_serializable 有什么问题,也可以在评论中留言,后续有时间,我可以把使用 json_serializable 遇到的一些问题分享出来。

致谢:

  1. 输入框参考的是这个插件 FlutterJsonBeanFactory  
  2. 执行 flutter 命令参考的是这个插件 AutoJson 
  3. 判断 pubspec.yaml 中是否已经添加依赖参考这个插件:FlutterPubVersionChecker
分类:
Android
标签:
分类:
Android
标签:
收藏成功!
已添加到「」, 点击更改