SpringMVC使用ResponseEntity實(shí)現(xiàn)文件上傳下載

更新時(shí)間：2022年05月28日 11:45:28 作者：把蘋(píng)果咬哭的測(cè)試筆記

這篇文章主要為大家介紹了SpringMVC使用ResponseEntity實(shí)現(xiàn)文件上傳下載，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

使用 ResponseEntity 實(shí)現(xiàn)文件上傳和下載

在 static 下新建一個(gè) img ，并且我放了一張圖片在里面，然后重新 maven 打包一下。

下載

新建一個(gè)頁(yè)面file.html，并且配置視圖控制器，以便跳轉(zhuǎn)：

<mvc:view-controller path="/file" view-name="file"></mvc:view-controller>

編寫(xiě)頁(yè)面內(nèi)容，用來(lái)下載我上面存放到 img 中的圖片：

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>測(cè)試文件上傳和下載</title>
</head>
<body>
<a th:href="@{/testDown}" rel="external nofollow" >下載靜態(tài)圖片</a>
</body>
</html>

后端編寫(xiě)對(duì)應(yīng)處理請(qǐng)求的控制，新建一個(gè)類(lèi) FileUpAndDownController，在下面編寫(xiě)控制器方法:

@Controller
public class FileUpAndDownController {
    @RequestMapping("/testDown")
    public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
        //獲取ServletContext對(duì)象
        ServletContext servletContext = session.getServletContext();
        //獲取服務(wù)器中文件的真實(shí)路徑
        String realPath = servletContext.getRealPath("/static/img/ACC3.jpg");
        //創(chuàng)建輸入流
        InputStream is = new FileInputStream(realPath);
        //創(chuàng)建字節(jié)數(shù)組，is.available()是當(dāng)前流的所有字節(jié)數(shù)
        byte[] bytes = new byte[is.available()];
        //將流讀到字節(jié)數(shù)組中
        is.read(bytes);
        //創(chuàng)建HttpHeaders對(duì)象設(shè)置響應(yīng)頭信息
        MultiValueMap<String, String> headers = new HttpHeaders();
        //設(shè)置要下載方式以及下載文件的名字
        headers.add("Content-Disposition", "attachment;filename=ACC3.jpg");
        //設(shè)置響應(yīng)狀態(tài)碼
        HttpStatus statusCode = HttpStatus.OK;
        //創(chuàng)建ResponseEntity對(duì)象
        ResponseEntity<byte[]> responseEntity = new ResponseEntity<byte[]>(bytes, headers, statusCode);
        //關(guān)閉輸入流
        is.close();
        return responseEntity;
    }
}

文件不管是上傳還是下載，本質(zhì)還是一個(gè)復(fù)制的過(guò)程。

既然要復(fù)制，那還是要先讀后寫(xiě)，所以上面創(chuàng)建了輸入流，將流讀到字節(jié)數(shù)組中，然后把這個(gè)字節(jié)數(shù)組響應(yīng)到瀏覽器，這就是要下載的文件了。

所以，用到了 ResponseEntity，要把響應(yīng)到瀏覽器的數(shù)據(jù)轉(zhuǎn)化成 ResponseEntity，最后返回。

重新部署測(cè)試一下，訪問(wèn) file 頁(yè)面，點(diǎn)擊下載超鏈接。

下載成功。

上傳

在前端頁(yè)面 file.html 中繼續(xù)添加內(nèi)容：

<form th:action="@{/testUp}" method="post" enctype="multipart/form-data">
    頭像：<input type="file" name="photo"><br>
    <input type="submit" value="上傳">
</form>

文件上傳要求 form 表單的請(qǐng)求方式必須為 post，并且添加屬性 enctype="multipart/form-data"。

添加依賴：

<!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
    <dependency>
        <groupId>commons-fileupload</groupId>
        <artifactId>commons-fileupload</artifactId>
        <version>1.3.1</version>
    </dependency>

SpringMVC 中將上傳的文件封裝到MultipartFile對(duì)象中，通過(guò)此對(duì)象可以獲取文件相關(guān)信息。

在 springMVC 的配置文件中添加配置:

<!--必須通過(guò)文件解析器的解析才能將文件轉(zhuǎn)換為MultipartFile對(duì)象-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"></bean>

增加控制器方法，實(shí)現(xiàn)上傳：

@RequestMapping("/testUp")
    public String testUp(MultipartFile photo, HttpSession session) throws IOException {
        //獲取上傳的文件的文件名
        String fileName = photo.getOriginalFilename();
        //處理文件重名問(wèn)題
        String hzName = fileName.substring(fileName.lastIndexOf("."));
        fileName = UUID.randomUUID().toString() + hzName;
        //獲取服務(wù)器中 photo目錄的路徑
        ServletContext servletContext = session.getServletContext();
        String photoPath = servletContext.getRealPath("photo");
        File file = new File(photoPath);
        if(!file.exists()){
            file.mkdir(); // 不存在則創(chuàng)建目錄
        }
        String finalPath = photoPath + File.separator + fileName;
        //實(shí)現(xiàn)上傳功能
        photo.transferTo(new File(finalPath));
        return "success";
    }

注意，我們最終上傳的位置是在這里，會(huì)自動(dòng)創(chuàng)建一個(gè) photo 目錄，里面存放著上傳的圖片。