天天看点

Spring MVC 上传文件(upload files)

上传功能是一个web应用很常用的一个功能,比如在一些社交网站上传些图片、视频等。本篇文章主要研究了spring mvc是如何实现文件上传功能的,在具体讲解spring mvc如何实现处理文件上传之前,必须弄明白与文件上传相关的multipart请求。

我们传统的表单提交的一般都是文本类型的数据,比如我们的注册表单,当提交表单时,表单中的“属性-值”对会被拼接成一个字符串:

这种处理方式很简单也很有效,但是对于图片、视频等二进制数据就不能这么处理了,这里就要用到multipart表单了。multipart表单和上面介绍的普通表单不同,它会把表单分割成块,表单中的每个字段对应一个块,每个块都有自己的数据类型。也就是说,对于上传字段对应的块,它的数据类型就可以是二进制了:

在上面这个请求就是mutipart 请求,最后一个字段<code>profilepicture</code>有自己的<code>content-type</code>,值是<code>image/jpeg</code>,而其它字段都是简单的文本类型。

虽然mutipart请求看起来比较复杂,但是在spring mvc中处理起来是非常简单的。在写我们处理上传文件的controller之前,我们得先配置一个mutipart resolver来告诉<code>dispatchservlet</code>如何解析一个mutipart 请求。

实现文件上传,其实就是解析一个mutipart请求。dispatchservlet自己并不负责去解析mutipart 请求,而是委托一个实现了<code>multipartresolver</code>接口的类来解析mutipart请求。在spring3.1之后spring提供了两个现成的multipartresolver接口的实现类:

<code>commonmutipartresolver</code>:通过利用<code>jakarta commons fileupload</code>来解析mutipart 请求

<code>standardservletmutipartresolver</code>:依赖<code>servlet3.0</code>来解析mutipart请求

所以要实现文件上传功能,只需在我们的项目中配置好这两个bean中的任何一个即可。其实这两个都很好用,如果我们部署的容器支持servlet3.0,我们完全可以使用<code>standardservletmutipartresolver</code>。但是如果我们的应用部署的容器不支持servlet3.0或者用到的spring版本是3.1以前的,那么我们就需要用到<code>commonmutipartresolver</code>了。下面就具体介绍一下两种bean的配置,当然也是实现文件上传的两种配置。

方式一: 通过standardservletmutipartresolver解析mutipart 请求

1.配置multipartresolver的bean

2.配置mutipartresolver相关属性

<code>standardservletmutipartresolver</code>依赖于servlet3.0,所以要想使用<code>standardservletmutipartresolver</code>,我们还必须在dispatchservlet配置里面 注册一个 <code>multipartconfigelement</code>元素,具体配置方式如下:

<code>mutipart-config</code>里面有三个配置项:

location:上传文件用到的临时文件夹,是一个绝对路径,需要注意,这个属性是必填的

max-file-size:上传文件的最大值,单位是byte,默认没有限制

max-request-size:整个mutipart请求的最大值,单位是byte,默认没有限制

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

当然,如果我们部署的容器不是servlet3.0,我们还可以使用<code>commonmutipartresolver</code>,不过这个需要依赖apache的<code>commons-fileupload</code>第三方类库。

1.配置第三方依赖

2.配置multipartresolver的bean

使用<code>commonmutipartresolver</code>不需要在servlet中配置<code>multipartconfigelement</code>元素,上传文件的location属性也是可选的。

大家可能有个小疑问,上面两种方式都配置了一个id=”multipartresolver”的bean,那么dispatchservlet是如何找到这个bean的呢?我们可以看一下dispatchservlet的源码,里面有这么一个方法:

这个方法会默认从spring的上下文中获取id为multipartresolver的bean作为它的mutipartresolver。

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

<code>uploadfilehandler</code>方法中有一个参数file,它的类型是mutipartfile,也就是说spring 会自动把mutipart请求中的二进制文件转换成mutipartfile类型的对象,这么做有什么好处呢?我们具体看一下mutipartfile这个接口:

我们可以看到mutipartfile接口提供了很多方法,诸如获取上传文件的名称、内容类型、大小等等,甚至还提供了转换成file类型文件的方法。想想如果我们接收到仅仅是一个字节数组,那用起来该多么麻烦,感激这个mutipartfile吧。

我们的页面代码:

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

看一下页面效果:

Spring MVC 上传文件(upload files)

运行程序,试着上传一个文件吧。