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閱讀 228,936評論 6 535
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,744評論 3 421
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,879評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,181評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,935評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,325評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,384評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,534評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,084評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,892評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,067評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,623評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,322評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,735評論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,990評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,800評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,084評論 2 375