使用 Spring Boot 实现图片上传的完整指南

在现代应用程序中，图片上传常常是一个基础功能。在这篇文章中，我们将通过一个简单的例子来实现 Spring Boot 的图片上传功能。首先，让我们了解实现的过程和每一步需要的内容。

流程概述

接下来，我们展示整个过程的步骤。

步骤 描述
1 创建 Spring Boot 项目
2 添加依赖
3 创建文件上传控制器 PhotoController
4 编写文件上传的业务逻辑
5 创建前端页面
6 运行项目并测试

详细步骤

第一步：创建 Spring Boot 项目

可以通过 [Spring Initializr]( 创建一个新的 Spring Boot 项目。选择 Maven Project，添加 Web 依赖。

第二步：添加依赖

在 pom.xml 文件中，需要添加 spring-boot-starter-web 和 spring-boot-starter-thymeleaf 的依赖，这样我们就可以使用 Web 功能和 Thymeleaf 模板引擎。

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

第三步：创建文件上传控制器 PhotoController

接下来，我们需要实现一个控制器来处理文件上传请求。

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;

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

@Controller
public class PhotoController {

    private static String UPLOADED_FOLDER = "uploads/";

    @GetMapping("/")
    public String index() {
        return "index";  // 返回 Thymeleaf 模板 index.html
    }

    @PostMapping("/upload")  
    public String singleFileUpload(@RequestParam("file") MultipartFile file, Model model) {
        if (file.isEmpty()) {
            model.addAttribute("message", "Please select a file to upload.");  // 文件为空时的提示信息
            return "index"; 
        }

        try {
            // 获取文件并保存到指定目录
            byte[] bytes = file.getBytes();
            Path path = Paths.get(UPLOADED_FOLDER + file.getOriginalFilename());
            Files.write(path, bytes);  
            model.addAttribute("message", "Successfully uploaded \"" + file.getOriginalFilename() + "\"");
        } catch (Exception e) {
            e.printStackTrace();
            model.addAttribute("message", "Upload failed: " + e.getMessage());
        }
        return "index";  
    }
}

第四步：编写文件上传的业务逻辑

  • @GetMapping("/") 映射根路径，用于返回上传页面。
  • @PostMapping("/upload") 处理文件上传，检查文件是否为空并保存到指定目录。

第五步：创建前端页面

在 src/main/resources/templates 目录中创建 index.html 文件。

<!DOCTYPE html>
<html xmlns:th="
<head>
    <title>File Upload</title>
</head>
<body>
Upload a File
<form method="POST" enctype="multipart/form-data" th:action="@{/upload}">
    <input type="file" name="file" required/>
    <button type="submit">Upload</button>
</form>
<p th:text="${message}"></p>  <!-- 显示上传后的消息 -->
</body>
</html>

第六步：运行项目并测试

在 IDE 中运行项目，打开浏览器访问 http://localhost:8080。你应该能看到上传页面，选择图片并提交，最终会在指定目录中生成上传的文件。

状态图示例

使用 Mermaid 语法可以图示图片上传的状态过程：

stateDiagram
    [*] --> UploadPage
    UploadPage --> Uploading
    Uploading --> Success
    Uploading --> Failure
    Success --> [*]
    Failure --> UploadPage

使用饼状图展示上传状态

为了更好地理解上传过程，我们可以用饼状图展示上传成功与失败的比例。

pie
    title 上传结果
    "成功": 70
    "失败": 30

结论

通过以上几个步骤，我们成功实现了一个简单的图片上传功能。在此过程中，我们创建了控制器、编写了上传逻辑，并通过前端页面进行了展现。这只是 Spring Boot 应用程序的一个基本示范，但它展示了图通过文件上传功能的基本实现。希望这篇文章能对你有所帮助，鼓励你进一步学习和探索更多功能。