Valibot 文件上传验证的最佳实践

前言

在使用 Valibot 进行表单验证时，文件上传是一个常见的需求场景。本文将详细介绍如何正确实现前端和后端的文件上传验证，特别是针对 Next.js 应用中使用 react-hook-form 和 Valibot 的组合方案。

核心问题分析

许多开发者在实现文件上传验证时会遇到一个典型问题：前端验证工作正常，但相同的验证逻辑在后端却失败。这通常是因为：

1. 前端获取的是 File 对象
2. 后端接收的是 FormData 处理后的数据
3. 两者在数据结构上存在差异

完整解决方案

1. 前端表单实现

在前端，我们使用 react-hook-form 配合 Valibot 进行验证：

"use client";

import { valibotResolver } from "@hookform/resolvers/valibot";
import { useForm } from "react-hook-form";
import { changeAvatar } from "@/lib/actions";
import { changeAvatarSchema, type changeAvatarInput } from "@/lib/validations";

export default function ChangeAvatarForm() {
  const { register, handleSubmit, setValue, formState } = useForm<changeAvatarInput>({
    resolver: valibotResolver(changeAvatarSchema),
    defaultValues: { avatar: undefined },
  });

  const onAvatarChange = (event: React.ChangeEvent<HTMLInputElement>) => {
    const file = event.target.files?.[0];
    if (file) setValue("avatar", file);
  };

  async function onSubmit(values: changeAvatarInput) {
    const formData = new FormData();
    formData.append("avatar", values.avatar);
    await changeAvatar(formData);
  }

  return (
    <form onSubmit={handleSubmit(onSubmit)}>
      <div>
        <label htmlFor="avatar">Avatar</label>
        <input
          id="avatar"
          type="file"
          onChange={onAvatarChange}
        />
        {formState.errors.avatar && (
          <p>{formState.errors.avatar.message}</p>
        )}
      </div>
      <button type="submit">Change avatar</button>
    </form>
  );
}

关键点：

• 使用 useForm 配合 Valibot 解析器
• 通过 onChange 事件手动设置文件值
• 提交时将文件包装在 FormData 中

2. 后端验证实现

在后端服务器动作中：

"use server";

import { safeParse } from "valibot";
import { changeAvatarSchema } from "@/lib/validations";

export async function changeAvatar(values: FormData) {
  const avatar = values.get("avatar");
  const result = safeParse(changeAvatarSchema, { avatar });

  if (!result.success) {
    return { success: false, error: result.issues[0].message };
  }
  
  return { success: true };
}

关键点：

• 从 FormData 获取文件
• 将文件包装在对象中再进行验证
• 返回适当的响应

3. 验证模式定义

验证模式是核心部分：

import { Input, instance, maxSize, mimeType, object } from "valibot";

export const changeAvatarSchema = object({
  avatar: instance(File, "Avatar is required", [
    mimeType(["image/jpeg", "image/png"], "Avatar must be JPG or PNG"),
    maxSize(1024 * 1024, "Max size is 1MB"),
  ]),
});

export type changeAvatarInput = Input<typeof changeAvatarSchema>;

验证规则说明：

• instance(File) 确保输入是 File 对象
• mimeType 限制文件类型
• maxSize 限制文件大小

常见问题与解决方案

1. 文件在后端变为 undefined

   • 确保将文件包装在对象中验证：{ avatar } 而不是直接验证 avatar

2. 类型验证失败

   • 使用 instance(File) 而不是 blob() 或 object()
   • 确保前端正确传递 File 对象

3. 性能优化

   • 设置 abortEarly: true 在第一个错误时停止验证
   • 前端验证可减少不必要的后端请求

最佳实践建议

1. 前后端验证分离

   • 前端验证提供即时反馈
   • 后端验证确保数据安全

2. 错误处理

   • 提供清晰的错误消息
   • 考虑本地化错误提示

3. 用户体验

   • 显示上传进度
   • 提供文件预览功能

4. 安全考虑

   • 永远不要信任前端验证
   • 在后端重新验证所有输入

总结

通过 Valibot 实现文件上传验证需要注意前后端数据结构的差异。本文提供的解决方案确保了从表单到服务器的端到端验证，既保证了用户体验，又确保了数据安全。关键在于正确理解 FormData 的处理方式，以及在验证时保持数据结构的一致性。