如何在 Spring Boot 项目中使用 Thymeleaf 和 Bootstrap 实现文件上传
创始人
2024-03-24 09:59:04
0

在本教程中,我将向您展示如何在 Spring Boot 项目中使用 Thymeleaf 和 Bootstrap 实现文件上传。我们还使用 Spring Web MultipartFile界面来处理 HTTP 多部分请求。

Thymeleaf 文件上传概述

我们的 Spring Boot + Thymeleaf 文件上传示例将具有以下功能:

  • 将文件上传到服务器中的静态文件夹
  • 使用链接从服务器下载文件
  • 获取文件信息列表(文件名和URL)

– 这是文件上传表格:

 

– 如果文件超过特定的最大大小:

 

– 这是存储所有上传文件的静态文件夹:

 

– 您可以查看带有下载链接的上传文件列表:

 

在本教程中,我不解释删除文件的方法。如果你想知道这一点,只需访问:
弹簧启动删除文件示例与百里香叶

或者使用以下教程添加分页:
春季启动百里香叶分页示例

科技

  • Java 8
  • Spring Boot 2.7 (with Spring Web MVC, Thymeleaf)
  • Maven 3.6.1
  • Bootstrap 4
  • jQuery 3.6.1

项目结构

 

让我简要解释一下。

FileInfo包含上传文件的信息。

FilesStorageService帮助我们初始化存储,保存新文件,加载文件,获取文件信息列表,删除文件。

FileController、FilesStorageService用于处理文件上传/下载和模板请求。

FileUploadExceptionAdvice在控制器处理文件上传时处理异常。

template存储项目的 HTML 模板文件。

– application.properties包含 Servlet Multipart 的配置。
– uploads上传是用于存储文件的静态文件夹。
– pom.xml 用于 Spring Boot 依赖项。

创建和设置 Spring Boot 项目

使用 Spring Web 工具或开发工具(Spring Tool Suite、Eclipse、Intellij)创建 Spring Boot 项目。

然后打开pom.xml并为Spring Web,Thymeleaf,Bootstrap,Jquery添加依赖项:

org.springframework.bootspring-boot-starter-web
org.springframework.bootspring-boot-starter-thymeleaf
org.webjarsbootstrap4.6.2
org.webjarsjquery3.6.1
org.webjarswebjars-locator-core

为文件存储创建服务

首先,我们需要一个将在控制器中自动连接的接口。
服务文件夹中,创建类似于以下代码的接口:FilesStorageService

service/FilesStorageService.java

package com.bezkoder.spring.thymeleaf.file.upload.service;import java.nio.file.Path;
import java.util.stream.Stream;import org.springframework.core.io.Resource;
import org.springframework.web.multipart.MultipartFile;public interface FilesStorageService {public void init();public void save(MultipartFile file);public Resource load(String filename);public void deleteAll();public Stream loadAll();
}

现在我们创建接口的实现。

service/FilesStorageServiceImpl.java

package com.bezkoder.spring.thymeleaf.file.upload.service;import java.io.IOException;
import java.net.MalformedURLException;
import java.nio.file.FileAlreadyExistsException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.stream.Stream;import org.springframework.core.io.Resource;
import org.springframework.core.io.UrlResource;
import org.springframework.stereotype.Service;
import org.springframework.util.FileSystemUtils;
import org.springframework.web.multipart.MultipartFile;@Service
public class FilesStorageServiceImpl implements FilesStorageService {private final Path root = Paths.get("./uploads");@Overridepublic void init() {try {Files.createDirectories(root);} catch (IOException e) {throw new RuntimeException("Could not initialize folder for upload!");}}@Overridepublic void save(MultipartFile file) {try {Files.copy(file.getInputStream(), this.root.resolve(file.getOriginalFilename()));} catch (Exception e) {if (e instanceof FileAlreadyExistsException) {throw new RuntimeException("A file of that name already exists.");}throw new RuntimeException(e.getMessage());}}@Overridepublic Resource load(String filename) {try {Path file = root.resolve(filename);Resource resource = new UrlResource(file.toUri());if (resource.exists() || resource.isReadable()) {return resource;} else {throw new RuntimeException("Could not read the file!");}} catch (MalformedURLException e) {throw new RuntimeException("Error: " + e.getMessage());}}@Overridepublic void deleteAll() {FileSystemUtils.deleteRecursively(root.toFile());}@Overridepublic Stream loadAll() {try {return Files.walk(this.root, 1).filter(path -> !path.equals(this.root)).map(this.root::relativize);} catch (IOException e) {throw new RuntimeException("Could not load the files!");}}
}

创建用于文件上传的控制器

控制器包中,我们创建 .FileController

控制器/文件控制器.java

