flutter json_serializable使用

最新推荐文章于 2025-06-14 09:46:43 发布

小豆子、

最新推荐文章于 2025-06-14 09:46:43 发布

阅读量1.2k

点赞数

CC 4.0 BY-SA版权

分类专栏： Flutter 文章标签： flutter json_serializable 序列化

本文链接：https://blog.youkuaiyun.com/Liu_xiaomo/article/details/96147884

Flutter 专栏收录该内容

1 篇文章

订阅专栏

本文介绍了如何在Flutter项目中使用json_serializable库进行JSON序列化和反序列化操作。首先，添加json_serializable依赖，然后根据接口返回的JSON创建实体类，并关联实体类文件。通过运行build_runner生成辅助解析文件。成功后，可以使用生成的_$HomeEntityFromJson和_$HomeEntityToJson方法方便地转换JSON数据为实体类对象及反之。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1，添加依赖

dependencies:
   json_annotation: ^2.4.0

dev_dependencies:
  build_runner: ^1.0.0
  json_serializable: ^3.0.0

2，根据接口返回json创建实体类

class HomeEntity {
	String authToken;
	bool showTask;
	int pendingCount;
	int waitCheckCount;
	int checkingCount;
	int checkfailCount;

	HomeEntity({this.authToken, this.pendingCount,this.checkfailCount,this.checkingCount,this.showTask,this.waitCheckCount});
}

3,关联实体类文件

part 'home_entity.g.dart';
@JsonSerializable(nullable: false)
class HomeEntity {
	String authToken;
	bool showTask;
	int pendingCount;
	int waitCheckCount;
	int checkingCount;
	int checkfailCount;

	HomeEntity({this.authToken, this.pendingCount,this.checkfailCount,this.checkingCount,this.showTask,this.waitCheckCount});
}

声明part 部分，当前项目目录下执行命令 flutter packages pub run build_runner build
Successed 后会发现dart文件目录下会生成”home_entity.g.dart“文件，这个”home_entity.g.dart“就是build_runner根据JsonSerializable生成的json解析文件，文件内容如下：

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'home_entity.dart';

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

HomeEntity _$HomeEntityFromJson(Map<String, dynamic> json) {
  return HomeEntity(
      authToken: json['authToken'] as String,
      pendingCount: json['pendingCount'] as int,
      checkfailCount: json['checkfailCount'] as int,
      checkingCount: json['checkingCount'] as int,
      showTask: json['showTask'] as bool,
      waitCheckCount: json['waitCheckCount'] as int);
}

Map<String, dynamic> _$HomeEntityToJson(HomeEntity instance) =>
    <String, dynamic>{
      'authToken': instance.authToken,
      'showTask': instance.showTask,
      'pendingCount': instance.pendingCount,
      'waitCheckCount': instance.waitCheckCount,
      'checkingCount': instance.checkingCount,
      'checkfailCount': instance.checkfailCount
    };

_$HomeEntityFromJson:它接收了一个map：Map<String, dynamic>，并将这个Map里的值映射为我们所需要的实体类对象。我们就可以使用这个方法，将存有json数据的map转化为我们需要的实体类对象。
_$HomeEntityToJson:将调用此方法的对象直接根据字段映射成Map。

4，实体类中添加fromJson 和 toJson方法

import 'package:json_annotation/json_annotation.dart';

part 'home_entity.g.dart';
@JsonSerializable(nullable: false)
class HomeEntity {
	String authToken;
	bool showTask;
	int pendingCount;
	int waitCheckCount;
	int checkingCount;
	int checkfailCount;

	HomeEntity({this.authToken, this.pendingCount,this.checkfailCount,this.checkingCount,this.showTask,this.waitCheckCount});

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

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