跨平台开发 / 系统课时

解析嵌套对象与列表

解析嵌套对象与列表

真实接口很少只有一层字段:响应体常同时包含对象、对象列表和更深的子对象。本节把一份多层 JSON 拆成多个 Freezed 模型,观察 fromJson 如何沿类型关系递归构建对象树,并用测试验证每一层都被正确解析。

学习目标

  • 为嵌套对象、对象列表和多层响应设计对应的 Freezed 类型。
  • 理解生成的 fromJson 何时调用子模型的 fromJson。
  • 用对象树中的深层字段验证解析结果,而不只检查最外层状态码。

先按 JSON 边界拆模型

假设接口返回项目详情与任务列表:

json
{
  "code": 0,
  "data": {
    "project": {
      "id": 7,
      "name": "Atlas",
      "owner": {
        "id": 2,
        "name": "Mina"
      }
    },
    "tasks": [
      {
        "id": 101,
        "title": "Parse API",
        "tags": ["dart", "json"]
      },
      {
        "id": 102,
        "title": "Render screen",
        "tags": ["flutter"]
      }
    ]
  }
}

不要把整份响应塞进一个巨大模型。更稳妥的边界是:根节点对应 ProjectResponse,data 对应 ProjectData,项目、负责人和任务分别拥有自己的类型。这样任意子对象结构变化时,影响范围更容易定位。

嵌套 JSON 到 Freezed 对象树的映射

为每个对象提供 fromJson

下面是片段示例,文件为 lib/project_response.dart。它依赖项目已经完成 Freezed 与 json_serializable 的基础配置;每一个需要从 JSON 创建的类型都显式声明自己的 fromJson。

dart
import 'package:freezed_annotation/freezed_annotation.dart';

part 'project_response.freezed.dart';
part 'project_response.g.dart';

@freezed
abstract class ProjectResponse with _$ProjectResponse {
  const factory ProjectResponse({
    required int code,
    required ProjectData data,
  }) = _ProjectResponse;

  factory ProjectResponse.fromJson(Map<String, dynamic> json) =>
      _$ProjectResponseFromJson(json);
}

@freezed
abstract class ProjectData with _$ProjectData {
  const factory ProjectData({
    required Project project,
    required List<TaskItem> tasks,
  }) = _ProjectData;

  factory ProjectData.fromJson(Map<String, dynamic> json) =>
      _$ProjectDataFromJson(json);
}

@freezed
abstract class Project with _$Project {
  const factory Project({
    required int id,
    required String name,
    required UserSummary owner,
  }) = _Project;

  factory Project.fromJson(Map<String, dynamic> json) =>
      _$ProjectFromJson(json);
}

@freezed
abstract class UserSummary with _$UserSummary {
  const factory UserSummary({
    required int id,
    required String name,
  }) = _UserSummary;

  factory UserSummary.fromJson(Map<String, dynamic> json) =>
      _$UserSummaryFromJson(json);
}

@freezed
abstract class TaskItem with _$TaskItem {
  const factory TaskItem({
    required int id,
    required String title,
    required List<String> tags,
  }) = _TaskItem;

  factory TaskItem.fromJson(Map<String, dynamic> json) =>
      _$TaskItemFromJson(json);
}

关键不在于手动调用五次 fromJson。当 ProjectResponse.fromJson 处理 data 时,生成代码根据字段类型调用 ProjectData.fromJson;ProjectData 再处理 Project 和 List<TaskItem>,继续构建下一层对象。前提是字段类型不能偷懒写成 dynamic 或未经约束的 Map<String, dynamic>,否则生成器失去了应该创建哪个子模型的信息。

验证完整对象树

只断言 response.code == 0 不能证明嵌套解析正确。更有效的测试是直接读取深层对象、列表元素和列表内的基础类型。

dart
import 'dart:convert';

import 'package:flutter_test/flutter_test.dart';
import 'package:your_app/project_response.dart';

void main() {
  test('parses nested objects and object lists', () {
    final json = jsonDecode('''
{
  "code": 0,
  "data": {
    "project": {
      "id": 7,
      "name": "Atlas",
      "owner": {"id": 2, "name": "Mina"}
    },
    "tasks": [
      {"id": 101, "title": "Parse API", "tags": ["dart", "json"]},
      {"id": 102, "title": "Render screen", "tags": ["flutter"]}
    ]
  }
}
''') as Map<String, dynamic>;

    final response = ProjectResponse.fromJson(json);

    expect(response.data.project.owner.name, 'Mina');
    expect(response.data.tasks.map((item) => item.id).toList(), [101, 102]);
    expect(response.data.tasks.first.tags, ['dart', 'json']);
  });
}

把 your_app 改成项目实际包名,然后生成代码并运行测试:

bash
dart run build_runner build --delete-conflicting-outputs
flutter test test/project_response_test.dart

预期结果

text
生成步骤正常结束,并创建或更新 project_response.freezed.dart 与 project_response.g.dart。
<TIME> +1: All tests passed!

<TIME> 是动态值。测试通过意味着根响应、嵌套项目、负责人对象、任务对象列表以及任务中的字符串列表都已经进入类型安全的 Dart 对象树。

解析失败时按层定位

遇到 type 'Null' is not a subtype of type ... 或类型转换错误时,不要先怀疑最外层 fromJson。应从报错字段所在层向原始 JSON 对照:字段是否缺失、是否允许为 null、数组元素是不是对象、数字和字符串类型是否与模型一致。

如果接口确实允许字段缺失,就在对应模型上表达可空或默认值;如果接口字段可能同时出现多种结构,则应使用自定义转换器,而不是把整个分支改成 dynamic。保持每一层类型明确,才能让生成器持续替你完成递归解析并尽早暴露接口结构变化。

按自己的节奏,确认真正理解。

目录与阅读设置

记录一个想法

解析嵌套对象与列表

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通