Spring Boot 处理带文件表单的方式汇总

2025-12-12 19:50

本文主要是介绍Spring Boot 处理带文件表单的方式汇总,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《SpringBoot处理带文件表单的方式汇总》本文详细介绍了六种处理文件上传的方式,包括@RequestParam、@RequestPart、@ModelAttribute、@ModelAttr...

方式 1:@RequestParam接收文件

后端代码

@PostMapping("/upload1")
public Result upload1(
    @RequestParam("file") MultipartFile file,
    @RequestParam("name") String name,
    @RequestParam("age") Integer age
) {
    // 处理文件
    String filename = file.getOriginalFilename();
    long size = file.getSize();
    return Result.success();
}

前端代码

const formData = new FormData();
formData.append('file', fileBlob);
formData.append('name', 'John');
formData.append('age', '25');
fetch('/api/upload1', {
    method: 'POST',
    body: formData
});

特点

  • ✅ 最简单直接
  • ✅ 适合少量参数
  • ❌ 参数多时代码冗长
  • ❌ 无法使用 @Valid 统一验证

方式 2:@RequestPart接收文件

后端代码

@PostMapping("/upload2")
public Result upload2(
    @RequestPart("file") MultipartFile file,
    @RequestPart("name") String name,
    @RequestPart("age") Integer age
) {
    return Result.success();
}

前端代码

// 与方式1相同
const formData = new FormData();
formData.append('file', fileBlob);
formData.wvATxiwpFyappend('name', 'John');
formData.append('age', '25');

特点

  • ✅ 语义更明确(专为 multipart 设计)
  • ✅ 可以指定每个 part 的 Content-Type
  • ❌ 与 @RequestParam 功能类似,参数多时也冗长

方式 3:@ModelAttribute接收(文件在 DTO 中)

后端代码

@Data
public class UploadDTO {
    @NotNull(message = "文件不能为空")
    private MultipartFile file;
    @NotBlank(message = "姓名不能为空")
    private String name;
    @NotNull(message = "年龄不能为空")
    @Min(value = 0, message = "年龄不能为负数")
    private Integer age;
    private String description;
}
@PostMapping("/upload3")
public Result upload3(@Valid @ModelAttribute UploadDTO dto) {
    MultipartFile file = dto.getFile();
    // 额外检查文件是否为空
    if (file.isEmpty()) {
        throw new BusinessException("文件内容不能为空");
    }
    return Result.success();
}

前端代码

const formData = new FormData();
formData.append('file', fileBlob);
formData.append('name', 'John');
formData.append('age', '25');
formData.append('description', '这是描述');
fetch('/api/upload3', {
    method: 'POST',
    body: formData
});

特点

  • ✅ 代码简洁,参数封装在 DTO 中
  • ✅ 支持 @Valid 统一验证
  • ✅ DTO 可复用
  • ✅ 适合传统表单提交
  • ❌ 只支持扁平数据结构

方式 4:@ModelAttribute+@RequestPart混合(推荐)

后端代码

@Data
public class LoanRequest {
    @NotBlank(message = "姓名不能为空")
    private String name;
    @NotNull(message = "贷款金额不能为空")
    private BigDecimal amount;
    @NotBlank(message = "贷款类型不能为空")
    private String loanType;
    private String description;
}
@PostMapping("/upload4")
public Result upload4(
    @Valid @ModelAttribute LoanRequest request,
    @RequestPart(value = "propProofDocs", required = false) MultipartFile file
) {
    // 文件验证
    if (file == null || file.isEmpty()) {
        throw new BusinjsessException("财产证明文件不能为空");
    }
    return Result.success();
}

前端代码

const formData = new FormData();
// 普通字段
formData.append('name', 'John');
formData.append('amount', '100000');
formData.append('loanType', 'mortgage');
formData.append('description', '购房贷款');
// 文件单独处理
formData.append('propProofDocs', fileBlob);
fetch('/api/upload4', {
    method: 'POST',
    body: formData
});

特点

  • 最灵活,业务数据和文件分离
  • ✅ 支持 DTO 验证
  • ✅ 文件验证可以单独处理
  • ✅ 适合复杂业务场景
  • 推荐用于大多数项目

方式 5:@RequestPart接收 JSON + 文件

后端代码

@Data
public class UserInfo {
    @NotBlank(message = "姓名不能为空")
    private String name;
    @NotNull(message = "年龄不能为空")
    private Integer age;
    private List<String> hobbies;  // 支持复杂结构
    private Address address;  // 支持嵌套对象
}
@Data
class Address {
    private String city;
    private String street;
}
@PostMapping("/upload5")
public Result upload5(
    @Valid @RequestPart("userInfo") UserInfo userInfo,
    @RequestPart("avatar") MultipartFile avatar
) {
    return Result.success();
}

前端代码

const userInfo = {
    name: 'John',
    age: 25,
    hobbies: ['reading', 'coding'],
    address: {
        city: 'Beijing',
        street: 'Chang\'an Ave'
    }
};
const formData = new FormData();
// 将 JSON 对象转为 Blob,指定 Content-Type
formData.append('userInfo', new Blob([JSON.stringify(userInfo)], {
    type: 'application/json'
}));
formData.append('avatar', fileBlob);
fetch('/api/upload5', {
    method: 'POST',
    body: formData
});

