Flutter Quill 富文本编辑器中的只读模式配置问题解析

Flutter Quill 是一个流行的富文本编辑器组件，最近在版本更新中出现了一个关于只读(readOnly)模式的配置问题，值得开发者关注。

问题背景

在 Flutter Quill 9.3.11 版本中，开发者发现原本在 QuillEditorConfigurations 中设置的 readOnly 属性突然失效了。这个属性原本用于控制编辑器是否允许用户编辑内容，是一个常见的功能需求。

配置变更分析

在旧版本中，只读模式的配置方式如下：

QuillEditor.basic(
  configurations: QuillEditorConfigurations(
    readOnly: true,  // 直接在此处设置
    // 其他配置...
  ),
)

但在新版本中，这个配置被移到了 QuillController 中：

QuillEditor.basic(
  configurations: QuillEditorConfigurations(
    controller: QuillController(
      document: Document(),  // 必须提供document参数
      readOnly: true,        // 现在需要在这里设置
    ),
    // 其他配置...
  ),
)

技术影响

这个变更带来了几个技术影响：

1. 向后兼容性问题：现有代码需要修改才能适配新版本
2. 配置逻辑变化：从UI配置转移到了控制器配置
3. 必填参数增加：现在必须提供document参数

最佳实践建议

对于使用 Flutter Quill 的开发者，建议采取以下策略：

1. 明确版本依赖：在pubspec.yaml中固定版本号，避免意外升级
2. 封装编辑器组件：创建自定义的编辑器组件，隔离底层API变化
3. 动态控制只读状态：可以通过控制器动态切换只读模式：

// 获取控制器引用
final controller = QuillController.basic();

// 动态切换只读状态
void toggleReadOnly(bool isReadOnly) {
  setState(() {
    controller.readOnly = isReadOnly;
  });
}

设计思考

从架构设计角度看，将只读模式放在控制器中可能更符合MVVM模式的原则：

• 关注点分离：编辑状态(业务逻辑)与UI表现分离
• 动态控制能力：可以运行时动态修改只读状态
• 一致性：与其他编辑器行为控制方式统一

升级注意事项

如果项目需要升级到新版本，开发者应该：

1. 全面检查所有编辑器实例
2. 确保为每个控制器提供document参数
3. 测试所有只读模式相关的功能
4. 考虑编写适配层平滑过渡

这个变更虽然带来了短期的适配成本，但从长期架构角度看可能是有益的调整。开发者需要权衡升级收益与修改成本，做出适合自己项目的决策。