讓我們捋一捋上傳和下載

作者：程序員千羽 2021-11-04 18:15:55

開發前端

當form表單的enctype屬性為multipart/form-data時，瀏覽器就會采用二進制流來處理表單數據，服務器端就會對文件上傳的請求進行解析處理。

[[433275]]

GitHub：https://github.com/nateshao/ssm/tree/master/111-springmvc-file-upload

1. 文件上傳

文件上傳概述

“多數文件上傳都是通過表單形式提交給后臺服務器的，因此，要實現文件上傳功能，就需要提供一個文件上傳的表單，而該表單必須滿足以下3個條件：

form表單的method屬性設置為post;
form表單的enctype屬性設置為multipart/form-data;
提供< input type="file" name="filename" />的文件上傳輸入框。

文件上傳表單示例如下

<form action="uploadUrl" method="post" enctype="multipart/form-data"> 
 
  <input type="file" name="filename" multiple="multiple" /> 
 
  <input type="submit" value="文件上傳" /> 
 
</form>

multiple屬性是HTML5中新屬性，可實現多文件上傳

當form表單的enctype屬性為multipart/form-data時，瀏覽器就會采用二進制流來處理表單數據，服務器端就會對文件上傳的請求進行解析處理。Spring MVC通過MultipartResolver實現文件上傳功能。MultipartResolver是一個接口對象，需要通過它的實現CommonsMultipartResolver來完成文件上傳工作。

MultipartResolver配置示例如下:

<bean id="multipartResolver"                 
     class="org.springframework.web.multipart.commons.CommonsMultipartResolver"> 
    設置請求編碼格式，必須與JSP中的pageEncoding屬性一致，默認為ISO-8859-1 
    <property name="defaultEncoding" value="UTF-8" /> 
    設置允許上傳文件的最大值（2M），單位為字節 
    <property name="maxUploadSize" value="2097152" /> 
             ... 
</bean>

在前面的配置代碼中，除配置了CommonsMultipartResolver類外，還通過< property>元素配置了編碼格式以及允許上傳文件的大小。通過< property>元素可以對文件解析器類CommonsMultipartResolver的如下屬性進行配置：

maxUploadSize：上傳文件最大長度(以字節為單位);
maxInMemorySize：緩存中的最大尺寸;
defaultEncoding：默認編碼格式;
resolveLazily：推遲文件解析，以便在Controller中捕獲文件大小異常。

注意：因為MultipartResolver接口的實現類CommonsMultipartResolver內部是引用multipartResolver字符串獲取該實現類對象并完成文件解析的，所以在配置CommonsMultipartResolver時必須指定該Bean的id為multipartResolver。

由于CommonsMultipartResolver是Spring MVC內部通過Apache Commons FileUpload技術實現的，所以Spirng MVC的文件上傳還需要依賴Apache Commons FileUpload的組件，即需要導入支持文件上傳的相關JAR包。

commons-fileupload-1.3.2.jar
lcommons-io-2.5.jar

當完成頁面表單和文件上傳解析器的配置后，在Controller中編寫文件上傳的方法即可實現文件上傳，其代碼如下所示：

 /** 
     * 執行文件上傳 
     * @param name 
     * @param uploadfile 
     * @param request 
     * @return 
     */ 
@RequestMapping("/fileUpload") 
public String handleFormUpload(@RequestParam("name") String name, 
                                   @RequestParam("uploadfile") List<MultipartFile> uploadfile,//使用MultipartFile 綁定接收上傳文件 
                                   HttpServletRequest request) { 
        // 判斷所上傳文件是否存在 
        if (!uploadfile.isEmpty() && uploadfile.size() > 0) { 
            //循環輸出上傳的文件 
            for (MultipartFile file : uploadfile) { 
                // 獲取上傳文件的原始名稱 
                String originalFilename = file.getOriginalFilename(); 
                // 設置上傳文件的保存地址目錄 
                String dirPath = 
                        request.getServletContext().getRealPath("/upload/"); 
                File filePath = new File(dirPath); 
                // 如果保存文件的地址不存在，就先創建目錄 
                if (!filePath.exists()) { 
                    filePath.mkdirs(); 
                } 
                // 使用UUID重新命名上傳的文件名稱(上傳人_uuid_原始文件名稱) 
                String newFilename = name + "_" + UUID.randomUUID() + 
                        "_" + originalFilename; 
                try { 
                    // 使用MultipartFile接口的方法完成文件上傳到指定位置 
                    file.transferTo(new File(dirPath + newFilename)); 
                } catch (Exception e) { 
                    e.printStackTrace(); 
                    return "error"; 
                } 
            } 
            // 跳轉到成功頁面 
            return "success"; 
        } else { 
            return "error"; 
        } 
    }

在上述代碼中，包含一個MultipartFile接口類型的參數file，上傳到程序中的文件是被封裝在該參數中的。

org.springframework.web.multipart.MultipartFile接口中提供了獲取上傳文件、文件名稱等方法，如下表所示：

代碼實現：

fileUpload.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" 
         pageEncoding="UTF-8" %> 
