SpringBoot轻松搞定文件上传和显示

Gavana.

已于 2023-08-30 22:30:59 修改

阅读量1.5k

点赞数 1

分类专栏：后端框架 Java 文章标签： spring boot java 后端文件上传

于 2023-08-30 22:29:17 首次发布

本文链接：https://blog.csdn.net/TaloyerG/article/details/132591890

版权

Java 同时被 2 个专栏收录

45 篇文章 0 订阅

订阅专栏

后端框架

24 篇文章 0 订阅

订阅专栏

文件上传和显示是Web开发中常见的需求，但是实现起来可能会遇到各种问题，比如文件名重复、文件大小限制、文件格式不支持等。有没有一种简单而高效的方法，可以让我们快速实现文件上传和显示的功能呢？答案是有的，那就是使用SpringBoot框架。SpringBoot是一个基于Spring框架的开源项目，它可以快速创建和运行独立的Java应用程序。SpringBoot提供了许多功能，其中之一就是文件上传和显示。在本文中，我将介绍如何使用SpringBoot实现文件上传和显示的功能，让你轻松搞定文件操作。

一、文件上传

要实现文件上传，我们需要以下几个步骤：

创建一个文件上传的控制器类，用于处理文件上传的请求。
创建一个文件存储的服务类，用于保存上传的文件到指定的目录。
创建一个文件上传的配置类，用于配置文件存储的路径和大小限制。
创建一个文件上传的页面，用于选择和提交文件。

1、文件上传控制器类

我们可以使用@Controller注解来标记一个类为控制器类，然后使用@RequestMapping注解来映射请求路径。我们可以使用@RequestParam注解来获取请求参数，其中MultipartFile类型表示一个上传的文件。我们可以使用@Autowired注解来自动注入文件存储服务类的实例。我们可以使用Model类型来向页面传递数据。我们可以使用redirect:前缀来重定向到另一个请求路径。我们可以使用try-catch语句来处理异常情况。

下面是一个示例代码：

@Controller
public class FileUploadController {

    @Autowired
    private FileStorageService fileStorageService;

    @RequestMapping("/upload")
    public String upload(@RequestParam("file") MultipartFile file, Model model) {
        try {
            // 保存文件到指定目录
            String fileName = fileStorageService.saveFile(file);
            // 向页面传递文件名
            model.addAttribute("fileName", fileName);
            // 重定向到显示页面
            return "redirect:/show";
        } catch (Exception e) {
            // 向页面传递错误信息
            model.addAttribute("message", e.getMessage());
            // 返回错误页面
            return "error";
        }
    }
}

2、文件存储服务类

我们可以使用@Service注解来标记一个类为服务类，然后使用@Value注解来获取配置属性的值。我们可以使用File类型来表示一个文件或目录。我们可以使用StringUtils工具类来处理字符串相关的操作。我们可以使用FileUtils工具类来处理文件相关的操作。

下面是一个示例代码：

@Service
public class FileStorageService {

    // 获取配置属性中的文件存储路径
    @Value("${file.storage.path}")
    private String fileStoragePath;

    public String saveFile(MultipartFile file) throws Exception {
        // 获取原始文件名
        String originalFileName = file.getOriginalFilename();
        // 生成新的文件名，避免重复
        String newFileName = StringUtils.getUUID() + "." + StringUtils.getExtension(originalFileName);
        // 创建目标文件对象
        File destFile = new File(fileStoragePath + newFileName);
        // 将上传的文件写入目标文件
        FileUtils.copyInputStreamToFile(file.getInputStream(), destFile);
        // 返回新的文件名
        return newFileName;
    }
}

3、文件上传配置类

我们可以使用@Configuration注解来标记一个类为配置类，然后使用@Bean注解来创建一个Bean对象。我们可以使用MultipartConfigElement类型来配置文件上传相关的属性，如最大文件大小，最大请求大小，临时目录等。

下面是一个示例代码：

@Configuration
public class FileUploadConfig {

    // 获取配置属性中的最大文件大小
    @Value("${file.max.size}")
    private long maxFileSize;

    // 获取配置属性中的最大请求大小
    @Value("${request.max.size}")
    private long maxRequestSize;

