Flutter Quill 富文本编辑器中的列表样式问题分析与解决方案

问题背景

Flutter Quill 是一款基于 Flutter 框架的富文本编辑器组件，它提供了丰富的文本编辑功能。在最近的版本更新中，开发者报告了一个关于列表样式（特别是编号列表）的渲染问题。当普通文本与编号列表混合使用时，列表的编号和间距会出现异常行为。

问题现象

用户在使用 Flutter Quill 编辑器时发现：

1. 当普通文本后跟随编号列表时，列表的编号顺序不正确
2. 列表项之间会出现不必要的空白
3. 生成的 Delta 格式数据中，列表项的格式不符合预期

技术分析

Delta 格式规范

Flutter Quill 使用 Delta 格式作为其底层数据表示。Delta 是一种简洁的格式，用于描述文档内容及其格式变化。在 Delta 格式中：

• 行内属性：直接应用于文本内容，如加粗、斜体、颜色等
• 块级属性：应用于整个段落或块，如列表、引用块、代码块等，必须与换行符(\n)一起使用

问题根源

通过分析开发者提供的 Delta 数据样例，发现问题出在块级属性的应用方式上。错误的 Delta 格式示例如下：

{"insert":"First\n","attributes":{"list":"bullet"}}

而正确的格式应该是：

{"insert":"First"},
{"insert":"\n","attributes":{"list":"bullet"}}

这种格式错误导致 HTML 转换时出现<li><br/></li>这样的无效列表项，从而影响最终渲染效果。

解决方案

临时解决方案

对于急需解决问题的开发者，可以使用以下函数对 Delta 数据进行预处理：

List<Map<String, dynamic>> transformArray(List<dynamic> inputArray) {
    final List<Map<String, dynamic>> result = <Map<String, dynamic>>[];
    for (final dynamic item in inputArray) {
      if (item is Map<String, dynamic>) {
        if (item.containsKey("attributes") && item["attributes"] != null) {
          if (item["attributes"]["list"] == "ordered" || item["attributes"]["list"] == "bullet") {
            result
              ..add(<String, dynamic>{"insert": item["insert"].replaceAll("\n", "")})
              ..add(<String, dynamic>{
                "insert": "\n",
                "attributes": <String, dynamic>{"list": item["attributes"]["list"]}
              });
          } else {
            result.add(item);
          }
        } else {
          result.add(item);
        }
      }
    }
    return result;
}

更优的解决方案

对于需要更健壮处理的情况，可以使用 Delta 反规范化(denormalize)方法：

extension DeltaDenormilazer on Delta {
  Delta fullDenormalizer() {
    if (isEmpty) return this;

    final List<Map<String, dynamic>> denormalizedOps =
        map<List<Map<String, dynamic>>>((Operation op) => denormalize(op.toJson())).flattened.toList();
    return Delta.fromOperations(denormalizedOps.map<fq.Operation>((Map<String, dynamic> e) => fq.Operation.fromJson(e)).toList());
  }

  List<Map<String, dynamic>> denormalize(Map<String, dynamic> op) {
    const String newLine = '\n';
    final insertValue = op['insert'];
    if (insertValue is Map || insertValue == newLine) {
      return <Map<String, dynamic>>[op];
    }

    final List<String> newlinedArray = tokenizeWithNewLines(insertValue.toString());

    if (newlinedArray.length == 1) {
      return <Map<String, dynamic>>[op];
    }

    final Map<String, dynamic> nlObj = <String, dynamic>{
      ...op,
      ...<String, String>{'insert': newLine}
    };

    return newlinedArray.map((String line) {
      if (line == newLine) {
        return nlObj;
      }
      return <String, dynamic>{
        ...op,
        ...<String, String>{'insert': line},
      };
    }).toList();
  }
}

最佳实践建议

1. 更新到最新版本：Flutter Quill 团队已在最新版本中修复了相关问题
2. 正确使用块级属性：确保块级属性只应用于换行符操作
3. 测试数据转换：在将 Delta 数据转换为其他格式(如HTML)前，先验证其结构是否正确
4. 考虑使用反规范化：对于复杂场景，使用反规范化方法可以确保数据格式的一致性

总结

Flutter Quill 作为一款功能强大的富文本编辑器，其底层数据格式的正确理解和使用至关重要。通过本文的分析和解决方案，开发者可以更好地处理列表样式相关的问题，确保富文本内容在各种场景下都能正确渲染。随着项目的持续更新，这类问题将得到更好的解决，开发者应保持对项目进展的关注。