SpringMVC实现文件上传功能

---

SpringMVC实现文件上传功能

一、文件上传的要求

• form表单的请求方式必须为post
• form表单必须设置属性 enctype=“multipart/form-data”
• 配置文件 springmvc.xml
• 配置jar包 pom.xml

二、项目结构

三、代码

1、pom.xml

    <!--配置 war 是 web项目-->
    <packaging>war</packaging>

    <!--配置jar包-->
    <dependencies>
        <!-- Spring MVC-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.22</version>
        </dependency>
        <!-- Spring5 和 Thymeleaf 整合包 -->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.15.RELEASE</version>
        </dependency>
        <!--文件上传-->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.4</version>
        </dependency>
    </dependencies>

2、web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--设置SpringMVC的前端控制器-->
    <servlet>
        <servlet-name>SpringMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>SpringMVC</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

3、springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans 
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/mvc 
       https://www.springframework.org/schema/mvc/spring-mvc.xsd 
       http://www.springframework.org/schema/context 
       https://www.springframework.org/schema/context/spring-context.xsd">

    <!--扫描控制层组件-->
    <context:component-scan base-package="com.sgz.controller"/>

    <!--配置Thymeleaf视图解析器-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!--视图前缀-->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--视图后缀-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>
    
    <!--开启MVC的注解驱动-->
    <mvc:annotation-driven/>

    <!-- 配置视图控制器 -->
    <mvc:view-controller path="/" view-name="index"/>

    <!--配置文件上传解析器-->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"/>

</beans>

4、FileUploadController

package com.sgz.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import java.io.File;
import java.io.IOException;
import java.util.UUID;

/**
 * 作者：沈公子
 * 日期：2022/8/10 - 10:46
 * 需求：SpringMVC实现文件上传
 * 文件上传的要求：
 * 1、form表单的请求方式必须为post
 * 2、form表单必须设置属性 enctype="multipart/form-data"
 * 3、配置文件 springmvc.xml
 * 4、配置jar包 pom.xml
 */
@Controller
public class FileUploadController {
	// 参数名photo与前端的name值对应
    @RequestMapping("/upload")
    public String testUp(MultipartFile photo, HttpSession session) throws IOException {
        // 获取上传的文件的文件名
        String filename = photo.getOriginalFilename();
        System.out.println(filename);
        // 获取上传文件的后缀名
        String hzName = filename.substring(filename.lastIndexOf("."));
        // 获取 uuid
        String uuid = UUID.randomUUID().toString();
        // 拼接一个新的文件名
        filename = uuid + hzName;
        // 获取 ServletContext
        ServletContext servletContext = session.getServletContext();
        // 获取当前工程下 photo 目录的真实路径
        String photoPath = servletContext.getRealPath("photo");
        // 创建 photoPath 所对应的 File 对象
        File file = new File(photoPath);
        // 判断file所对应目录是否存在
        if (!file.exists()) {
            file.mkdir();
        }
        String finalPath = photoPath + File.separator + filename;
        // 上传文件
        photo.transferTo(new File(finalPath));
        return "success";
    }
}

5、index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
<h3>传统的超链接路径</h3>
<form action="http://localhost:8080/upload" method="post" enctype="multipart/form-data">
    头像：<input type="file" name="photo"><br> <!--name的值与后端对应-->
    <input type="submit" value="上传">
</form>
<br>
<h3>Thymeleaf超链接路径</h3>
<form th:action="@{/upload}" method="post" enctype="multipart/form-data">
    头像：<input type="file" name="photo"><br> <!--name的值与后端对应-->
    <input type="submit" value="上传">
</form>
</body>
</html>

6、success.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>成功</title>
</head>
<body>
<h1>上传成功</h1>
</body>
</html>