Flutter JSON轉(zhuǎn)Model實戰(zhàn)

一、前言

在原生應(yīng)用開發(fā)中,我們通常會使用YYModel港柜、SwiftyJSONGSON等庫實現(xiàn)JSON解析,并使用JSONConverter等類似工具實現(xiàn)JSON自動轉(zhuǎn)模型夏醉,極大的提高工作效率爽锥。
但在Flutter開發(fā)中,卻并沒有類似的解析庫給我們使用畔柔,因為這樣的庫需要使用運行時反射氯夷,這在Flutter中是禁用的。運行時反射會干擾Darttree shaking靶擦,使用_tree shaking_腮考,可以在release版中“去除”未使用的代碼,這可以顯著優(yōu)化應(yīng)用程序的大小玄捕。由于反射會默認(rèn)應(yīng)用到所有代碼踩蔚,因此_tree shaking_會很難工作,因為在啟用反射時很難知道哪些代碼未被使用桩盲,因此冗余代碼很難剝離寂纪,所以Flutter中禁用了Dart的反射功能席吴,而正因如此也就無法實現(xiàn)動態(tài)轉(zhuǎn)化Model的功能赌结。

二、json_serializable

雖然不能在Flutter中使用運行時反射孝冒,但官方提供了類似易于使用的API柬姚,它是基于代碼生成庫實現(xiàn),json_serializable package庄涡,它是一個自動化的源代碼生成器量承,可以生成JSON序列化模板,由于序列化代碼無需手寫和維護(hù)穴店,將運行時產(chǎn)生JSON序列化異常的風(fēng)險降至最低撕捍,使用方法如下:

1. 在項目中添加json_serializable

要包含json_serializable到我們的項目中,需要一個常規(guī)和兩個開發(fā)依賴項泣洞。簡而言之忧风,開發(fā)依賴項是不包含在我們的應(yīng)用程序源代碼中的依賴項。
通過此鏈接可以查看這些所需依賴項的最新版本 球凰。


在您的項目根文件夾中運行flutter packages get(或者在編輯器中點擊 Packages Get) 以在項目中使用這些新的依賴項.

2. 以json_serializable的方式創(chuàng)建model類

讓我們看看如何將我們的User類轉(zhuǎn)換為一個json_serializable狮腿。為了簡單起見,我們使用前面示例中的簡化JSON model呕诉。

  • user.dart
import 'package:json_annotation/json_annotation.dart';

// user.g.dart 將在我們運行生成命令后自動生成
part 'user.g.dart';

///這個標(biāo)注是告訴生成器缘厢,這個類是需要生成Model類的
@JsonSerializable()
class User {
  String name;
  String email;

  User(this.name, this.email);

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

有了這個設(shè)置,源碼生成器將生成用于序列化nameemail字段的JSON代碼甩挫。

如果需要贴硫,自定義命名策略也很容易。例如伊者,如果我們正在使用的API返回帶有snake_case的對象英遭,但我們想在我們的模型中使用lowerCamelCase拖刃, 那么我們可以使用@JsonKey標(biāo)注:

@JsonKey(name: 'registration_date_millis')
final int registrationDateMillis;

3. 運行代碼生成程序

  • 一次性生成

通過在我們的項目根目錄下運行flutter packages pub run build_runner build,我們可以在需要時為我們的Model生成JSON序列化代碼贪绘。 這觸發(fā)了一次性構(gòu)建兑牡,它通過我們的源文件,挑選相關(guān)的并為它們生成必要的序列化代碼税灌。

