React Native 中使用 @hey-api/client-fetch 上传图片的解决方案

在 React Native 开发中，使用 @hey-api/client-fetch 进行图片上传时，开发者可能会遇到一个常见问题：表单数据中的图片对象被意外地字符串化，导致后端无法正确接收文件。本文将深入分析这个问题，并提供完整的解决方案。

问题背景

当开发者使用 @hey-api/openapi-ts 生成的客户端代码配合 @hey-api/client-fetch 进行文件上传时，React Native 中的图片对象会被错误地处理。典型的 React Native 图片对象结构如下：

{
  uri: Platform.OS === 'ios' ? `file:///${path}` : path,
  type: mime,
  name: filename || 'image.jpg'
}

问题根源

问题的核心在于默认的表单数据序列化器(formDataBodySerializer)无法正确识别 React Native 特有的文件对象格式。默认实现会将这些对象通过 JSON.stringify() 转换为字符串，而非作为文件处理。

解决方案

我们需要自定义表单数据序列化器，使其能够正确处理 React Native 的文件对象。以下是完整的实现方案：

type FileUpload = {
  uri: string;
  type?: string;
  name?: string;
};

const isFileUpload = (value: unknown): value is FileUpload =>
  typeof value === 'object' && typeof (value as any).uri === 'string';

const serializeFormDataPair = (
  data: FormData,
  key: string,
  value: unknown,
) => {
  if (
    typeof value === 'string' ||
    value instanceof Blob ||
    isFileUpload(value)
  ) {
    data.append(key, value);
  } else {
    data.append(key, JSON.stringify(value));
  }
};

const formDataBodySerializer = {
  bodySerializer: <
    T extends Record<string, any> | Array<Record<string, any>>,
  >(
    body: T,
  ) => {
    const data = new FormData();

    Object.entries(body).forEach(([key, value]) => {
      if (value === undefined || value === null) {
        return;
      }
      if (Array.isArray(value)) {
        value.forEach((v) => serializeFormDataPair(data, key, v));
      } else {
        serializeFormDataPair(data, key, value);
      }
    });

    return data;
  },
};

实现说明

1. 类型定义：我们首先定义了 FileUpload 类型，描述 React Native 中文件对象的结构。

2. 类型守卫：isFileUpload 函数用于判断一个值是否为 React Native 文件对象。

3. 序列化逻辑：serializeFormDataPair 函数处理三种情况：

   • 字符串直接附加
   • Blob 对象直接附加
   • React Native 文件对象直接附加
   • 其他类型通过 JSON.stringify 转换

4. 表单构建器：formDataBodySerializer 遍历请求体，正确处理各种数据类型。

应用场景

这个解决方案特别适用于以下场景：

• 使用 @hey-api/openapi-ts 生成客户端代码
• 在 React Native 应用中上传图片
• 使用 TanStack Query 进行数据管理
• 后端期望接收 multipart/form-data 格式的数据

注意事项

1. 跨平台兼容性：此方案同时考虑了 iOS 和 Android 平台的 URI 格式差异。

2. 类型安全：通过 TypeScript 类型守卫确保类型安全。

3. 扩展性：可以轻松扩展以支持其他特殊数据类型。

总结

通过自定义表单数据序列化器，我们成功解决了 React Native 中图片上传时对象被字符串化的问题。这个方案不仅解决了当前问题，还提供了良好的扩展性，可以适应未来可能出现的其他数据类型处理需求。

对于使用 @hey-api 生态系统的 React Native 开发者来说，这是一个可靠且实用的解决方案，能够确保文件上传功能在各种场景下正常工作。