SpringMVC文件上傳與下載怎么實現

這篇文章主要介紹“SpringMVC文件上傳與下載怎么實現”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“SpringMVC文件上傳與下載怎么實現”文章能幫助大家解決問題。

前言

文件上傳是項目開發中最常見的功能之一 ，SpringMVC 可以很好的支持文件上傳，但是SpringMVC上下文中默認沒有裝配MultipartResolver，因此默認情況下其不能處理文件上傳工作。如果想使用Spring的文件上傳功能，則需要在上下文中配置MultipartResolver。

前端表單要求：為了能上傳文件，必須將表單的method設置為POST，并將enctype設置為multipart/form-data。只有在這樣的情況下，瀏覽器才會把用戶選擇的文件以二進制數據發送給服務器。

<form action="" enctype="multipart/form-data" method="post">
    <input type="file" name="file"/>
    <input type="submit">
</form>

表單中enctype屬性的詳細說明：

• application/x-www=form-urlencoded：默認方式，只處理表單域中的 value 屬性值，采用這種編碼方式的表單會將表單域中的值處理成 URL 編碼方式。

• multipart/form-data：這種編碼方式會以二進制流的方式來處理表單數據，這種編碼方式會把文件域指定文件的內容也封裝到請求參數中，不會對字符編碼。

• text/plain：除了把空格轉換為 “+” 號外，其他字符都不做編碼處理，這種方式適用直接通過表單發送郵件。

一旦設置了enctype為multipart/form-data，瀏覽器即會采用二進制流的方式來處理表單數據，而對于文件上傳的處理則涉及在服務器端解析原始的HTTP響應。在2003年，Apache Software Foundation發布了開源的Commons FileUpload組件，其很快成為Servlet/JSP程序員上傳文件的最佳選擇。

• Servlet3.0規范已經提供方法來處理文件上傳，但這種上傳需要在Servlet中完成。而Spring MVC則提供了更簡單的封裝。

• Spring MVC為文件上傳提供了直接的支持，這種支持是用即插即用的MultipartResolver實現的。

• Spring MVC使用Apache Commons FileUpload技術實現了一個MultipartResolver實現類：CommonsMultipartResolver。因此，SpringMVC的文件上傳還需要依賴Apache Commons FileUpload的組件。

一、文件上傳

【MultipartResolver】用于處理文件上傳。當收到請求時，DispatcherServlet 的 checkMultipart() 方法會調用 MultipartResolver 的 isMultipart() 方法判斷請求中【是否包含文件】。如果請求數據中包含文件，則調用 MultipartResolver 的 resolveMultipart() 方法對請求的數據進行解析，然后將文件數據解析成 MultipartFile 并封裝在 MultipartHttpServletRequest (繼承了 HttpServletRequest) 對象中，最后傳遞給 Controller。

我們可以看到DispatcherServlet的核心方法中第一句就是如下的代碼：