  • 持續(xù)生成

雖然這非常方便均函,但如果我們不需要每次在model類中進(jìn)行更改時都要手動運行構(gòu)建命令的話會更好。
使用watcher可以使我們的源代碼生成的過程更加方便菱涤。它會監(jiān)視我們項目中文件的變化苞也,并在需要時自動構(gòu)建必要的文件。我們可以通過flutter packages pub run build_runner watch在項目根目錄下運行來啟動watcher粘秆。
只需啟動一次觀察器如迟,然后并讓它在后臺運行,這是安全的

4. 使用json_serializable模型

要通過json_serializable方式反序列化JSON字符串攻走,我們不需要對先前的代碼進(jìn)行任何更改殷勘。

Map userMap = JSON.decode(json);
var user = new User.fromJson(userMap);

序列化也一樣。調(diào)用API與之前相同昔搂。

String json = JSON.encode(user);

有了json_serializable玲销,我們只需要編寫User類文件 。源代碼生成器創(chuàng)建一個名為user.g.dart的文件摘符,它具有所有必需的序列化邏輯贤斜。 現(xiàn)在,我們不必編寫自動化測試來確保序列化的正常工作 - 這個庫會確保序列化工作正常逛裤。

三瘩绒、 JSONConverter

如上面所寫,即便使用了json_serializable带族,仍然需要手動編寫模型類文件并逐一編寫對應(yīng)的模型屬性锁荔,生產(chǎn)工作中一個項目可能會有幾百個API, 如果全部手寫依舊浪費大量摸魚的時間,這里我們可以使用JSONConverter, 它可根據(jù)后臺返回的JSON自動生成模型文件炉菲,配合json_serializable堕战,可以非常方便的實現(xiàn)接口對接,模型文件一鍵生成拍霜,極大節(jié)省程序員的體力嘱丢。


另外JSONConverter除了支持Flutter,還支持其他語言和第三方庫祠饺,功能可能說非常豐富了越驻。

四、總結(jié)

生產(chǎn)項目中推薦使用json_serializable + JSONConverter 完成服務(wù)端返回的JSON數(shù)據(jù)解析工作,效率翻倍!!

五月幌、參考

[Flutter] 08-Flutter中的Json轉(zhuǎn)Model
Flutter的Json和Model轉(zhuǎn)換
效率翻倍妹窖!大型Flutter項目快速實現(xiàn)JSON轉(zhuǎn)Model實戰(zhàn)

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末忌穿,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖刽射,帶你破解...
    沈念sama閱讀 217,509評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異剃执,居然都是意外死亡誓禁,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評論 3 394
  • 文/潘曉璐 我一進(jìn)店門肾档,熙熙樓的掌柜王于貴愁眉苦臉地迎上來摹恰,“玉大人,你說我怎么就攤上這事怒见∷状龋” “怎么了?”我有些...
    開封第一講書人閱讀 163,875評論 0 354
  • 文/不壞的土叔 我叫張陵速种,是天一觀的道長姜盈。 經(jīng)常有香客問我,道長配阵,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,441評論 1 293
  • 正文 為了忘掉前任示血,我火速辦了婚禮棋傍,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘难审。我一直安慰自己瘫拣,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,488評論 6 392
  • 文/花漫 我一把揭開白布告喊。 她就那樣靜靜地躺著麸拄,像睡著了一般。 火紅的嫁衣襯著肌膚如雪黔姜。 梳的紋絲不亂的頭發(fā)上拢切,一...
    開封第一講書人閱讀 51,365評論 1 302
  • 那天,我揣著相機(jī)與錄音秆吵,去河邊找鬼淮椰。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的主穗。 我是一名探鬼主播泻拦,決...
    沈念sama閱讀 40,190評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼忽媒!你這毒婦竟也來了争拐?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,062評論 0 276
  • 序言:老撾萬榮一對情侶失蹤晦雨,失蹤者是張志新(化名)和其女友劉穎陆错,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體金赦,經(jīng)...
    沈念sama閱讀 45,500評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡音瓷,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,706評論 3 335
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了夹抗。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片绳慎。...
    茶點故事閱讀 39,834評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖漠烧,靈堂內(nèi)的尸體忽然破棺而出杏愤,到底是詐尸還是另有隱情,我是刑警寧澤已脓,帶...
    沈念sama閱讀 35,559評論 5 345
  • 正文 年R本政府宣布珊楼,位于F島的核電站,受9級特大地震影響度液,放射性物質(zhì)發(fā)生泄漏厕宗。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,167評論 3 328
  • 文/蒙蒙 一堕担、第九天 我趴在偏房一處隱蔽的房頂上張望已慢。 院中可真熱鬧,春花似錦霹购、人聲如沸佑惠。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,779評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽膜楷。三九已至,卻和暖如春贞奋,著一層夾襖步出監(jiān)牢的瞬間赌厅,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,912評論 1 269
  • 我被黑心中介騙來泰國打工忆矛, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留察蹲,地道東北人请垛。 一個月前我還...
    沈念sama閱讀 47,958評論 2 370
  • 正文 我出身青樓,卻偏偏與公主長得像洽议,于是被迫代替她去往敵國和親宗收。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,779評論 2 354

推薦閱讀更多精彩內(nèi)容