特点

  • ✅ 支持复杂 JSON 结构(数组、嵌套对象)
  • ✅ 前后端分离友好
  • ✅ RESTful 风格
  • ❌ 前端需要额外构造 JSON Blob
  • 推荐用于复杂数据结构

方式 6:wvATxiWpFy多文件上传

后端代码

// 方式 6.1:数组接收
@PostMapping("/upload6-1")
public Result upload6(
    @RequestParam("files") MultipartFile[] files,
    @RequestParam("description") String description
) {
    for (MultipartFile file : files) {
        // 处理每个文件
    }
    return Result.success();
}
// 方式 6.2:List 接收
@PostMapping("/upload6-2")
public Result upload6(
    @RequestParam("files") List<MultipartFile> files,
    @RequestParam("description") String description
) {
    files.forEach(file -> {
        // 处理每个文件
    });
    return Result.success();
}
// 方式 6.3:不同字段多个文件
@PostMapping("/upload6-3")
public Result upload6(
    @RequestPart("idCard") MultipartFile idCard,
    @RequestPart("bankCard") MultipartFile bankCard,
    @RequestPart("propProof") MultipartFile propProof
) {
    return Result.success();
}

前端代码

// 多个文件同名
const formData = new FormData();
files.forEach(file => {
    formData.append('files', file);  // 注意:相同的 key
});
formData.append('description', '批量上传');
// 多个文件不同名
const formData2 = new FormData();
formData2.append('idCard', idCardFile);
formData2.append('bankCard', bankCardFile);
formData2.append('propProof', propProofFile);

方式 7:HttpServletRequest 原生方式

后端代码

@PostMapping("/upload7")
public Result upload7(HttpServletRequest request) throws Exception {
    // 判断是否为 multipart 请求
    if (!ServletFileUpload.isMultipartContent(request)) {
        throw new BusinessException("请求格式错误");
    }
    // 使用 Apache Commons FileUpload
    ServletFileUpload upload = new ServletFileUpload();
    List<FileItem> items = upload.parseRequest(new ServletRequestContext(request));
    for (FileItem item : items) {
        javascriptif (item.isFormField()) {
            // 普通字段
            String fieldName = item.getFieldName();
            String value = item.getString("UTF-8");
        } else {
            // 文件字段
            String filename = item.getName();
            InputStream inputStream = item.getInputStream();
            // 处理文件
        }
    }
    return Result.success();
}

特点

  • ✅ 完全控制
  • ✅ 适合特殊需求
  • ❌ 代码复杂
  • ❌ 不推荐常规使用

完整对比表

方式适用场景代码简洁度验证支持复杂结构推荐度
@RequestParam简单场景,少量参数⭐⭐⭐⭐
@RequestPart与 @RequestParam 类似⭐⭐⭐⭐
@ModelAttribute(文件在DTO)传统表单,扁平数据⭐⭐⭐⭐⭐⭐⭐⭐
@ModelAttribute + @RequestPart通用场景⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐
@RequestPart (JSON)复杂JSON结构⭐⭐⭐⭐⭐⭐⭐
多文件上传批量上传⭐⭐⭐⭐⭐⭐⭐
HttpServletRequest特殊需求

实际项目推荐

场景 1:简单表单 + 单文件

@PostMapping("/simple")
public Result simple(
    @Valid @ModelAttribute SimpleDTO dto,
    @RequestPart("file") MultipartFile file
) { }

场景 2:复杂业务数据 + 多文件

@PostMapping("/complex")
public Result complex(
    @Valid @RequestPart("data") ComplexDTO data,  // JSON
    @RequestPart("idCard") MultipartFile idCard,
    @RequestPart("bankCard") MultipartFile bankCard
) { }

场景 3:可选文件 + 表单验证

@PostMapping("/optional")
public Result optional(
    @Valid @ModelAttribute FormDTO form,
    @RequestPart(value = "attachment", required = false) MultipartFile file
) {
    if (file != null && !file.isEmpty()) {
        // 处理文件
    }
}

文件验证最佳实践

