Spring MVC 上传文件(upload files)
来源:互联网 发布:美国与中国的差距知乎 编辑:程序博客网 时间:2024/05/16 09:34
上传功能是一个web应用很常用的一个功能,比如在一些社交网站上传些图片、视频等。本篇文章主要研究了spring mvc是如何实现文件上传功能的,在具体讲解spring mvc如何实现处理文件上传之前,必须弄明白与文件上传相关的multipart请求。
一、关于multipart 请求
我们传统的表单提交的一般都是文本类型的数据,比如我们的注册表单,当提交表单时,表单中的“属性-值”对会被拼接成一个字符串:
firstName=Charles&lastName=Xavier&email=professorx%40xmen.org&username=professorx&password=letmein01
这种处理方式很简单也很有效,但是对于图片、视频等二进制数据就不能这么处理了,这里就要用到multipart表单了。multipart表单和上面介绍的普通表单不同,它会把表单分割成块,表单中的每个字段对应一个块,每个块都有自己的数据类型。也就是说,对于上传字段对应的块,它的数据类型就可以是二进制了:
------WebKitFormBoundaryqgkaBn8IHJCuNmiWContent-Disposition: form-data; name="firstName"Charles------WebKitFormBoundaryqgkaBn8IHJCuNmiWContent-Disposition: form-data; name="lastName"Xavier------WebKitFormBoundaryqgkaBn8IHJCuNmiWContent-Disposition: form-data; name="email"charles@xmen.com------WebKitFormBoundaryqgkaBn8IHJCuNmiWContent-Disposition: form-data; name="username"professorx------WebKitFormBoundaryqgkaBn8IHJCuNmiWContent-Disposition: form-data; name="password"letmein01------WebKitFormBoundaryqgkaBn8IHJCuNmiWContent-Disposition: form-data; name="profilePicture"; filename="me.jpg"Content-Type: image/jpeg[[ Binary image data goes here ]]------WebKitFormBoundaryqgkaBn8IHJCuNmiW--
在上面这个请求就是mutipart 请求,最后一个字段profilePicture
有自己的Content-Type
,值是image/jpeg
,而其它字段都是简单的文本类型。
虽然mutipart请求看起来比较复杂,但是在spring mvc中处理起来是非常简单的。在写我们处理上传文件的controller之前,我们得先配置一个Mutipart Resolver来告诉DispatchServlet
如何解析一个mutipart 请求。
二、配置mutipart resolver
实现文件上传,其实就是解析一个Mutipart请求。DispatchServlet自己并不负责去解析mutipart 请求,而是委托一个实现了MultipartResolver
接口的类来解析mutipart请求。在Spring3.1之后Spring提供了两个现成的MultipartResolver接口的实现类:
CommonMutipartResolver
:通过利用Jakarta Commons FileUpload
来解析mutipart 请求StandardServletMutipartResolver
:依赖Servlet3.0
来解析mutipart请求
所以要实现文件上传功能,只需在我们的项目中配置好这两个bean中的任何一个即可。其实这两个都很好用,如果我们部署的容器支持Servlet3.0,我们完全可以使用StandardServletMutipartResolver
。但是如果我们的应用部署的容器不支持Servlet3.0或者用到的Spring版本是3.1以前的,那么我们就需要用到CommonMutipartResolver
了。下面就具体介绍一下两种bean的配置,当然也是实现文件上传的两种配置。
方式一: 通过StandardServletMutipartResolver解析mutipart 请求
1.配置multipartResolver的bean
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" > <property name="prefix" value="/WEB-INF/views/" /> <property name="suffix" value=".jsp" /> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" /></bean><bean id="multipartResolver" class="org.springframework.web.multipart.support.StandardServletMultipartResolver"/>
2.配置MutipartResolver相关属性
StandardServletMutipartResolver
依赖于Servlet3.0,所以要想使用StandardServletMutipartResolver
,我们还必须在DispatchServlet配置里面 注册一个 MultipartConfigElement
元素,具体配置方式如下:
<servlet> <servlet-name>appServlet</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet </servlet-class> <load-on-startup>1</load-on-startup> <multipart-config> <location>/tmp/spittr/uploads</location> <max-file-size>2097152</max-file-size> <max-request-size>4194304</max-request-size> </multipart-config></servlet>
mutipart-config
里面有三个配置项:
- location:上传文件用到的临时文件夹,是一个绝对路径,需要注意,这个属性是必填的
- max-file-size:上传文件的最大值,单位是byte,默认没有限制
- max-request-size:整个mutipart请求的最大值,单位是byte,默认没有限制
方式二:通过CommonMutipartResolver 解析mutipart 请求
当然,如果我们部署的容器不是Servlet3.0,我们还可以使用CommonMutipartResolver
,不过这个需要依赖Apache的commons-fileupload
第三方类库。
1.配置第三方依赖
<dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.3.1</version></dependency>
2.配置multipartResolver的bean
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" > <property name="prefix" value="/WEB-INF/views/" /> <property name="suffix" value=".jsp" /> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" /><bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"> <property name="maxUploadSize" value="100000" /> <property name="maxInMemorySize" value="100000" /></bean>
使用CommonMutipartResolver
不需要在Servlet中配置MultipartConfigElement
元素,上传文件的location属性也是可选的。
大家可能有个小疑问,上面两种方式都配置了一个id=”multipartResolver”的bean,那么DispatchServlet是如何找到这个bean的呢?我们可以看一下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来接收上传的文件了,请看代码:
@Controllerpublic class FileUploadController { @RequestMapping(value = "/uploadFile", method = RequestMethod.POST) @ResponseBody public String uploadFileHandler( @RequestParam("file") MultipartFile file) { if (!file.isEmpty()) { try { // 文件存放服务端的位置 String rootPath = "d:/tmp"; File dir = new File(rootPath + File.separator + "tmpFiles"); if (!dir.exists()) dir.mkdirs(); // 写文件到服务器 File serverFile = new File(dir.getAbsolutePath() + File.separator + file.getOriginalFilename()); file.transferTo(serverFile); return "You successfully uploaded file=" + file.getOriginalFilename(); } catch (Exception e) { return "You failed to upload " + file.getOriginalFilename() + " => " + e.getMessage(); } } else { return "You failed to upload " + file.getOriginalFilename() + " because the file was empty."; } }}
uploadFileHandler
方法中有一个参数file,它的类型是MutipartFile,也就是说Spring 会自动把mutipart请求中的二进制文件转换成MutipartFile类型的对象,这么做有什么好处呢?我们具体看一下MutipartFile这个接口:
public interface MultipartFile { String getName(); String getOriginalFilename(); String getContentType(); boolean isEmpty(); long getSize(); byte[] getBytes() throws IOException; InputStream getInputStream() throws IOException; void transferTo(File var1) throws IOException, IllegalStateException;}
我们可以看到MutipartFile接口提供了很多方法,诸如获取上传文件的名称、内容类型、大小等等,甚至还提供了转换成File类型文件的方法。想想如果我们接收到仅仅是一个字节数组,那用起来该多么麻烦,感激这个MutipartFile吧。
四、写个upload.jsp页面测试一下
我们的页面代码:
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %><%@ page session="false" %><html> <head> <title>Upload File Request Page</title> </head> <body> <form method="POST" action="uploadFile" enctype="multipart/form-data"> File to upload: <input type="file" name="file"> <input type="submit" value="Upload"> Press here to upload the file! </form> </body></html>
其中只有一点需要注意,就是表单的enctype
属性,这个属性值multipart/form-data
会告诉浏览器我们提交的是一个Mutipart请求而不是一个普通的form请求。
看一下页面效果:
运行程序,试着上传一个文件吧。
- Spring MVC 上传文件(upload files)
- 利用 Spring MVC 上传多文件到指定目录 spring upload files
- Spring MVC 文件上传 file upload
- 【Spring】Spring MVC文件上传--整合bootstrap-fileinput和jQuery-File-Upload
- 在Spring mvc中配置upload,实现文件上传功能的两种方式
- Spring + Open Feign upload file 文件上传
- spring mvc 文件上传
- spring MVC 文件上传
- Spring MVC文件上传
- Spring MVC文件上传
- spring mvc 文件上传
- Spring mvc 文件上传
- spring mvc 文件上传
- spring mvc 上传文件
- spring mvc 上传文件
- spring mvc 文件上传
- spring mvc 上传文件
- spring mvc文件上传
- hive order by,sort by,distributed by
- 数据结构与算法:字符串
- 【leetcode】34Search for a Range(二分搜索上下界)
- easyui-combobox添加onChange事件
- Android studio 中查看sha1值的方法
- Spring MVC 上传文件(upload files)
- The Structure of an MPEG-DASH MPD(译)
- Spring MVC拦截器+注解方式实现防止表单重复提交
- Remove Linked List Elements 链表元素的删除
- android 仿淘宝、京东商品详情页 向上拖动查看图文详情控件
- optimization
- 【JavaScript】难点1-继承
- 4C - Registration System【map】
- Zookeeper初印象