Flutter JSON和序列化

此文注重梳理官方文档和整合实际开发的业务场景进行分析,巩固基础。

首先,Flutter中是否有GSON / Jackson / Moshi?官方文档明确表明--没有!且是禁用的,因为这些工具使用了反射机制,反射会默认使用Dark所有代码,让tree shaking会很难工作,运用文档所说的:\color{#FF0000}{这些工具无法知道哪些widget在运行时未被使用,因此冗余代码很难剥离。使用反射时,应用尺寸无法轻松的进行优化。}

使用 dart:convert手动序列化JSON

使用工具:Flutter有一个内置dart:convert库
关键代码:

  • User.fromJson 构造函数, 用于从一个map构造出一个 User实例 map structure
  • toJson 方法, 将 User 实例转化为一个map.

解析代码:

import 'dart:convert';
import 'package:flutter_test/flutter_test.dart';

class User {
  final String name;
  final String password;

  User(this.name, this.password);

  User.fromJson(Map<String, dynamic> json)
      : name = json['name'],
        password = json['password'];

  Map<String, dynamic> toJson() => {
        'name': name,
        'password': password,
      };
}

String jsonStr = "{\"name\": \"Hank\",\"password\": \"123456\"}";//解析数据

void main() {
  test('json test', () {
    Map userMap = json.decode(jsonStr);
    var user = new User.fromJson(userMap);

    print('name, ${user.name}!');
    print('password, ${user.password}.');
    print('user json, ${user.toJson()}.');
  });
}

运行以上代码时请务必注意该图标标志方可运行,否则报错。

运行结果

使用代码生成库序列化JSON

使用了json_serializable package包,它是一个自动化的源代码生成器。

pubspec.yaml

dependencies:
  # Your other regular dependencies here
  json_annotation: ^2.0.0

dev_dependencies:
  # Your other dev_dependencies here
  build_runner: ^1.0.0
  json_serializable: ^2.0.0

注意,yaml配置文件对于缩进要求十分严格,下面的build_runner和json_serializable应该
是dev_dependencies的一级子项,json_serializable千万不要写在build_runner缩进后,这样它会认为是build_runner的子集目录!
在项目根文件夹中运行 flutter packages get (或者在编辑器中点击 “Packages Get”) 以在项目中使用这些新的依赖项。

解析代码:

import 'dart:convert';
import 'package:flutter_test/flutter_test.dart';
import 'package:json_annotation/json_annotation.dart';

// user.g.dart 将在我们运行生成命令后自动生成
part 'user.g.dart';

@JsonSerializable()
class User {
  String name;
  String password;

  User(this.name, this.password);

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

  Map<String, dynamic> toJson() => _$UserToJson(this);
}

String jsonStr = "{\"name\": \"Hank\",\"password\": \"123456\"}";

void main() {
  test('json test', () {
    Map userMap = json.decode(jsonStr);
    var user = new User.fromJson(userMap);

    print('name, ${user.name}!');
    print('password, ${user.password}.');
    print('user json, ${user.toJson()}.');
  });
}

复制以上代码使用json_serializable第一次创建类时,您会看到与下图类似的错误。



这些错误是完全正常的,这是因为model类的生成代码还不存在。为了解决这个问题,我们必须运行代码生成器来为我们生成序列化模板。这就让我想起和Dagger一样需要预编译才可以调用生成类。

有两种运行代码生成器的方法:

一次性生成

通过在我们的项目根目录下运行flutter packages pub run build_runner build,我们可以在需要时为我们的model生成json序列化代码。 这触发了一次性构建,它通过我们的源文件,挑选相关的并为它们生成必要的序列化代码。
虽然这非常方便,但如果我们不需要每次在model类中进行更改时都要手动运行构建命令的话会更好。

持续生成

使用watcher可以使我们的源代码生成的过程更加方便。它会监视我们项目中文件的变化,并在需要时自动构建必要的文件。我们可以通过flutter packages pub run build_runner watch在项目根目录下运行来启动watcher
只需启动一次观察器,然后并让它在后台运行,这是安全的。

但是如果你运行了以上命令行均没有生成user.g.dart那可能你没有做到以下规范:

dart代码中User首字母可以大写,但是文件名字建议全部为小写,如user.dart,与User类名同名,生成代码的时候会匹配文件名和类名是否一致,否则无法生成user.g.dart。
当然如果已经有User类名能匹配到文件名后,在该文件再编写其他不同名的@JsonSerializable class也是能正常编译出来。

@JsonKey标注:
如果我们正在使用的API返回带有registration_date_millis字段,但我们想在我们的模型中使用registrationDateMillis

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

推荐阅读更多精彩内容