在Spring Boot中實現(xiàn)文件上傳與管理的操作

更新時間：2024年07月31日 09:22:12 作者：聚娃科技

在 Spring Boot 中實現(xiàn)文件上傳與管理非常簡單,通過配置文件上傳、創(chuàng)建文件上傳、下載、列表和刪除接口,我們可以輕松地處理文件操作,結(jié)合前端頁面,可以提供一個完整的文件管理系統(tǒng),這篇文章主要介紹了在Spring Boot中實現(xiàn)文件上傳與管理,需要的朋友可以參考下

在Spring Boot中實現(xiàn)文件上傳與管理

大家好，我是微賺淘客系統(tǒng)3.0的小編，是個冬天不穿秋褲，天冷也要風度的程序猿！

在現(xiàn)代應用程序中，文件上傳與管理是一個常見的需求。在 Spring Boot 中，可以非常方便地實現(xiàn)文件上傳和管理。本文將詳細介紹如何在 Spring Boot 中實現(xiàn)文件上傳功能，包括創(chuàng)建上傳接口、文件存儲、文件訪問等方面的內(nèi)容。我們將提供示例代碼，幫助你快速實現(xiàn)文件上傳與管理功能。

文件上傳接口實現(xiàn)

1. 添加依賴

首先，需要在 pom.xml 中添加相關的依賴，以支持文件上傳功能。Spring Boot 的 spring-boot-starter-web 已經(jīng)包含了對文件上傳的基本支持。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2. 配置文件上傳

Spring Boot 默認使用 CommonsMultipartFile 作為文件上傳的對象。你可以在 application.properties 文件中配置文件上傳的最大大小限制：

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

3. 創(chuàng)建文件上傳控制器

接下來，我們創(chuàng)建一個文件上傳的控制器，處理文件上傳請求。

package cn.juwatech.fileupload;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
@RestController
@RequestMapping("/files")
public class FileUploadController {
    private static final String UPLOAD_DIR = "uploads/";
    @PostMapping("/upload")
    public String handleFileUpload(@RequestParam("file") MultipartFile file) {
        if (file.isEmpty()) {
            return "No file uploaded";
        }
        File uploadDir = new File(UPLOAD_DIR);
        if (!uploadDir.exists()) {
            uploadDir.mkdirs();
        }
        try {
            File destinationFile = new File(UPLOAD_DIR + file.getOriginalFilename());
            file.transferTo(destinationFile);
            return "File uploaded successfully: " + destinationFile.getAbsolutePath();
        } catch (IOException e) {
            e.printStackTrace();
            return "File upload failed";
        }
    }
}

在上述代碼中，我們定義了一個 FileUploadController 類，它包含一個 handleFileUpload 方法來處理文件上傳。上傳的文件將被保存到服務器的 uploads 目錄下。

文件管理

1. 列出文件

除了上傳文件，我們還需要提供一個接口來列出已上傳的文件：

package cn.juwatech.fileupload;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.File;
import java.io.FilenameFilter;
import java.util.ArrayList;
import java.util.List;
@RestController
@RequestMapping("/files")
public class FileListController {
    private static final String UPLOAD_DIR = "uploads/";
    @GetMapping("/list")
    public List<String> listFiles() {
        File folder = new File(UPLOAD_DIR);
        File[] files = folder.listFiles((dir, name) -> !name.startsWith("."));
        List<String> fileNames = new ArrayList<>();
        if (files != null) {
            for (File file : files) {
                fileNames.add(file.getName());
            }
        }
        return fileNames;
    }
}

FileListController 提供了一個 listFiles 方法，列出 uploads 目錄中的所有文件。

2. 下載文件

要實現(xiàn)文件下載功能，我們可以創(chuàng)建一個控制器來處理下載請求：

package cn.juwatech.fileupload;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.File;
@RestController
@RequestMapping("/files")
public class FileDownloadController {
    private static final String UPLOAD_DIR = "uploads/";
    @GetMapping("/download/{filename:.+}")
    public ResponseEntity<Resource> downloadFile(@PathVariable String filename) {
        File file = new File(UPLOAD_DIR + filename);
        if (!file.exists()) {
            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(null);
        }
        Resource resource = new FileSystemResource(file);
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"")
                .body(resource);
    }
}

FileDownloadController 提供了一個 downloadFile 方法，允許用戶通過指定文件名下載文件。

3. 刪除文件

為了支持文件刪除操作，可以添加一個刪除接口：

package cn.juwatech.fileupload;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.File;
@RestController
@RequestMapping("/files")
public class FileDeleteController {
    private static final String UPLOAD_DIR = "uploads/";
    @DeleteMapping("/delete/{filename:.+}")
    public String deleteFile(@PathVariable String filename) {
        File file = new File(UPLOAD_DIR + filename);
        if (file.delete()) {
            return "File deleted successfully";
        } else {
            return "File not found or delete failed";
        }
    }
}

FileDeleteController 提供了一個 deleteFile 方法，允許用戶刪除指定的文件。

前端頁面（可選）

可以使用 Thymeleaf 或其他模板引擎來創(chuàng)建前端頁面以支持文件上傳和管理。以下是一個簡單的 HTML 表單示例，用于上傳文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>File Upload</title>
</head>
<body>
    <h1>File Upload</h1>
    <form action="/files/upload" method="post" enctype="multipart/form-data">
        <input type="file" name="file" />
        <button type="submit">Upload</button>
    </form>
</body>
</html>

這個 HTML 文件提供了一個簡單的文件上傳表單，用戶可以選擇文件并提交上傳請求。