try {
    processedRequest = checkMultipart(request);
    multipartRequestParsed = (processedRequest != request);
    ...

注意： MultipartResolver 默認不開啟，需要手動開啟。

文件上傳對前端表單有如下要求：為了能上傳文件，必須將表單的【method設置為POST】，并將enctype設置為【multipart/form-data】。只有在這樣的情況下，瀏覽器才會把用戶選擇的文件以二進制數據發送給服務器。

對表單中的 enctype 屬性的詳細說明：

application/x-www-form-urlencoded：默認方式，只處理表單域中的 value 屬性值，采用這種編碼方式的表單會將表單域中的值處理成 URL 編碼方式。

multipart/form-data：這種編碼方式會以二進制流的方式來處理表單數據，這種編碼方式會把文件域指定文件的內容也封裝到請求參數中，不會對字符編碼。

<form action="" enctype="multipart/form-data" method="post">
   <input type="file" name="file"/>
   <input type="submit">
</form>

一旦設置了enctype為multipart/form-data，瀏覽器即會采用二進制流的方式來處理表單數據，而對于文件上傳的處理則涉及在服務器端解析原始的HTTP響應。

1）導入這個【commons-fileupload】jar包，Maven會自動幫我們導入它的依賴包【commons-io】

<!--文件上傳-->
<dependency>
   <groupId>commons-fileupload</groupId>
   <artifactId>commons-fileupload</artifactId>
   <version>1.3.3</version>
</dependency>

2）配置bean：multipartResolver

注意： 這個bena的id必須為：multipartResolver ， 否則上傳文件會報400的錯誤！

<!--文件上傳配置-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
   <!-- 請求的編碼格式，必須和jSP的pageEncoding屬性一致，以便正確讀取表單的內容，默認為ISO-8859-1 -->
   <property name="defaultEncoding" value="utf-8"/>
   <!-- 上傳文件大小上限，單位為字節（10485760=10M） -->
   <property name="maxUploadSize" value="10485760"/>
   <property name="maxInMemorySize" value="40960"/>
</bean>

CommonsMultipartFile 的常用方法：

String getOriginalFilename()：獲取上傳文件的原名

InputStream getInputStream()：獲取文件流

void transferTo(File dest)：將上傳文件保存到一個目錄文件中

（3）編寫前端頁面

<form action="/upload" enctype="multipart/form-data" method="post">
 <input type="file" name="file"/>
 <input type="submit" value="upload">
</form>

（4）編寫Controller類

package com.wang.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.commons.CommonsMultipartFile;
import javax.servlet.http.HttpServletRequest;
import java.io.*;
@Controller
public class FileController {
    //@RequestParam("file") 將name=file控件得到的文件封裝成CommonsMultipartFile 對象
    //批量上傳CommonsMultipartFile則為數組即可
    @RequestMapping("/upload")
    public String fileUpload(@RequestParam("file") CommonsMultipartFile file , HttpServletRequest request) throws IOException {
        //獲取文件名 : file.getOriginalFilename();
        String uploadFileName = file.getOriginalFilename();
        //如果文件名為空，直接回到首頁！
        if ("".equals(uploadFileName)){
            return "redirect:/index.jsp";
        }
        System.out.println("上傳文件名 : "+uploadFileName);
        //上傳路徑保存設置
        String path = request.getServletContext().getRealPath("/upload");
        //如果路徑不存在，創建一個
        File realPath = new File(path);
        if (!realPath.exists()){
            realPath.mkdir();
        }
        System.out.println("上傳文件保存地址："+realPath);
        InputStream is = file.getInputStream(); //文件輸入流
        OutputStream os = new FileOutputStream(new File(realPath,uploadFileName)); //文件輸出流
        //讀取寫出
        int len=0;
        byte[] buffer = new byte[1024];
        while ((len=is.read(buffer))!=-1){
            os.write(buffer,0,len);
            os.flush();
        }
        os.close();
        is.close();
        return "redirect:/index.jsp";
    }
}

（5）測試上傳文件

（6）采用file.Transto 來保存上傳的文件

編寫Controller類：

/*
 * 采用file.Transto 來保存上傳的文件
 */
@RequestMapping("/upload2")
public String  fileUpload2(@RequestParam("file") CommonsMultipartFile file, HttpServletRequest request) throws IOException {
    //上傳路徑保存設置
    String path = request.getServletContext().getRealPath("/upload");
    File realPath = new File(path);
    if (!realPath.exists()){
        realPath.mkdir();
    }
    //上傳文件地址
    System.out.println("上傳文件保存地址："+realPath);
    //通過CommonsMultipartFile的方法直接寫文件（注意這個時候）
    file.transferTo(new File(realPath +"/"+ file.getOriginalFilename()));
    return "redirect:/index.jsp";
}

小知識： 我們在文件上傳可以考慮以下幾點：

（1）文件的原始信息，或者叫文件的元數據是不是可以存在數據庫，具體應該怎么做？

（2）文件的上傳目錄能不能寫在配置文件當中，這個應該怎么做？

（3）文件上傳到服務器后可不可以安裝一定的規則分目錄存儲，比如日期？

（4）思考怎么使用阿里云的oss進行圖片存儲？

二、文件下載

第一種可以直接向response的輸出流中寫入對應的文件流

第二種可以使用 ResponseEntity<byte[]>來向前端返回文件

1.傳統方式

文件下載步驟：

（1）設置 response 響應頭

（2）讀取文件 &mdash; InputStream

（3）寫出文件 &mdash; OutputStream

（4）執行操作

（5）關閉流 （先開后關）

@GetMapping("/download1")
@ResponseBody
public R download1(HttpServletResponse response){
    FileInputStream fileInputStream = null;
    ServletOutputStream outputStream = null;
    try {
        // 這個文件名是前端傳給你的要下載的圖片的id
        // 然后根據id去數據庫查詢出對應的文件的相關信息，包括url，文件名等
        String  fileName = "wang.jpg";

        //1、設置response 響應頭，處理中文名字亂碼問題
        response.reset(); //設置頁面不緩存,清空buffer
        response.setCharacterEncoding("UTF-8"); //字符編碼
        response.setContentType("multipart/form-data"); //二進制傳輸數據
        //設置響應頭，就是當用戶想把請求所得的內容存為一個文件的時候提供一個默認的文件名。
        //Content-Disposition屬性有兩種類型：inline 和 attachment 
        //inline ：將文件內容直接顯示在頁面 
        //attachment：彈出對話框讓用戶下載具體例子：
        response.setHeader("Content-Disposition",
                           "attachment;fileName="+ URLEncoder.encode(fileName, "UTF-8"));

		// 通過url獲取文件
        File file = new File("D:/upload/"+fileName);
        //2、 讀取文件--輸入流
        fileInputStream = new FileInputStream(file);
        //3、 寫出文件--輸出流
        outputStream = response.getOutputStream();

        byte[] buffer = new byte[1024];
        int len;
        //4、執行寫出操作
        while ((len = fileInputStream.read(buffer)) != -1){
            outputStream.write(buffer,0,len);
            outputStream.flush();
        }

        return R.success();
    } catch (IOException e) {
        e.printStackTrace();
        return R.fail();
    }finally {
        if( fileInputStream != null ){
            try {
                // 5、關閉輸入流
                fileInputStream.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        if( outputStream != null ){
            try {
                // 5、關閉輸出流
                outputStream.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

2.使用ResponseEntity方式

@GetMapping("/download2")
public ResponseEntity<byte[]> download2(){
    try {
        String fileName = "wang.jpg";
        byte[] bytes = FileUtils.readFileToByteArray(new File("D:/upload/"+fileName));
        HttpHeaders headers=new HttpHeaders();
        // Content-Disposition就是當用戶想把請求所得的內容存為一個文件的時候提供一個默認的文件名。
        headers.set("Content-Disposition","attachment;filename="+ URLEncoder.encode(fileName, "UTF-8"));
        headers.set("charsetEncoding","utf-8");
        headers.set("content-type","multipart/form-data");
        ResponseEntity<byte[]> entity=new ResponseEntity<>(bytes,headers, HttpStatus.OK);
        return entity;
    } catch (IOException e) {
        e.printStackTrace();
        return null;
    }
}

關于“SpringMVC文件上傳與下載怎么實現”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。