自定义验证注解

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = FileValidator.class)
public @interface ValidFile {
    String message() default "文件不合法";
    long maxSize() default 10 * 1024 * 1024;  // 10MB
    String[] allowedTypes() default {};  // {"image/jpeg", "image/png"}
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}
// 验证器
public class FileValidator implements ConstraintValidator<ValidFile, MultipartFile> {
    private long maxSize;
    private String[] allowedTypes;
    @Override
    public void initialize(ValidFile annotation) {
        this.maxSize = annotation.maxSize();
        this.allowedTypes = annotation.allowedTypes();
    }
    @Override
    public boolean isValid(MultipartFile file, ConstraintValidatorContext context) {
        if (file == null || file.isEmpty()) {
            return false;
        }
        // 检查大小
        if (file.getSize() > maxSize) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate(
                "文件大小不能超过 " + (maxSize / 1024 / 1024) + "MB"
            ).addConstraintViolation();
            return false;
        }
        // 检查类型
        if (allowedTypes.length > 0) {
            String contentType = file.getContentType();
            boolean typeMatched = Arrays.asList(allowedTypes).contains(contentType);
            if (!typeMatched) {
                context.dphpisableDefaultConstraintViolation();
                context.buildConstraintViolationWithTemplate(
                    "只支持以下文件类型: " + String.join(", ", allowedTypes)
                ).addConstraintViolation();
                return false;
            }
        }
        return true;
    }
}
// 使用
@PostMapping("/validated")
public Result validated(
    @Valid @ModelAttribute FormDTO form,
    @ValidFile(
        maxSize = 5 * 1024 * 1024,  // 5MB
        allowedTypes = {"image/jpeg", "image/png", "application/pdf"},
        message = "文件不符合要求"
    )
    @RequestPart("file") MultipartFile file
) {
    return Result.success();
}

总结

日常开发推荐

  • 方式 4@ModelAttribute + @RequestPart)- 最灵活通用
  • 方式 3@ModelAttribute 包含文件)- 简单场景
  • 方式 5@RequestPart JSON)- 复杂数据结构

根据实际业务需求选择合适的方式,优先考虑代码的可维护性和可读性!

到此这篇关于Spring Boot 处理带文件表单的方式汇总的文章就介绍到这了,更多相关springboot文件表单内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!

这篇关于Spring Boot 处理带文件表单的方式汇总的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1156437

相关文章

springboot+redis实现订单过期(超时取消)功能的方法详解

《springboot+redis实现订单过期(超时取消)功能的方法详解》在SpringBoot中使用Redis实现订单过期(超时取消)功能,有多种成熟方案,本文为大家整理了几个详细方法,文中的示例代... 目录一、Redis键过期回调方案(推荐)1. 配置Redis监听器2. 监听键过期事件3. Redi

SpringBoot整合Zuul全过程

《SpringBoot整合Zuul全过程》Zuul网关是微服务架构中的重要组件,具备统一入口、鉴权校验、动态路由等功能,它通过配置文件进行灵活的路由和过滤器设置,支持Hystrix进行容错处理,还提供... 目录Zuul网关的作用Zuul网关的应用1、网关访问方式2、网关依赖注入3、网关启动器4、网关全局变

SpringBoot全局异常拦截与自定义错误页面实现过程解读

《SpringBoot全局异常拦截与自定义错误页面实现过程解读》本文介绍了SpringBoot中全局异常拦截与自定义错误页面的实现方法,包括异常的分类、SpringBoot默认异常处理机制、全局异常拦... 目录一、引言二、Spring Boot异常处理基础2.1 异常的分类2.2 Spring Boot默

基于SpringBoot实现分布式锁的三种方法

《基于SpringBoot实现分布式锁的三种方法》这篇文章主要为大家详细介绍了基于SpringBoot实现分布式锁的三种方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、基于Redis原生命令实现分布式锁1. 基础版Redis分布式锁2. 可重入锁实现二、使用Redisso

SpringBoot的全局异常拦截实践过程

《SpringBoot的全局异常拦截实践过程》SpringBoot中使用@ControllerAdvice和@ExceptionHandler实现全局异常拦截,@RestControllerAdvic... 目录@RestControllerAdvice@ResponseStatus(...)@Except

Springboot配置文件相关语法及读取方式详解

《Springboot配置文件相关语法及读取方式详解》本文主要介绍了SpringBoot中的两种配置文件形式,即.properties文件和.yml/.yaml文件,详细讲解了这两种文件的语法和读取方... 目录配置文件的形式语法1、key-value形式2、数组形式读取方式1、通过@value注解2、通过

Java 接口定义变量的示例代码

《Java接口定义变量的示例代码》文章介绍了Java接口中的变量和方法,接口中的变量必须是publicstaticfinal的,用于定义常量,而方法默认是publicabstract的,必须由实现类... 在 Java 中,接口是一种抽象类型,用于定义类必须实现的方法。接口可以包含常量和方法,但不能包含实例

JAVA Calendar设置上个月时,日期不存在或错误提示问题及解决

《JAVACalendar设置上个月时,日期不存在或错误提示问题及解决》在使用Java的Calendar类设置上个月的日期时,如果遇到不存在的日期(如4月31日),默认会自动调整到下个月的相应日期(... 目录Java Calendar设置上个月时,日期不存在或错误提示java进行日期计算时如果出现不存在的

Springboot的配置文件及其优先级说明

《Springboot的配置文件及其优先级说明》文章介绍了SpringBoot的配置文件,包括application.properties和application.yml的使用,以及它们的优先级,还讨... 目录配置文件内置配置文件yml与properties的比较优先级比较外置配置文件springboot

自定义注解SpringBoot防重复提交AOP方法详解

《自定义注解SpringBoot防重复提交AOP方法详解》该文章描述了一个防止重复提交的流程,通过HttpServletRequest对象获取请求信息,生成唯一标识,使用Redis分布式锁判断请求是否... 目录防重复提交流程引入依赖properties配置自定义注解切面Redis工具类controller