SpringMVC上传文件的方法

在本SpringMVC教程中，我们将重点介绍 Spring 为Web 应用程序中的多部分(文件上传)支持提供的功能。

Spring 允许我们使用可插入的MultipartResolver对象启用这种多部分支持。该框架提供了一个用于Commons FileUpload的MultipartResolver实现和另一个用于Servlet 3.0多部分请求解析的实现。

配置MultipartResolver后，我们将看到如何上传单个文件和多个文件。

我们还将涉及Spring Boot。

1.共享文件上传

要使用CommonsMultipartResolver处理文件上传，我们需要添加以下依赖项：

<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.4</version>
</dependency>

现在我们可以在 Spring 配置中定义CommonsMultipartResolver bean。

这个MultipartResolver带有一系列set方法来定义属性，例如上传的最大大小：

@Bean(name = "multipartResolver")
public CommonsMultipartResolver multipartResolver() {
    CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver();
    multipartResolver.setMaxUploadSize(100000);
    return multipartResolver;
}

这里我们需要在 Bean 定义本身中控制CommonsMultipartResolver的不同属性。

2. 使用Servlet 3.0

为了使用Servlet 3.0多部分解析，我们需要配置几个应用程序。

首先，我们需要在DispatcherServlet注册中设置一个MultipartConfigElement：

public class MainWebAppInitializer implements WebApplicationInitializer {
    private String TMP_FOLDER = "/tmp"; 
    private int MAX_UPLOAD_SIZE = 5 * 1024 * 1024;     
    @Override
    public void onStartup(ServletContext sc) throws ServletException {        
        ServletRegistration.Dynamic appServlet = sc.addServlet("mvc", new DispatcherServlet(
          new GenericWebApplicationContext()));
        appServlet.setLoadOnStartup(1);        
        MultipartConfigElement multipartConfigElement = new MultipartConfigElement(TMP_FOLDER, 
          MAX_UPLOAD_SIZE, MAX_UPLOAD_SIZE * 2, MAX_UPLOAD_SIZE / 2);       
        appServlet.setMultipartConfig(multipartConfigElement);
    }
}

在MultipartConfigElement对象中，我们配置了存储位置、最大单个文件大小、最大请求大小(在单个请求中有多个文件的情况下)以及文件上传进度刷新到存储位置的大小。

这些设置必须在 servlet 注册级别应用，因为Servlet 3.0不允许像CommonsMultipartResolver那样在MultipartResolver中注册它们。

完成后，我们可以将StandardServletMultipartResolver添加到 Spring 配置中：

@Bean
public StandardServletMultipartResolver multipartResolver() {
    return new StandardServletMultipartResolver();
}

3. 上传文件

要上传我们的文件，我们可以构建一个简单的表单，在该表单中使用带有type='file'的 HTML输入标签。

无论我们选择哪种上传处理配置，我们都需要将表单的编码属性设置为multipart/form-data。

这让浏览器知道如何对表单进行编码：

<form:form method="POST" action="/spring-mvc-xml/uploadFile" enctype="multipart/form-data">
    <table>
        <tr>
            <td><form:label path="file">Select a file to upload</form:label></td>
            <td><input type="file" name="file" /></td>
        </tr>
        <tr>
            <td><input type="submit" value="Submit" /></td>
        </tr>
    </table>
</form>

要存储上传的文件，我们可以使用MultipartFile变量。

我们可以从控制器方法中的请求参数中检索此变量：

@RequestMapping(value = "/uploadFile", method = RequestMethod.POST)
public String submit(@RequestParam("file") MultipartFile file, ModelMap modelMap) {
    modelMap.addAttribute("file", file);
    return "fileUploadView";
}

MultipartFile类提供对上传文件的详细信息的访问，包括文件名、文件类型等。

我们可以使用一个简单的 HTML 页面来显示这些信息：

<h2>Submitted File</h2>
<table>
    <tr>
        <td>OriginalFileName:</td>
        <td>${file.originalFilename}</td>
    </tr>
    <tr>
        <td>Type:</td>
        <td>${file.contentType}</td>
    </tr>
</table>

4.上传多个文件

要在单个请求中上传多个文件，我们只需在表单中放置多个输入文件字段：

