flutter demo (三):json处理

使用过Gson等json库的开发者应该知道,这种json解析库使用起来相当方便,你只需创建好实体类,用一两行代码就能实现把java对象转化成json字符串,以及把json字符串转化成java对象。

在flutter里也有类似的库吗?
官方的回答是:并没有。链接:https://flutter.io/json/#is-there-a-gsonjacksonmoshi-equivalent-in-flutter

解决办法:

方法一

手写。
参考: https://flutter.io/cookbook/networking/fetch-data/

class Post {
  final int userId;
  final int id;
  final String title;
  final String body;

  Post({this.userId, this.id, this.title, this.body});

  factory Post.fromJson(Map<String, dynamic> json) {
    return Post(
      userId: json['userId'],
      id: json['id'],
      title: json['title'],
      body: json['body'],
    );
  }
}

使用方法:

Future<Post> fetchPost() async {
  final response =
      await http.get('https://jsonplaceholder.typicode.com/posts/1');

  if (response.statusCode == 200) {
    // If server returns an OK response, parse the JSON
    return Post.fromJson(json.decode(response.body));
  } else {
    // If that response was not OK, throw an error.
    throw Exception('Failed to load post');
  }
}

json.decode方法源自dart:convert,它可以将json字符串转化成Map<String, dynamic>的类型。

缺点:如果接口里的属性比较多,写起来相当繁琐,而且容易出错。

方法二

使用https://github.com/debuggerx01/JSONFormat4Flutter 这样的第三方json2bean的代码生成工具。

缺点:生成的类里的部分方法可能不符合你的需求,需要手动做一些调整。

方法三:

使用json_annotation + json_serializable。

首先给项目添加依赖:

dependencies:
  flutter:
    sdk: flutter
  cupertino_icons: ^0.1.2
  fluttertoast: ^2.0.3
  json_annotation: ^0.2.3

dev_dependencies:
  flutter_test:
    sdk: flutter

  build_runner: ^0.8.0
  json_serializable: ^0.5.0

我个人的经验是:添加依赖后,不要手动的去点界面上的“packages get”,容易卡住,控制台只显示一句“Running "flutter packages get" in xxxx”,过了很久都没有任何反应。

建议到Terminal窗口手动输入“flutter packages get”去运行。这样的好处是可以随时用Ctrl+C取消命令。
如果下载不下来依赖库,试试给Android Studio添加一下http代理。同时检查一下代理是否能连得上官网“https://pub.dartlang.org”。

微信截图_20180714164513.png

创建实体类

假设json结构如下:

{
  "name":"book1",
  "author":{"name":"Jack"},
  "publishDate":"2018-10-10",
  "publisher":"xxx company"
}

创建实体类:
Book.dart:

import 'package:flutter_app2/json/Author.dart';
import 'package:json_annotation/json_annotation.dart';

part 'Book.g.dart';

@JsonSerializable()
class Book extends Object with _$BookSerializerMixin {
  String name;
  Author author;
  String publishDate;
  String publisher;


  Book(this.name, this.author, this.publishDate, this.publisher);

  @override
  String toString() {
    return 'Book{name: $name, author: $author, publishDate: $publishDate, publisher: $publisher}';
  }
  factory Book.fromJson(Map<String, dynamic> json) => _$BookFromJson(json);
}

Author.dart

import 'package:json_annotation/json_annotation.dart';
part 'Author.g.dart';
@JsonSerializable()
class Author extends Object with _$AuthorSerializerMixin {
  String name;

  Author(this.name);

  @override
  String toString() {
    return 'Author{name: $name}';
  }
  factory Author.fromJson(Map<String, dynamic> json) => _$AuthorFromJson(json);

}

自动生成json解析代码

在Terminal窗口运行

flutter packages pub run build_runner build

就能看到自动生成了Author.g.dart和Book.g.dart两个文件。

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'Author.dart';

// **************************************************************************
// JsonSerializableGenerator
// **************************************************************************

Author _$AuthorFromJson(Map<String, dynamic> json) =>
    new Author(json['name'] as String);

abstract class _$AuthorSerializerMixin {
  String get name;
  Map<String, dynamic> toJson() => <String, dynamic>{'name': name};
}

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'Book.dart';

// **************************************************************************
// JsonSerializableGenerator
// **************************************************************************

Book _$BookFromJson(Map<String, dynamic> json) => new Book(
    json['name'] as String,
    json['author'] == null
        ? null
        : new Author.fromJson(json['author'] as Map<String, dynamic>),
    json['publishDate'] as String,
    json['publisher'] as String);

abstract class _$BookSerializerMixin {
  String get name;
  Author get author;
  String get publishDate;
  String get publisher;
  Map<String, dynamic> toJson() => <String, dynamic>{
        'name': name,
        'author': author,
        'publishDate': publishDate,
        'publisher': publisher
      };
}

使用

      var book = new Book("book1", new Author("Jack"), "2018-10-10", "xxx company");
      print("book="+book.toString());
      String jsonStr= json.encode(book);
      print("json="+jsonStr);
      var bookAfter= Book.fromJson(json.decode(jsonStr));
      print("from json="+bookAfter.toString());

注意要使用json.encode和json.decode,需要引入:

import 'dart:convert';

打印结果:

 book=Book{name: book1, author: Author{name: Jack}, publishDate: 2018-10-10, publisher: xxx company}
 json={"name":"book1","author":{"name":"Jack"},"publishDate":"2018-10-10","publisher":"xxx company"}
 from json=Book{name: book1, author: Author{name: Jack}, publishDate: 2018-10-10, publisher: xxx company}

总结

这种方式是官方目前推荐的方案。

另外,执行

flutter packages pub run build_runner watch

可以实现文件监听,自动地为你后续创建的实体类生成对应的解析代码。

我尝试了一下这个命令,以下是操作步骤:

新建一个Animal.dart
添加 import 'package:json_annotation/json_annotation.dart';
添加 part 'Animal.g.dart';
添加继承关系 extends Object with _$AnimalSerializerMixin
添加各种属性

添加一行代码:     
    factory Animal.fromJson(Map<String, dynamic> json) => _$AnimalFromJson(json);

发现Terminal控制台提示"Unsupported operation: The class `Animal` has no default constructor."

手动创建一个构造函数

发现 Animal.g.dart 已经自动生成成功。

效果还算不错。

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