Spring MVC 上傳文件(upload files)

上傳功能是一個web應用很常用的一個功能，比如在一些社交網站上傳些圖片、視頻等。本篇文章主要研究了spring mvc是如何實現文件上傳功能的，在具體講解spring mvc如何實現處理文件上傳之前，必須弄明白與文件上傳相關的multipart請求。

一、關於multipart 請求

我們傳統的表單提交的一般都是文本類型的數據，比如我們的註冊表單，當提交表單時，表單中的“屬性-值”對會被拼接成一個字符串：

firstName=Charles&lastName=Xavier&email=professorx%40xmen.org
&username=professorx&password=letmein01

這種處理方式很簡單也很有效，但是對於圖片、視頻等二進制數據就不能這麼處理了，這裏就要用到multipart表單了。multipart表單和上面介紹的普通表單不同，它會把表單分割成塊，表單中的每個字段對應一個塊，每個塊都有自己的數據類型。也就是說，對於上傳字段對應的塊，它的數據類型就可以是二進制了：

------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="firstName"
Charles
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="lastName"
Xavier
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="email"
[email protected]
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="username"
professorx
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-Disposition: form-data; name="password"
letmein01
------WebKitFormBoundaryqgkaBn8IHJCuNmiW
Content-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來接收上傳的文件了，請看代碼：

@Controller
public 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請求。

看一下頁面效果：

運行程序，試着上傳一個文件吧。

Heaven-Wang

發佈了98 篇原創文章 · 獲贊 1135 · 訪問量 154萬+

他的留言板關注

Spring MVC 上傳文件(upload files)

一、關於multipart 請求

二、配置mutipart resolver

三、寫一個上傳文件的controller

四、寫個upload.jsp頁面測試一下

Spring MVC 頁面渲染( render view )

Spring整合JMS(消息中間件)實例

Spring MVC 上傳文件(upload files)

設計模式之動態代理(dynamic proxy)

Spring MVC 中的異常處理 (handling exceptions)

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結