package com.bezkoder.spring.thymeleaf.file.upload.controller;
// ...
import com.bezkoder.spring.thymeleaf.file.upload.service.FilesStorageService;@Controller
public class FileController {@AutowiredFilesStorageService storageService;@GetMapping("/")public String homepage() {return "redirect:/files";}@GetMapping("/files/new")public String newFile(Model model) {return "upload_form";}@PostMapping("/files/upload")public String uploadFile(Model model, @RequestParam("file") MultipartFile file) {...return "upload_form";}@GetMapping("/files")public String getListFiles(Model model) {...return "files";}@GetMapping("/files/{filename:.+}")public ResponseEntity getFile(@PathVariable String filename) {...// return File}
}

@Controller注释用于定义控制器。
@GetMapping、@PostMapping注释用于将 HTTP GET & POST 请求映射到特定的处理程序方法并返回适当的模板文件。
– ​​​​​​​​​​​​​​@Autowired我们使用将FilesStorageService bean 的实现注入到局部变量中。

设置模板

在 src/main/resources 文件夹中,按以下结构创建文件夹和文件:

 

页眉和页脚

我们将使用百里香叶碎片()来重用一些常见的部分,例如页眉和页脚。
让我们为它们编写 HTML 代码。th:fragment

fragments/footer.html

Copyright © BezKoder

以及包含导航栏的标题:

fragments/header.html

现在我们需要创建HTML文件,然后导入Thymeleaf片段,Bootstrap,jQuery和Font Awesome。

文件上传表格

upload_form.html


BezKoder - Thymeleaf File Upload example
-- file upload form --

文件列表

files.html


BezKoder - Thymeleaf File Upload example
-- list of files display --

实现文件上传功能

我们使用@GetMapping@PostMapping注释用于将HTTP GET和POST请求映射到特定的处理程序方法:​​​​​​​

  • 获取/文件/新: newFile()– 返回upload_form.html模板
  • 发布/文件/上传: uploadFile()– 上传文件

FileController.java

import com.bezkoder.spring.thymeleaf.file.upload.service.FilesStorageService;@Controller
public class FileController {@AutowiredFilesStorageService storageService;@GetMapping("/files/new")public String newFile(Model model) {return "upload_form";}@PostMapping("/files/upload")public String uploadFile(Model model, @RequestParam("file") MultipartFile file) {String message = "";try {storageService.save(file);message = "Uploaded the file successfully: " + file.getOriginalFilename();model.addAttribute("message", message);} catch (Exception e) {message = "Could not upload the file: " + file.getOriginalFilename() + ". Error: " + e.getMessage();model.addAttribute("message", message);}return "upload_form";}
}

upload_form.html

Thymeleaf File Upload example

[[${message}]]

显示文件列表

首先,我们需要创建具有字段的模型:&.FileInfonameurl

model/FileInfo.java

package com.bezkoder.spring.thymeleaf.file.upload.model;public class FileInfo {private String name;private String url;public FileInfo(String name, String url) {this.name = name;this.url = url;}public String getName() {return this.name;}public void setName(String name) {this.name = name;}public String getUrl() {return this.url;}public void setUrl(String url) {this.url = url;}
}

在控制器中,我们将返回FileInfo对象列表作为模型属性。
@GetMapping、@PostMapping注释用于将 HTTP GET & POST 请求映射到特定的处理程序方法:​​​​​​​

  • 获取/文件:getListFiles() – 返回文件.html模板
  • 获取 /files/[文件名]:getFile() – 下载​​​​​​​filename文件

FileController.java

import com.bezkoder.spring.thymeleaf.file.upload.model.FileInfo;
import com.bezkoder.spring.thymeleaf.file.upload.service.FilesStorageService;@Controller
public class FileController {@AutowiredFilesStorageService storageService;// ...@GetMapping("/")public String homepage() {return "redirect:/files";}@GetMapping("/files")public String getListFiles(Model model) {List fileInfos = storageService.loadAll().map(path -> {String filename = path.getFileName().toString();String url = MvcUriComponentsBuilder.fromMethodName(FileController.class, "getFile", path.getFileName().toString()).build().toString();return new FileInfo(filename, url);}).collect(Collectors.toList());model.addAttribute("files", fileInfos);return "files";}@GetMapping("/files/{filename:.+}")public ResponseEntity getFile(@PathVariable String filename) {Resource file = storageService.load(filename);return ResponseEntity.ok().header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getFilename() + "\"").body(file);}
}

files.html

List of Files

0}">
File NameLinkActions
[[${file.name}]]Download
0}">No files found!

要删除文件,请访问以下教程:
弹簧启动删除文件示例与百里香叶

为 Servlet 配置多部分文件

让我们定义可以在 application.properties 中上传的最大文件大小,如下所示:

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

