FilePond 文件上传中 formData 追加参数的实践指南

在 Web 开发中使用 FilePond 进行文件上传时，开发者经常会遇到需要向表单数据(FormData)中追加额外参数的需求。本文将通过一个典型场景，深入分析两种不同的实现方式及其差异，帮助开发者更好地理解 FilePond 的上传机制。

问题背景

在使用 FilePond 4.31.1 版本时，开发者尝试通过 ondata 回调向表单数据中添加一个名为 "dir" 的参数，但发现该参数无法在后端 PHP 脚本中正确获取。而采用自定义的 process 方法则能成功实现这一需求。

方法一：使用 ondata 回调

FilePond.setOptions({
  server: {
    process: '/api/upload_photos.php',
    method: 'POST',
    ondata: (formData) => {
      formData.append("dir", "5550b41d6c01323de9439b50feca8e07");
      return formData;
    }
  }
});

这种方法看似简单直接，但在实际测试中发现，后端 PHP 脚本无法通过 $_POST['dir'] 获取到追加的参数。这表明表单数据在传输过程中可能发生了某些变化，或者参数没有被正确包含在请求体中。

方法二：自定义 process 方法

FilePond.setOptions({
  server: {
    process: (fieldName, file, metadata, load, error, progress, abort, transfer, options) => {
      const formData = new FormData();
      formData.append(fieldName, file, file.name);
      formData.append("dir", "5550b41d6c01323de9439b50feca8e07");

      const request = new XMLHttpRequest();
      request.open('POST', '/api/upload_photos.php');

      request.upload.onprogress = (e) => {
        progress(e.lengthComputable, e.loaded, e.total);
      };

      request.onload = function() {
        if (request.status >= 200 && request.status < 300) {
          load(request.responseText);
        } else {
          error('oh no');
        }
      };

      request.send(formData);

      return {
        abort: () => {
          request.abort();
          abort();
        },
      };
    }
  }
});

这种方法完全接管了文件上传过程，手动创建 FormData 对象并添加所有需要的参数。实践证明，这种方式能够可靠地将额外参数传递到后端。

技术分析

两种方法的主要区别在于对上传流程的控制程度：

1. ondata 回调：属于轻量级修改，在 FilePond 内部流程中插入一个数据处理点。但由于 FilePond 内部可能对表单数据进行了额外处理，可能导致追加的参数丢失。

2. 自定义 process：完全控制上传流程，从创建请求到处理响应都自行管理。这种方式虽然代码量较大，但提供了最大的灵活性和可靠性。

对于需要确保额外参数传递的场景，推荐使用自定义 process 方法。它不仅解决了参数传递问题，还提供了更精细的上传进度控制和错误处理能力。

最佳实践建议

1. 对于简单场景，可以先尝试 ondata 回调，但需要仔细测试参数是否确实被包含在请求中。

2. 对于关键业务场景，建议使用自定义 process 方法，确保上传过程的完全控制。

3. 无论采用哪种方式，都应该在浏览器开发者工具中检查实际发送的网络请求，确认参数是否按预期包含。

4. 考虑添加适当的错误处理和日志记录，便于排查上传过程中可能出现的问题。

通过理解这两种方法的差异和适用场景，开发者可以更有效地利用 FilePond 实现各种文件上传需求。