    @Bean
    public MultipartConfigElement multipartConfigElement() {
        // 创建MultipartConfigFactory对象
        MultipartConfigFactory factory = new MultipartConfigFactory();
        // 设置最大文件大小
        factory.setMaxFileSize(DataSize.ofBytes(maxFileSize));
        // 设置最大请求大小
        factory.setMaxRequestSize(DataSize.ofBytes(maxRequestSize));
        // 返回MultipartConfigElement对象
        return factory.createMultipartConfig();
    }
}

4、文件上传页面

我们可以使用Thymeleaf模板引擎来创建一个文件上传的页面，其中<form>标签用于创建一个表单，enctype="multipart/form-data"属性用于指定表单的编码类型，<input type="file">标签用于创建一个文件选择框，<input type="submit">标签用于创建一个提交按钮。

下面是一个示例代码：

<!DOCTYPE html>
<html lang="zh-CN" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>文件上传</title>
</head>
<body>
    <h1>文件上传</h1>
    <form action="/upload" method="post" enctype="multipart/form-data">
        <p>请选择要上传的文件：</p>
        <input type="file" name="file" required>
        <input type="submit" value="上传">
    </form>
</body>
</html>

二、文件显示

要实现文件显示，我们需要以下几个步骤：

创建一个文件显示的控制器类，用于处理文件显示的请求。
创建一个文件显示的页面，用于展示文件的内容。

1、文件显示控制器类

我们可以使用@Controller注解来标记一个类为控制器类，然后使用@RequestMapping注解来映射请求路径。我们可以使用@ModelAttribute注解来获取模型属性，其中String类型表示一个文件名。我们可以使用Model类型来向页面传递数据。我们可以使用FileUtils工具类来处理文件相关的操作。

下面是一个示例代码：

@Controller
public class FileShowController {

    // 获取配置属性中的文件存储路径
    @Value("${file.storage.path}")
    private String fileStoragePath;

    @RequestMapping("/show")
    public String show(@ModelAttribute("fileName") String fileName, Model model) {
        try {
            // 创建源文件对象
            File srcFile = new File(fileStoragePath + fileName);
            // 读取文件内容为字节数组
            byte[] fileContent = FileUtils.readFileToByteArray(srcFile);
            // 向页面传递文件内容
            model.addAttribute("fileContent", fileContent);
            // 返回显示页面
            return "show";
        } catch (Exception e) {
            // 向页面传递错误信息
            model.addAttribute("message", e.getMessage());
            // 返回错误页面
            return "error";
        }
    }
}

2、文件显示页面

我们可以使用Thymeleaf模板引擎来创建一个文件显示的页面，其中${...}语法用于获取模型属性的值，th:src="@{...}"属性用于指定图片的源地址，th:unless="${...}"属性用于判断是否执行某个元素。

下面是一个示例代码：

<!DOCTYPE html>
<html lang="zh-CN" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>文件显示</title>
</head>
<body>
    <h1>文件显示</h1>
    <p>您上传的文件名为：${fileName}</p>
    <p>您上传的文件内容为：</p>
    <!-- 如果文件内容是图片，则显示图片 -->
    <img th:src="@{'data:image/png;base64,' + ${#strings.base64Encode(fileContent)}}" th:unless="${#strings.isEmpty(fileContent)}">
    <!-- 如果文件内容不是图片，则显示文本 -->
    <pre th:text="${#strings.newString(fileContent, 'UTF-8')}" th:unless="${#strings.isEmpty(fileContent)}"></pre>
</body>
</html>

总结

本文介绍了如何使用SpringBoot实现文件上传和显示的功能，主要涉及了以下几个方面：

文件上传控制器类，用于处理文件上传的请求。
文件存储服务类，用于保存上传的文件到指定的目录。
文件上传配置类，用于配置文件存储的路径和大小限制。
文件上传页面，用于选择和提交文件。
文件显示控制器类，用于处理文件显示的请求。
文件显示页面，用于显示文件

代码的形式让整个流程更加直观，具体语法不必要学太死。

Gavana.

关注

1
点赞
踩
8

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringBoot轻松搞定文件上传和显示

文件上传控制器类，用于处理文件上传的请求。文件存储服务类，用于保存上传的文件到指定的目录。文件上传配置类，用于配置文件存储的路径和大小限制。文件上传页面，用于选择和提交文件。文件显示控制器类，用于处理文件显示的请求。文件显示页面，用于显示文件本文的内容就到这啦！
复制链接

扫一扫