Spring基础分析12-文件上传下载功能

news2024/12/24 12:52:58

大家好，今天和大家一起学习一下spring的文件上传和下载功能~

文件上传和下载是两个非常常见的功能需求。Spring框架提供了强大的支持，使我们能够轻松地实现这些功能。

1. 环境搭建

首先，确保项目基于Spring Boot构建，并且已经正确配置了Maven或Gradle。需要添加以下依赖到pom.xml（对于Maven）或build.gradle（对于Gradle）文件中：

Maven:

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- 其他依赖 -->
</dependencies>

Gradle:

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    // 其他依赖
}

此外，为了处理文件上传，可能还需要一个用于存储文件的服务器端文件系统或者云存储服务。这里假设使用的是本地文件系统。

2. 配置文件上传

在application.properties或application.yml中设置文件上传的最大大小和其他相关参数：

application.properties:

# 设置最大文件大小为10MB

spring.servlet.multipart.max-file-size=10MB

# 设置请求的最大大小为10MB

spring.servlet.multipart.max-request-size=10MB

application.yml:

spring:

servlet:

multipart:

max-file-size: 10MB

max-request-size: 10MB

3. 创建文件上传控制器

创建一个名为FileUploadController的控制器类，用于处理文件上传请求。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
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 new ResponseEntity<>("Please select a file to upload", HttpStatus.BAD_REQUEST);
        }

        try {
            // Ensure the directory exists
           Files.createDirectories(Paths.get(UPLOAD_DIR));

            // Save the file on the server
            Path filePath = Paths.get(UPLOAD_DIR + file.getOriginalFilename());
            Files.copy(file.getInputStream(), filePath);

            return new ResponseEntity<>("File uploaded successfully: " + file.getOriginalFilename(), HttpStatus.OK);
        } catch (IOException e) {
            e.printStackTrace();
            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
        }
    }
}

这里定义了一个POST端点/api/files/upload，它接受一个名为file的MultipartFile作为参数，并尝试将其保存到服务器上的指定目录中。如果上传成功，则返回HTTP 200状态码；如果失败，则根据错误情况返回相应的HTTP状态码。

4. 创建文件下载控制器

接下来，创建一个名为FileDownloadController的控制器类，用于处理文件下载请求。

import org.springframework.core.io.InputStreamResource;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.nio.file.Paths;

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

    private static final String UPLOAD_DIR = "uploads/";

    @GetMapping("/download/{fileName:.+}")
    public ResponseEntity<Resource> downloadFile(@PathVariable String fileName) {
        try {
            // Load file as Resource
            File file = new File(UPLOAD_DIR + fileName);
           InputStreamResource resource = new InputStreamResource(new FileInputStream(file));

            // Try to determine file's content type
            String contentType = null;
            try {
                contentType = Files.probeContentType(file.toPath());
            } catch (IOException ex) {
                // Fallback to default content type if detection fails
                contentType = "application/octet-stream";
            }

            // Return the file with response headers
            return ResponseEntity.ok()
                    .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getName() + "\"")
                    .contentType(MediaType.parseMediaType(contentType))
                    .body(resource);
        } catch (FileNotFoundException e) {
            return ResponseEntity.notFound().build();
        }
    }
}

此段代码定义了一个GET端点/api/files/download/{fileName}，接受一个文件名作为路径变量，并尝试从服务器上读取该文件并以附件形式返回给客户端。如果文件存在，则设置适当的响应头并返回文件；如果找不到文件，则返回HTTP 404状态码。

5. 测试上传和下载功能

可以使用Postman、cURL或者其他HTTP客户端工具来测试上述接口的功能。例如，使用cURL命令行工具可以这样测试：