如何在Flutter中无需服务端处理替换DOCX文件占位符？

需求 #

无需依赖服务端，在Flutter应用内编程替换DOCX文件中的占位符{name}为文本"Deepak Kumar"。

已尝试方案及问题 #

• 使用docx_template包操作DOCX时持续报错
• 考虑过flutter_quill，但该库不支持直接操作DOCX文件
• 文档内容：
  

尝试的代码 #

import 'package:flutter/services.dart';
import 'package:docx_template/docx_template.dart';

void _loadAndDisplayDocx() async {
  try {
    final ByteData? data = await rootBundle.load('assets/docs/template.docx');
    if (data == null) {
      debugPrint("Failed to load the DOCX file.");
      return;
    }

    final Uint8List bytes = data.buffer.asUint8List();
    if (bytes.isEmpty) {
      debugPrint("DOCX file is empty after loading.");
      return;
    }

    final DocxTemplate docx = await DocxTemplate.fromBytes(bytes);
    if (docx == null) {
      debugPrint("Failed to initialize the DOCX template.");
      return;
    }

    final Content content = Content()..add(TextContent("name", "Deepak Kumar"));
    final List<int>? docGenerated = await docx.generate(content);
    if (docGenerated == null) {
      debugPrint("Failed to generate the document.");
      return;
    }

    final Directory directory = await getApplicationDocumentsDirectory();
    final File file = File('${directory.path}/output.docx');
    await file.writeAsBytes(docGenerated);
    final String? openResult = await OpenFile.open(file.path);
    if (openResult != "done") {
      debugPrint("Failed to open the document: $openResult");
    }
  } catch (e) {
    debugPrint("Error generating or opening document: $e");
  }
}

遇到的错误 #

生成或打开文档时出错：在null值上使用了空检查运算符

解决方案 #

方案1：使用docx包直接修改DOCX内容 #

docx_template存在兼容性问题，推荐使用更稳定的docx包直接操作文档内容：

1. 添加依赖到pubspec.yaml：

dependencies:
  docx: ^2.0.0
  path_provider: ^2.0.15
  open_file: ^3.3.2

2. 替换占位符的代码：

import 'package:flutter/services.dart';
import 'package:docx/docx.dart';
import 'package:path_provider/path_provider.dart';
import 'package:open_file/open_file.dart';
import 'dart:io';

void _replacePlaceholderInDocx() async {
  try {
    // 加载模板文件
    final ByteData? data = await rootBundle.load('assets/docs/template.docx');
    if (data == null) {
      debugPrint("加载DOCX文件失败");
      return;
    }
    final Uint8List bytes = data.buffer.asUint8List();

    // 解析DOCX文档
    final Docx docx = Docx.fromBytes(bytes);
    // 获取文档核心XML内容
    String contentXml = docx.content;

    // 替换占位符
    contentXml = contentXml.replaceAll('{name}', 'Deepak Kumar');

    // 生成修改后的DOCX字节数据
    final Uint8List newBytes = docx.generate(contentXml);

    // 保存到应用本地目录
    final Directory directory = await getApplicationDocumentsDirectory();
    final File file = File('${directory.path}/output.docx');
    await file.writeAsBytes(newBytes);

    // 打开生成的文档
    final String? openResult = await OpenFile.open(file.path);
    if (openResult != "done") {
      debugPrint("打开文档失败: $openResult");
    }
  } catch (e) {
    debugPrint("处理文档时出错: $e");
  }
}

方案2：修复原docx_template的问题 #

如果要继续使用原库，可尝试以下排查步骤：

• 检查模板中的占位符格式：部分版本的docx_template要求占位符为{{name}}而非{name}，修改后重试
• 验证模板文件完整性：用Microsoft Word重新保存模板，避免文件损坏
• 更新docx_template到最新版本，修复已知的空指针bug

内容的提问来源于stack exchange，提问作者Deepak Kumar