<!DOCTYPE html> 
<html> 
<head> 
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 
    <title>文件上傳</title> 
    <script> 
        // 判斷是否填寫上傳人并已選擇上傳文件 
        function check() { 
            var name = document.getElementById("name").value; 
            var file = document.getElementById("file").value; 
            if (name == "") { 
                alert("填寫上傳人"); 
                return false; 
            } 
            if (file.length == 0 || file == "") { 
                alert("請選擇上傳文件"); 
                return false; 
            } 
            return true; 
        } 
    </script> 
</head> 
<body> 
<form action="${pageContext.request.contextPath }/fileUpload" 
      method="post" enctype="multipart/form-data" onsubmit="return check()"> 
    上傳人：<input id="name" type="text" name="name"/><br/> 
    請選擇文件：<input id="file" type="file" name="uploadfile" 
                 multiple="multiple"/><br/> 
    <input type="submit" value="上傳"/> 
</form> 
</body> 
</html>

2. 文件下載

文件下載就是將文件服務器中的文件下載到本機上。在Spring MVC環境中，實現文件下載大致可分為如下兩個步驟：

在客戶端頁面使用一個文件下載的超鏈接，該鏈接的href屬性要指定后臺文件下載的方法以及文件名(需要先在文件下載目錄中添加了一個名稱為“1.jpg”的文件)。

<a href="${pageContext.request.contextPath }/download?filename=1.jpg"> 
     文件下載  
</a>

在后臺使用Spring MVC提供的ResponseEntity類型對象完成文件下載，使用它可以很方便的定義返回的HttpHeaders對象和HttpStatus對象，通過對這兩個對象的設置，即可完成下載文件時所需的配置信息。

@RequestMapping("/download") 
public ResponseEntity<byte[]> fileDownload(HttpServletRequest request, 
                                               String filename) throws Exception { 
        // 指定要下載的文件所在路徑 
        String path = request.getServletContext().getRealPath("/upload/"); 
        // 創建該文件對象 
        File file = new File(path + File.separator + filename); 
        // 對文件名編碼，防止中文文件亂碼 
        filename = this.getFilename(request, filename); 
        // 設置響應頭 
        HttpHeaders headers = new HttpHeaders(); 
        // 通知瀏覽器以下載的方式打開文件 
        headers.setContentDispositionFormData("attachment", filename); 
        // 定義以流的形式下載返回文件數據 
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM); 
        // 使用Sring MVC框架的ResponseEntity對象封裝返回下載數據 
        return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file), 
                headers, HttpStatus.OK); 
}

文件下載中的ResponseEntity對象有些類似前面章節中的@ResponseBody注解，它用于直接返回結果對象。

響應頭信息中的MediaType代表的是Interner Media Type(即互聯網媒體類型)，也叫做MIME類型，MediaType.APPLICATION_OCTET_STREAM的值為application/octet-stream，即表示以二進制流的形式下載數據;

HttpStatus類型代表的是Http協議中的狀態，示例中的HttpStatus.OK表示200，即服務器已成功處理了請求。

當對中文名文件下載時會怎樣?

當對中文名稱的文件進行下載時，因為各個瀏覽器內部轉碼機制的不同，就會出現不同的亂碼以及解析異常問題。

如何解決中文名文件下載亂碼問題呢?

為了解決瀏覽器中文件下載時中文名稱的亂碼問題，可以在前端頁面發送請求前先對中文名進行統一編碼，然后在后臺控制器類中對文件名稱進行相應的轉碼。

在下載頁面中對中文文件名編碼。可以使用Servlet API中URLEncoder.encoder(String s, String enc)方法將中文轉為UTF-8編碼。

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> 
  <%@page import="java.net.URLEncoder"%> 
  ... 
  <body> 
      <a href="${pageContext.request.contextPath }/download?filename=<%=URLEncoder.encode(“  
        壁紙.jpg", "UTF-8")%>"> 
 中文名稱文件下載 </a> 
    </body> 
</html>

在控制器類中編寫對中文名文件下載時進行轉碼編碼的方法。

public String getFilename(HttpServletRequest request,String filename) throws Exception {  
          String[] IEBrowserKeyWords = {"MSIE", "Trident", "Edge"};   
          String userAgent = request.getHeader("User-Agent");   
          for (String keyWord : IEBrowserKeyWords) {  
                if (userAgent.contains(keyWord)) {  
                        return URLEncoder.encode(filename, "UTF-8"); 
                } 
          }   
          return new String(filename.getBytes("UTF-8"), "ISO-8859-1");   
}

總結

本章主要對Spring MVC環境下的文件上傳和下載進行了詳細講解。

首先講解了如何實現文件上傳，并通過一個應用案例來演示文件上傳功能的實現;

然后講解了非中文名稱文件下載的實現過程，以及中文名稱文件下載的實現過程。

通過本章的學習，我們要學會如何在Spring MVC環境下進行文件上傳和下載，并能夠掌握中文名稱文件下載時亂碼的解決方案。

責任編輯：武曉燕來源：程序員千羽

下載上傳瀏覽器