Flutter Quill 文档格式解析错误解决方案

在使用 Flutter Quill 富文本编辑器时，开发者可能会遇到一个常见的错误："type '_Map<String, dynamic>' is not a subtype of type 'List'"。这个错误通常发生在尝试将 JSON 数据加载到 Quill 编辑器时。

问题根源

这个错误的根本原因在于 Flutter Quill 的文档数据结构要求。Quill 编辑器期望接收的是一个 Delta 格式的 JSON 数组，而不是单个 JSON 对象。Delta 是 Quill 编辑器使用的一种操作格式，用于描述文档内容的变化。

正确与错误的格式对比

错误格式：

{"insert":"hello\n"}

正确格式：

[{"insert":"hello\n"}]

解决方案

1. 确保 JSON 数据格式正确：所有传递给 Quill 控制器的 JSON 数据必须是数组格式，即使只有一个操作。

2. 修改代码示例：

import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:flutter_quill/flutter_quill.dart';

final QuillController _controller = QuillController.basic();
// 注意这里使用了数组格式
final json = jsonDecode(r'[{"insert":"hello\n"}]');
_controller.document = Document.fromJson(json);

3. 理解 Delta 格式：Delta 格式由一系列操作组成，每个操作都是一个对象，整个 Delta 是一个数组。例如：

[
  {"insert": "Hello "},
  {"insert": "World", "attributes": {"bold": true}},
  {"insert": "\n"}
]

深入理解

Flutter Quill 使用 Delta 格式来表示文档内容，这种格式源自 Quill.js 的设计。Delta 是一种简洁的方式来表示富文本内容及其格式。每个 Delta 操作可以包含：

• insert：要插入的文本或嵌入内容
• attributes：可选的格式属性（如粗体、斜体等）
• delete：删除操作（用于表示删除的字符数）

当开发者遇到类型不匹配的错误时，应该首先检查数据结构是否符合 Delta 格式规范。这种格式要求不仅适用于初始化文档，也适用于后续的所有文档操作和更新。

最佳实践

1. 在开发过程中，可以使用 Quill 提供的工具函数验证 Delta 格式是否正确。

2. 对于从服务器获取的内容，建议在解析前先验证数据结构。

3. 在团队协作中，确保前后端开发人员都了解 Quill 的 Delta 格式要求。

通过理解这些概念和遵循正确的格式要求，开发者可以避免这类类型错误，并充分利用 Flutter Quill 的强大功能来构建富文本编辑体验。