<form:form method="POST" action="/spring-mvc-java/uploadMultiFile" enctype="multipart/form-data">
    <table>
        <tr>
            <td>Select a file to upload</td>
            <td><input type="file" name="files" /></td>
        </tr>
        <tr>
            <td>Select a file to upload</td>
            <td><input type="file" name="files" /></td>
        </tr>
        <tr>
            <td>Select a file to upload</td>
            <td><input type="file" name="files" /></td>
        </tr>
        <tr>
            <td><input type="submit" value="Submit" /></td>
        </tr>
    </table>
</form:form>

我们需要注意每个输入字段具有相同的名称，以便可以将其作为MultipartFile的数组进行访问：

@RequestMapping(value = "/uploadMultiFile", method = RequestMethod.POST)
public String submit(@RequestParam("files") MultipartFile[] files, ModelMap modelMap) {
    modelMap.addAttribute("files", files);
    return "fileUploadView";
}

现在我们可以简单地遍历该数组以显示文件信息：

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<html>
    <head>
        <title>Spring MVC File Upload</title>
    </head>
    <body>
        <h2>Submitted Files</h2>
        <table>
            <c:forEach items="${files}" var="file">    
                <tr>
                    <td>OriginalFileName:</td>
                    <td>${file.originalFilename}</td>
                </tr>
                <tr>
                    <td>Type:</td>
                    <td>${file.contentType}</td>
                </tr>
            </c:forEach>
        </table>
    </body>
</html>

5. 上传带有附加表单数据的文件

我们还可以将附加信息与正在上传的文件一起发送到服务器。

我们只需在表单中包含必填字段：

<form:form method="POST" 
  action="/spring-mvc-java/uploadFileWithAddtionalData"
  enctype="multipart/form-data">
    <table>
        <tr>
            <td>Name</td>
            <td><input type="text" name="name" /></td>
        </tr>
        <tr>
            <td>Email</td>
            <td><input type="text" name="email" /></td>
        </tr>
        <tr>
            <td>Select a file to upload</td>
            <td><input type="file" name="file" /></td>
        </tr>
        <tr>
            <td><input type="submit" value="Submit" /></td>
        </tr>
    </table>
</form:form>

在控制器中，我们可以使用@RequestParam注解获取所有表单数据：

@PostMapping("/uploadFileWithAddtionalData")
public String submit(
  @RequestParam MultipartFile file, @RequestParam String name,
  @RequestParam String email, ModelMap modelMap) {
    modelMap.addAttribute("name", name);
    modelMap.addAttribute("email", email);
    modelMap.addAttribute("file", file);
    return "fileUploadView";
}

与前面部分类似，我们可以使用带有JSTL标记的 HTML 页面来显示信息。

我们也可以封装模型类中的所有表单字段并使用@ModelAttribute注释在控制器。这将是有用的,当有很多额外的字段以及文件。

让我们看一下代码:

public class FormDataWithFile {
    private String name;
    private String email;
    private MultipartFile file;
    // standard getters and setters
}

@PostMapping("/uploadFileModelAttribute")
public String submit(@ModelAttribute FormDataWithFile formDataWithFile, ModelMap modelMap) {
    modelMap.addAttribute("formDataWithFile", formDataWithFile);
    return "fileUploadView";
}

6.Spring引导文件上传

如果我们使用Spring的引导,到目前为止,我们看到的所有东西都仍然适用。

然而,Spring引导使其更容易配置和启动一切麻烦。

特别是,它没有必要配置启动以来的任何servlet将注册和配置它对于我们来说,如果我们在依赖关系包括web模块:

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

我们能找到的最新版本spring-boot-starter-web Maven中央。

如果我们想控制最大文件上传大小，我们可以编辑我们的application.properties：

spring.servlet.multipart.max-file-size=128KB
spring.servlet.multipart.max-request-size=128KB

我们还可以控制是否启用文件上传以及文件上传的位置：

spring.servlet.multipart.enabled=true
spring.servlet.multipart.location=${java.io.tmpdir}

请注意，我们使用${java.io.tmpdir}来定义上传位置，以便我们可以将临时位置用于不同的操作系统。如果大家想了解更多相关知识，不妨来关注一下本站的SpringMVC视频教程，里面的课程内容细致全面，通俗易懂，很适合小白学习，希望对大家能够有所帮助哦。