Springboot之文件上传

Maple_247

已于 2025-01-05 22:02:54 修改

阅读量820

点赞数 5

于 2024-12-31 22:48:23 首次发布

本文链接：https://blog.youkuaiyun.com/Maple_247/article/details/144858767

版权

1. 配置文件上传相关参数

在 application.yml 中配置：

spring:
  servlet:
    multipart:
      # 单个文件大小限制
      max-file-size: 10MB
      # 总上传数据大小限制
      max-request-size: 100MB
      # 文件写入磁盘的阈值
      file-size-threshold: 2KB

2. 创建文件上传控制器

@RestController
@RequestMapping("/file")
public class FileUploadController {
    
    // 文件存储路径
    @Value("${file.upload-dir}")
    private String uploadDir;
    
    /**
     * 单文件上传
     * @param file 上传的文件
     * @return 上传结果
     */
    @PostMapping("/upload")
    public ResponseEntity<String> uploadFile(@RequestParam("file") MultipartFile file) {
        try {
            // 获取原始文件名
            String originalFilename = file.getOriginalFilename();
            
            // 生成新的文件名（防止文件名冲突）
            String fileName = UUID.randomUUID().toString() + 
                originalFilename.substring(originalFilename.lastIndexOf("."));
            
            // 创建目标文件
            Path targetLocation = Paths.get(uploadDir).resolve(fileName);
            
            // 确保目录存在
            Files.createDirectories(targetLocation.getParent());
            
            // 保存文件
            Files.copy(file.getInputStream(), targetLocation, StandardCopyOption.REPLACE_EXISTING);
            //也可以使用file.transferTo(new File(fileName);
            
            return ResponseEntity.ok("文件上传成功：" + fileName);
        } catch (IOException ex) {
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                    .body("文件上传失败：" + ex.getMessage());
        }
    }
    
    /**
     * 多文件上传
     * @param files 文件列表
     * @return 上传结果
     */
    @PostMapping("/upload/multiple")
    public ResponseEntity<List<String>> uploadMultipleFiles(@RequestParam("files") MultipartFile[] files) {
        List<String> uploadedFiles = new ArrayList<>();
        
        for (MultipartFile file : files) {
            try {
                String originalFilename = file.getOriginalFilename();
                String fileName = UUID.randomUUID().toString() + 
                    originalFilename.substring(originalFilename.lastIndexOf("."));
                
                Path targetLocation = Paths.get(uploadDir).resolve(fileName);
                Files.createDirectories(targetLocation.getParent());
                Files.copy(file.getInputStream(), targetLocation, StandardCopyOption.REPLACE_EXISTING);
                
                uploadedFiles.add(fileName);
            } catch (IOException ex) {
                return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                        .body(List.of("文件上传失败：" + ex.getMessage()));
            }
        }
        
        return ResponseEntity.ok(uploadedFiles);
    }
}

3. 创建文件上传服务类

@Service
@Slf4j
public class FileStorageService {
    
    private final Path fileStorageLocation;
    
    @Autowired
    public FileStorageService(@Value("${file.upload-dir}") String uploadDir) {
        this.fileStorageLocation = Paths.get(uploadDir)
                .toAbsolutePath().normalize();
        
        try {
            Files.createDirectories(this.fileStorageLocation);
        } catch (IOException ex) {
            throw new RuntimeException("无法创建文件上传目录", ex);
        }
    }
    
    /**
     * 存储文件
     * @param file 要存储的文件
     * @return 存储后的文件名
     */
    public String storeFile(MultipartFile file) {
        try {
            // 文件名称验证
            String fileName = StringUtils.cleanPath(file.getOriginalFilename());
            
            // 检查文件名是否包含非法字符
            if (fileName.contains("..")) {
                throw new RuntimeException("文件名包含非法路径序列 " + fileName);
            }
            
            // 生成新文件名
            String newFileName = UUID.randomUUID().toString() + 
                fileName.substring(fileName.lastIndexOf("."));
            
            // 复制文件到目标位置
            Path targetLocation = this.fileStorageLocation.resolve(newFileName);
            Files.copy(file.getInputStream(), targetLocation, StandardCopyOption.REPLACE_EXISTING);
            
            return newFileName;
        } catch (IOException ex) {
            throw new RuntimeException("无法存储文件 " + file.getOriginalFilename(), ex);
        }
    }
}

4. 前端上传表单示例

<!DOCTYPE html>
<html>
<head>
    <title>文件上传</title>
</head>
<body>
    <!-- 单文件上传 -->
    <form action="/file/upload" method="post" enctype="multipart/form-data">
        <input type="file" name="file">
        <button type="submit">上传</button>
    </form>

    <!-- 多文件上传 -->
    <form action="/file/upload/multiple" method="post" enctype="multipart/form-data">
        <input type="file" name="files" multiple>
        <button type="submit">上传多个文件</button>
    </form>
</body>
</html>

5.transferTo 和 Files.copy 这两种文件复制方法的区别

如果是简单的文件上传场景，使用 transferTo 更简便

如果需要更多控制和选项，使用 Files.copy

基本语法对比

@Slf4j
public class FileCompareExample {

    /**
     * 使用 transferTo 方法
     */
    public void useTransferTo(MultipartFile sourceFile, File destFile) throws IOException {
        // MultipartFile 的 transferTo 方法
        sourceFile.transferTo(destFile);
    }

    /**
     * 使用 Files.copy 方法
     */
    public void useFilesCopy(MultipartFile sourceFile, Path destPath) throws IOException {
        // Files.copy 方法
        Files.copy(sourceFile.getInputStream(), destPath, StandardCopyOption.REPLACE_EXISTING);
    }
}