如何使用 Spring 上传文件：全面指南

在现代 Web 应用程序中，文件上传是一个常见的功能需求。用户可能需要上传图片、文档或视频等不同类型的数据。Spring 框架提供了强大的支持来处理文件上传，使得开发者可以轻松实现这一功能。本文将详细介绍如何使用 Spring Boot 来实现文件上传，并涵盖从基本配置到高级功能的各个方面。

1. 环境准备

1.1 创建 Spring Boot 项目

首先，你需要创建一个新的 Spring Boot 项目。你可以通过 Spring Initializr 来生成基础项目结构。选择合适的选项如 Java 版本、项目类型等，并确保添加了 Spring Web 和 Spring Boot DevTools 依赖项。

1.2 添加必要的依赖

在你的 pom.xml 文件中加入以下依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
</dependencies>

这里我们主要依赖 spring-boot-starter-web 来提供 Web 支持。

2. 配置文件上传

2.1 修改 application.properties

为了允许较大的文件上传，你可能需要调整一些默认设置。在 src/main/resources/application.properties 中添加如下配置：

# 设置最大文件大小
spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB

这些配置项分别设置了单个文件的最大大小和整个请求的最大大小。根据实际需求调整这些值。

3. 创建文件上传控制器

3.1 编写控制器

创建一个控制器类来处理文件上传请求。下面是一个简单的示例：

import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpStatus;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

@RestController
@RequestMapping("/api/files")
public class FileUploadController {

    private static final String UPLOAD_DIR = "uploads/";

    @PostMapping("/upload")
    public ResponseEntity<String> uploadFile(@RequestParam("file") MultipartFile file) {
        if (file.isEmpty()) {
            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Please select a file to upload.");
        }

        try {
            // 获取文件名
            String fileName = file.getOriginalFilename();
            // 创建目标路径
            Path path = Paths.get(UPLOAD_DIR + fileName);
            // 保存文件
            Files.write(path, file.getBytes());
            return ResponseEntity.ok("File uploaded successfully: " + fileName);
        } catch (IOException e) {
            e.printStackTrace();
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Failed to upload file.");
        }
    }
}

在这个例子中，我们定义了一个 POST 请求处理器 /api/files/upload，它接受一个名为 file 的多部分表单数据（MultipartFile）。如果文件不为空，我们会将其保存到指定目录下，并返回成功信息；否则返回错误信息。

3.2 创建上传目录

确保在项目的根目录下创建一个名为 uploads 的文件夹，或者根据实际情况修改 UPLOAD_DIR 变量指向的路径。

4. 前端页面

4.1 创建 HTML 表单

为了让用户能够上传文件，我们需要创建一个简单的 HTML 表单。可以在静态资源目录 src/main/resources/static 下创建一个 index.html 文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>File Upload</title>
</head>
<body>
    <h2>Upload a File</h2>
    <form action="/api/files/upload" method="post" enctype="multipart/form-data">
        <input type="file" name="file" />
        <button type="submit">Upload</button>
    </form>
</body>
</html>

这个表单使用了 POST 方法并将 enctype 设置为 multipart/form-data，这是上传文件所必需的。

5. 处理多个文件上传

5.1 修改控制器

如果你希望支持一次上传多个文件，可以稍微修改控制器代码：

@PostMapping("/uploadMultiple")
public ResponseEntity<String> uploadMultipleFiles(@RequestParam("files") MultipartFile[] files) {
    if (files.length == 0 || files[0].isEmpty()) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Please select at least one file to upload.");
    }

    StringBuilder message = new StringBuilder();
    for (MultipartFile file : files) {
        try {
            String fileName = file.getOriginalFilename();
            Path path = Paths.get(UPLOAD_DIR + fileName);
            Files.write(path, file.getBytes());
            message.append(fileName).append(" uploaded successfully. ");
        } catch (IOException e) {
            e.printStackTrace();
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Failed to upload some files.");
        }
    }
    return ResponseEntity.ok(message.toString());
}

5.2 修改前端表单

相应的前端表单也需要进行修改，以支持多文件选择：

<form action="/api/files/uploadMultiple" method="post" enctype="multipart/form-data">
    <input type="file" name="files" multiple />
    <button type="submit">Upload Multiple Files</button>
</form>

6. 安全性考虑

6.1 文件类型验证

为了防止恶意文件上传，应该对上传的文件类型进行验证。可以通过检查文件扩展名或 MIME 类型来实现这一点：

private boolean isFileTypeValid(String contentType) {
    return contentType.equals("image/jpeg") || contentType.equals("image/png");
}

@PostMapping("/uploadSecure")
public ResponseEntity<String> uploadSecureFile(@RequestParam("file") MultipartFile file) {
    if (file.isEmpty() || !isFileTypeValid(file.getContentType())) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Invalid file type.");
    }

    try {
        String fileName = file.getOriginalFilename();
        Path path = Paths.get(UPLOAD_DIR + fileName);
        Files.write(path, file.getBytes());
        return ResponseEntity.ok("File uploaded successfully: " + fileName);
    } catch (IOException e) {
        e.printStackTrace();
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Failed to upload file.");
    }
}

6.2 文件重命名

为了避免文件名冲突，可以对上传的文件进行重命名，例如加上时间戳：

private String generateUniqueFileName(String originalName) {
    long timestamp = System.currentTimeMillis();
    return timestamp + "_" + originalName;
}

@PostMapping("/uploadWithRename")
public ResponseEntity<String> uploadFileWithRename(@RequestParam("file") MultipartFile file) {
    if (file.isEmpty()) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Please select a file to upload.");
    }

    try {
        String uniqueFileName = generateUniqueFileName(file.getOriginalFilename());
        Path path = Paths.get(UPLOAD_DIR + uniqueFileName);
        Files.write(path, file.getBytes());
        return ResponseEntity.ok("File uploaded successfully: " + uniqueFileName);
    } catch (IOException e) {
        e.printStackTrace();
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Failed to upload file.");
    }
}

7. 总结

通过本文，我们学习了如何使用 Spring Boot 实现文件上传功能。从基本的单文件上传到多文件上传，再到安全性增强措施，每一步都进行了详细的介绍。希望这篇指南能帮助你在实际项目中更好地利用 Spring 提供的强大功能来处理文件上传需求。随着实践的深入，你可以进一步探索更多高级特性，如文件分块上传、云存储集成等。