Syncfusion PDF Flutter表单填充更新方案及空安全适配求助

一、修正后的空安全兼容PDF填充代码 #

针对原代码的空安全适配问题，主要调整以下几点：

• 移除PdfStandardFont的过时数字参数，改用PdfFontStyle枚举
• 对可能为null的对象（如doc.form、表单字段）添加非空校验
• 优化变量声明，避免不必要的late关键字

import 'dart:io';
import 'package:syncfusion_flutter_pdf/pdf.dart';

class PdfFormEditor {
  Future<void> fillPdfForm(String inputPath, String outputPath, Map<String, String> fieldValues) async {
    // 读取PDF模板文件
    final fileBytes = await File(inputPath).readAsBytes();
    final PdfDocument doc = PdfDocument(inputBytes: fileBytes);

    // 校验表单是否存在
    if (doc.form == null) {
      doc.dispose();
      throw Exception("PDF模板中未包含可填充表单");
    }

    final PdfForm form = doc.form!;

    // 遍历字段填充值
    for (final entry in fieldValues.entries) {
      final fieldName = entry.key;
      final value = entry.value;
      // 根据字段名查找对应字段
      final field = form.fields.firstWhere(
        (f) => f.name == fieldName && f is PdfTextBoxField,
        orElse: () => throw Exception("未找到名为$fieldName的文本输入字段"),
      ) as PdfTextBoxField;

      field.text = value;
      // 设置字体（使用枚举替代过时的数字参数）
      field.font = PdfStandardFont(PdfFontFamily.timesRoman, 12, style: PdfFontStyle.normal);
    }

    // 保存填充后的PDF
    final outputFile = File(outputPath);
    await outputFile.writeAsBytes(await doc.save());
    doc.dispose();
  }
}

二、结合自定义TextFormField的完整实现 #

1. 自定义可复用输入组件 #

import 'package:flutter/material.dart';

class PdfFieldInput extends StatelessWidget {
  final String labelText;
  final String fieldName;
  final TextEditingController controller;
  final String? Function(String?)? validator;

  const PdfFieldInput({
    super.key,
    required this.labelText,
    required this.fieldName,
    required this.controller,
    this.validator,
  });

  @override
  Widget build(BuildContext context) {
    return TextFormField(
      controller: controller,
      decoration: InputDecoration(
        labelText: labelText,
        border: const OutlineInputBorder(),
      ),
      validator: validator,
      textInputAction: TextInputAction.next,
    );
  }
}

2. 页面集成示例 #

import 'package:flutter/material.dart';

class PdfFillPage extends StatefulWidget {
  const PdfFillPage({super.key});

  @override
  State<PdfFillPage> createState() => _PdfFillPageState();
}

class _PdfFillPageState extends State<PdfFillPage> {
  final _formKey = GlobalKey<FormState>();
  final _nameController = TextEditingController();
  final _emailController = TextEditingController();
  final _pdfEditor = PdfFormEditor();

  Future<void> _submitForm() async {
    if (_formKey.currentState!.validate()) {
      try {
        // 收集用户输入
        final fieldValues = {
          'name': _nameController.text,
          'email': _emailController.text,
          // 可添加更多字段映射
        };

        // 填充并保存PDF
        await _pdfEditor.fillPdfForm(
          'template/cl.pdf',
          'output/filled_cl.pdf',
          fieldValues,
        );

        if (mounted) {
          ScaffoldMessenger.of(context).showSnackBar(
            const SnackBar(content: Text('PDF填充完成，已保存到output目录')),
          );
        }
      } catch (e) {
        if (mounted) {
          ScaffoldMessenger.of(context).showSnackBar(
            SnackBar(content: Text('填充失败：${e.toString()}')),
          );
        }
      }
    }
  }

  @override
  void dispose() {
    _nameController.dispose();
    _emailController.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('PDF表单填充')),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Form(
          key: _formKey,
          child: Column(
            children: [
              PdfFieldInput(
                labelText: '姓名',
                fieldName: 'name', // 需与PDF模板中的字段名完全匹配
                controller: _nameController,
                validator: (value) {
                  if (value == null || value.isEmpty) {
                    return '请输入姓名';
                  }
                  return null;
                },
              ),
              const SizedBox(height: 16),
              PdfFieldInput(
                labelText: '邮箱',
                fieldName: 'email', // 需与PDF模板中的字段名完全匹配
                controller: _emailController,
                validator: (value) {
                  if (value == null || value.isEmpty) {
                    return '请输入邮箱';
                  }
                  return null;
                },
              ),
              const SizedBox(height: 24),
              ElevatedButton(
                onPressed: _submitForm,
                child: const Text('生成填充后的PDF'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

关键说明 #

• 确保PDF模板中的字段名与fieldValues中的key完全匹配，否则会抛出异常
• 使用PdfFontStyle枚举替代原代码中过时的数字参数，适配空安全规范
• 文件操作采用异步处理，避免阻塞UI线程
• 自定义PdfFieldInput组件可复用，方便扩展更多表单字段

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