– spring.servlet.multipart.max-file-size:每个请求的最大文件大小。
– ​​​​​​​spring.servlet.multipart.max-request-size:多部分/表单数据的最大请求大小。

处理文件上传异常

这是我们处理请求超过最大上传大小的情况的地方。系统将抛出MaxUploadSizeExceededException,我们将使用@ControllerAdvice和@ExceptionHandler注释来处理异常。​​​​​​​​​​​​​​

exception/FileUploadExceptionAdvice.java

package com.bezkoder.spring.thymeleaf.file.upload.exception;import org.springframework.web.multipart.MaxUploadSizeExceededException;import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;@ControllerAdvice
public class FileUploadExceptionAdvice {@ExceptionHandler(MaxUploadSizeExceededException.class)public String handleMaxSizeException(Model model, MaxUploadSizeExceededException e) {model.addAttribute("message", "File is too large!");return "upload_form";}
}

初始化存储

我们需要运行FilesStorageService init()方法(如有必要​​​​​​​​​​​​​​deleteAll())。所以打开ThymeleafFileUploadApplication.java并实现​​​​​​​CommandLineRunnerrun()方法:​​​​​​​

package com.bezkoder.spring.thymeleaf.file.upload;import javax.annotation.Resource;import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;import com.bezkoder.spring.thymeleaf.file.upload.service.FilesStorageService;@SpringBootApplication
public class ThymeleafFileUploadApplication implements CommandLineRunner {@ResourceFilesStorageService storageService;public static void main(String[] args) {SpringApplication.run(ThymeleafFileUploadApplication.class, args);}@Overridepublic void run(String... arg) throws Exception {
//    storageService.deleteAll();storageService.init();}
}

运行 Spring 引导文件上传示例

使用以下命令运行 Spring 引导应用程序:mvn spring-boot:run

源代码

您可以在 Github 上找到本教程的完整源代码。

用于删除文件:
弹簧启动删除文件示例与百里香叶

结论

今天,我们已经学习了如何使用多部分文件创建Spring Boot Thymeleaf文件上传应用程序,并使用静态文件夹获取文件信息。

一次上传多个文件:
Spring 启动多个文件上传百里香叶

或带前端的全栈: – Angular + Spring Boot:文件上传示例 – React + Spring Boot:
文件上传示例

您还可以了解如何上传Excel / CSV文件并将内容存储在MySQL数据库中,并带有以下帖子: – Spring Boot:将Excel文件数据上传/导入MySQL数据库 – Spring Boot:将CSV文件数据上传/导入MySQL数据库
 

如果要像这样将文件存储在数据库中:

您可以在以下位置找到说明:
Spring 引导上传/下载文件到/从数据库示例

快乐学习!再见。

延伸阅读

– 弹簧启动上传图像并使用百里香叶显示 – 春季启动上传多个文件 休息 API
– 弹簧启动百里香叶 CRUD 示例
– 弹簧启动百里香叶分页和排序示例

异常处理:
– Spring Boot @ControllerAdvice & @ExceptionHandler 示例 – Spring Boot 中的@RestControllerAdvice示例

单元测试:
– JPA 存储库的弹簧引导单元测试
– 其余控制器的弹簧引导单元测试

部署:
– 在 AWS 上部署 Spring Boot 应用程序 – Elastic Beanstalk

关联:
– 带有 JPA 的 Spring Boot 一对一示例,Hibernate – 使用 JPA 的 Spring Boot One To More 示例,Hibernate – 使用 JPA 的 Spring Boot Many to Many 示例,Hibernate

 

相关内容

热门资讯

AWSECS:访问外部网络时出... 如果您在AWS ECS中部署了应用程序,并且该应用程序需要访问外部网络,但是无法正常访问,可能是因为...
AWSElasticBeans... 在Dockerfile中手动配置nginx反向代理。例如,在Dockerfile中添加以下代码:FR...
AWR报告解读 WORKLOAD REPOSITORY PDB report (PDB snapshots) AW...
AWS管理控制台菜单和权限 要在AWS管理控制台中创建菜单和权限,您可以使用AWS Identity and Access Ma...
北信源内网安全管理卸载 北信源内网安全管理是一款网络安全管理软件,主要用于保护内网安全。在日常使用过程中,卸载该软件是一种常...
​ToDesk 远程工具安装及... 目录 前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示 文件传输 设备链接 ...
Azure构建流程(Power... 这可能是由于配置错误导致的问题。请检查构建流程任务中的“发布构建制品”步骤,确保正确配置了“Arti...
群晖外网访问终极解决方法:IP... 写在前面的话 受够了群晖的quickconnet的小水管了,急需一个新的解决方法&#x...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
AWSECS:哪种网络模式具有... 使用AWS ECS中的awsvpc网络模式来获得最佳性能。awsvpc网络模式允许ECS任务直接在V...