Flutter 使用 json_serializable 解析 JSON 最佳方案

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

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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,711评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,932评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,770评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,799评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,697评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,069评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,535评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,200评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,353评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,290评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,331评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,020评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,610评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,694评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,927评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,330评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,904评论 2 341