SpringMVC文件上传

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档


一、关于multipart请求

我们一般使用的表单提交的数据都是文本类型的数据,比如我们的用户信息表单,在表单提交时,表单中的“属性-值”会被拼成字符串提交上去:

"name="+ uname +"&sex="+ sex +"&phoneNum="+uphone

这种方式对于提交文本数据来说非常简单,但是对于图片,视频这种二进制文件就不行了。那么如何提交文件呢?
这里就用到了一个叫做multipart表单的东西,multipart表单和上面介绍的普通表单不同,它会把表单分割成块,表单中的每个字段对应一个块,每个块都有自己的数据类型。

二、配置multipart resolver

实现文件上传,其实就是解析一个Mutipart请求。DispatchServlet自己并不负责去解析mutipart 请求,而是委托一个实现了MultipartResolver接口的类来解析mutipart请求。在Spring3.1之后Spring提供了两个现成的MultipartResolver接口的实现类:

  1. CommonMutipartResolver: 通过利用Jakarta Commons FileUpload来解析mutipart 请求
  2. StandardServletMutipartResolver: 依赖Servlet3.0来解析mutipart请求

要想实现文件上传功能,我们只需要在项目中配置这两个bean中的任何一个就行了。

方式一: 通过StandardServletMutipartResolver解析mutipart 请求:
1.在xml文件中配置multipartResolver的bean

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="viewResolver">
        <property name="prefix" value="/WEB-INF/views/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

    <bean id="multipartResolver" class="org.springframework.web.multipart.support.StandardServletMultipartResolver"/>

2.在web.xml文件中配置MutipartResolver相关属性

    <servlet>
        <servlet-name>DispatcherServlet</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>
        <multipart-config>
            <location>G:\input</location>
        </multipart-config>
    </servlet>

mutipart-config里面有三个配置项,我这里图方便就配置了一个:

  1. location: 上传文件用到的临时文件夹,是一个绝对路径,需要注意,这个属性是必填的
  2. max-file-size: 上传文件的最大值,单位是byte,默认没有限制
  3. max-request-size: 整个mutipart请求的最大值,单位是byte,默认没有限制

方式二: 通过CommonMutipartResolver 解析mutipart 请求

1.这个配置方式需要加第三方的类库,配置依赖

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

2.同样的,在在xml文件中配置multipartResolver的bean

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="viewResolver">
        <property name="prefix" value="/WEB-INF/views/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

   <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
       <property name="maxUploadSize" value="100000" />
       <property name="maxInMemorySize" value="100000" />
</bean>

使用这种方式不需要再web.xml文件中再去配置MultipartConfigElement元素,而且上传文件的location属性也是可选的。

需要注意的是,这两种方式在配置bean的时候id都为multipartResolver,这是为什么呢,我们可以看一下DispatchServlet中的源码,里面有这样一个方法:

private void initMultipartResolver(ApplicationContext context) {
    try {
        this.multipartResolver = (MultipartResolver)context.getBean("multipartResolver", MultipartResolver.class);
        if(this.logger.isDebugEnabled()) {
            this.logger.debug("Using MultipartResolver [" + this.multipartResolver + "]");
        }
    } catch (NoSuchBeanDefinitionException var3) {
        this.multipartResolver = null;
        if(this.logger.isDebugEnabled()) {
            this.logger.debug("Unable to locate MultipartResolver with name \'multipartResolver\': no multipart request handling provided");
        }
    }

}

这个方法会默认从Spring的上下文中获取id为multipartResolver的bean作为它的MutipartResolver。

三、Controller

按照上面的任何一种方式配置好,Spring就已经准备好接受mutipart请求了,下面就需要写一个controller来接收上传的文件了:

@Controller
public class FileController {
    @RequestMapping(value = "/fileUpload",method = RequestMethod.POST)
    @ResponseBody
    public String uploadFile(@RequestParam("file") MultipartFile file){
        if (file.isEmpty()){
            return "上传失败!";
        } else {
        	//文件存放的位置
            String rootPath = "G:\\output";
            File dir = new File(rootPath + File.separator + "tmpFiles");
            if (!dir.exists()) {
                dir.mkdirs();
            }
            //将文件写入到服务器
            File serverFile = new File(dir.getAbsolutePath() + File.separator + file.getOriginalFilename());
            try {
                file.transferTo(serverFile);
            } catch (IOException e) {
                return "上传失败!";
            }
            return "上传成功";
        }
    }
}

我们可以看到这个方法中有一个参数file是MutipartFile类型的,也就是说Spring 会自动把mutipart请求中的二进制文件转换成MutipartFile类型的对象。

四、写一个jsp测试

页面代码

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <form method="POST" action="fileUpload" enctype="multipart/form-data">
        上传文件: <input type="file" name="file">
        <input type="submit" value="Upload"> 点击上传
    </form>
</body>
</html>

这里需要注意一点的就是表单的enctype属性,这个属性值是multipart/form-data会告诉浏览器我们提交的是一个Mutipart请求而不是一个普通的form请求。