Flutter JSON 解析最佳实践

这篇文章其实早该写了,之前的业余时间一直花在开源项目或其它文章上了。

JSON 解析对于 Flutter 新人来讲是个绕不开的话题,大家都在吐槽 Flutter 没有反射,导致 JSON 解析无法像 Android 那样方便,其实是不必要的,因为可以做到一样方便。

网上讲 JSON 解析的文章很多,大家自行去学习即可,本篇文章直接给出我创造出的、我认为的最佳方案,如有雷同,纯属巧合:

使用 JsonToDart 插件自动生成 Bean 类,再使用 dynamic 关键字的能力,自动将 JSON 字符串代表的数据填充到 Bean 类中

我们以如下 JSON 文本为例:

{
    "nickName": "hackware",
    "realName": "陈方兵",
    "age": 29,
    "sex": "男"
}

这是个 Person 对象的描述,我们先使用 JsonToDart 插件将其转换成 Bean 类,这样我们就无需手写解析代码了:

Snipaste_2022-07-02_07-31-58.png
Snipaste_2022-07-02_07-33-45.png

生成的 Bean 类代码如下:

class Person {
  Person({
    this.nickName,
    this.realName,
    this.age,
    this.sex,
  });

  Person.fromJson(dynamic json) {
    nickName = json['nickName'];
    realName = json['realName'];
    age = json['age'];
    sex = json['sex'];
  }

  String? nickName;
  String? realName;
  int? age;
  String? sex;

  Map<String, dynamic> toJson() {
    final map = <String, dynamic>{};
    map['nickName'] = nickName;
    map['realName'] = realName;
    map['age'] = age;
    map['sex'] = sex;
    return map;
  }
}

这段代码最核心的是 fromJson 这个构造函数,由于 Flutter 中没有反射,我们无法动态的调用 fromJson 方法。但我们可以先构造一个空的 Person 对象,再使用 dynamic 关键字调用它,但需要对 fromJson 做一下更改,将它从构造函数改为普通函数,如下:

Person fromJson(dynamic json) {
  nickName = json['nickName'];
  realName = json['realName'];
  age = json['age'];
  sex = json['sex'];
  return this;
}

或是:

void fromJson(dynamic json) {
  nickName = json['nickName'];
  realName = json['realName'];
  age = json['age'];
  sex = json['sex'];
}

真正的解析代码如下:

String jsonData = ''; // 从网络加载的 JSON 文本
Person person = Person().fromJson(jsonDecode(jsonData));

我想说明的是:使用反射自动创建对象和手动创建对象后再自动为该对象填充数据是一样方便的。因此即便没有反射,我们也能对网络请求做很好的封装。

目前由于我用的是自创的 PVState 架构模式,它是 MVC 的改进版,它也是个轻量级的状态管理方案。只有不到 120 行代码。它分为 PState 和 VState,这里的 State 指的是 StatefulWidget 的 State。前者封装业务逻辑,后者描述 UI,UI 和业务逻辑可以完全隔离。我把网络请求的基础能力封装到了 BasePState 中,如下:

void sendRequest<BEAN>({
  required Future<Response<String>> call,
  required BEAN bean,
  OnStartCallback? startCallback,
  OnSuccessCallback<BEAN>? successCallback,
  OnFailCallback<BEAN>? failCallback,
}) async {
  startCallback?.call();
  bool? success;
  Object? exception;
  try {
    Response<String> resp = await call;
    dynamic result = (bean as dynamic).fromJson(jsonDecode(resp.data!));
    success = result.success;
  } catch (e) {
    debugPrint('$e');
    exception = e;
  } finally {
    try {
      if (success == true) {
        successCallback?.call(bean);
      } else {
        failCallback?.call(bean, exception);
      }
    } catch (e) {
      exception = e;
      failCallback?.call(bean, exception);
    }
  }
}

真正发起请求的代码如下:

sendRequest(
  call: dio.get(
    'https://xxx',
  ),
  bean: RealtimeAlarmListBean(),
  startCallback: () {
    setState(() {
      loadingRealtimeAlarm = true;
    });
  },
  successCallback: (RealtimeAlarmListBean bean) {
    setState(() {
      realtimeAlarmListBean = bean;
      loadingRealtimeAlarm = false;
    });
  },
  failCallback: (_, __) {
    setState(() {
      loadingRealtimeAlarm = false;
      showToast('请求失败');
    });
  },
);

可见我在外部构造好了空的 Bean 对象传进去,当请求回来后会把数据填充进去,最后在 successCallback 再把非空的 Bean 对象回传回来。整个过程我没有手动对 JSON 做解析。是不是挺方便的呢?

我比较喜欢这种网络模块的封装模式,当然你也可以使用 async、await 做“同步”的封装,萝卜青菜各有所爱吧。

这是目前我看到的最好的 JSON 解析方法,如果你有更好的方法,欢迎在评论区交流哦!我是中国第一位 Android & Flutter 双料 GDFE,关注我的公众号:FlutterFirst,带你起飞!我们下期见。

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

推荐阅读更多精彩内容