書圈 - 全棧開發實戰｜Spring Boot文件上傳與下載－鑽石舞台

May 20 Fri 2022 19:00
書圈 - 全棧開發實戰｜Spring Boot文件上傳與下載

文件上傳與下載是Web應用開發中常用的功能之一。本節將講解如何在Spring Boot的Web應用開發中，如何實現文件的上傳與下載。

Spring Boot文件上傳與下載

在實際的Web應用開發中，為了成功上傳文件，必須將表單的method設置為post，並將enctype設置為multipart/form-data。只有這種設置，瀏覽器才能將所選文件的二進制數據發送給服務器。

從Servlet 3.0開始，就提供了處理文件上傳的方法，但這種文件上傳需要在Java Servlet中完成，而Spring MVC提供了更簡單的封裝。Spring MVC是通過Apache Commons FileUpload技術實現一個MultipartResolver的實現類CommonsMultipartResolver完成文件上傳的。因此，Spring MVC的文件上傳需要依賴Apache Commons FileUpload組件。

Spring MVC將上傳文件自動綁定到MultipartFile對象中，MultipartFile提供了獲取上傳文件內容、文件名等方法，並通過transferTo方法將文件上傳到服務器的磁盤中，MultipartFile的常用方法如下：

●byte[] getBytes()：獲取文件數據。

● String getContentType()：獲取文件MIME類型，如image/jpeg等。

● InputStream getInputStream()：獲取文件流。

● String getName()：獲取表單中文件組件的名字。

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

● long getSize()：獲取文件的字節大小，單位為byte。

● boolean isEmpty()：是否有（選擇）上傳文件。

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

Spring Boot的spring-boot-starter-web已經集成了Spring MVC，所以使用Spring Boot實現文件上傳，更加便捷，只需要引入Apache Commons FileUpload組件依賴即可。

下面通過一個實例講解Spring Boot文件上傳與下載的實現過程。

【例7-7】Spring Boot文件上傳與下載。

具體實現步驟如下。

●

引入Apache Commons FileUpload

組件依賴

在Web應用ch7_2的pom.xml文件中，添加Apache Commons FileUpload組件依賴，具體代碼如下：

<dependency><groupId>commons-fileupload</groupId><artifactId>commons-fileupload</artifactId><version>1.4</version></dependency>

●

設置上傳文件大小限制

在Web應用ch7_2的配置文件application.properties中，添加如下配置進行限制上傳文件大小。

#上傳文件時，默認單個上傳文件大小是1MB，max-file-size設置單個上傳文件大小spring.servlet.multipart.max-file-size=50MB#默認總文件大小是10MB，max-request-size設置總上傳文件大小spring.servlet.multipart.max-request-size=500MB

●

創建選擇文件視圖頁面

在ch7_2應用的src/main/resources/templates目錄下，創建選擇文件視圖頁面uploadFile.html。該頁面中有個enctype屬性值為multipart/form-data的form表單，具體代碼如下：

<!DOCTYPE html><htmlxmlns:th="http://www.thymeleaf.org"><head><metacharset="UTF-8"><title>Insert title here</title><linkrel="stylesheet"th:href="@{css/bootstrap.min.css}"/><linkrel="stylesheet"th:href="@{css/bootstrap-theme.min.css}"/></head><body><divclass="panel panel-primary"><divclass="panel-heading"><h3class="panel-title">文件上傳示例</h3></div></div><divclass="container"><divclass="row"><divclass="col-md-6 col-sm-6"><formclass="form-horizontal"action="upload"method="post"enctype="multipart/form-data"><divclass="form-group"><divclass="input-group col-md-6"><spanclass="input-group-addon"><iclass="glyphicon glyphicon-pencil"></i></span><inputclass="form-control"type="text"name="description"th:placeholder="文件描述"/></div></div><divclass="form-group"><divclass="input-group col-md-6"><spanclass="input-group-addon"><iclass="glyphicon glyphicon-search"></i></span><inputclass="form-control"type="file"name="myfile"th:placeholder="請選擇文件"/></div></div><divclass="form-group"><divclass="col-md-6"><divclass="btn-group btn-group-justified"><divclass="btn-group"><buttontype="submit"class="btn btn-success"><spanclass="glyphicon glyphicon-share"></span> 上傳文件</button></div></div></div></div></form></div></div></div></body></html>

●

創建控制器

在ch7_2應用的com.ch.ch7_2.controller包中，創建控制器類TestFileUpload。在該類中有4個處理方法，一個是界面導航方法uploadFile，一個是實現文件上傳的upload方法，一個是顯示將要被下載文件的showDownLoad方法，一個是實現下載功能的download方法。核心代碼如下：

@ControllerpublicclassTestFileUpload {@RequestMapping("/uploadFile")publicStringuploadFile() {return"uploadFile";}/*** 上傳文件自動綁定到MultipartFile對象中，* 在這裡使用處理方法的形參接收請求參數。*/@RequestMapping("/upload")publicStringupload(HttpServletRequest request,@RequestParam("description") Stringdescription,@RequestParam("myfile") MultipartFile myfile) throws IllegalStateException, IOException {System.out.println("文件描述："+ description);//如果選擇了上傳文件，將文件上傳到指定的目錄uploadFilesif(!myfile.isEmpty()) {//上傳文件路徑Stringpath = request.getServletContext().getRealPath("/uploadFiles/");//獲得上傳文件原名StringfileName = myfile.getOriginalFilename();File filePath = newFile(path + File.separator + fileName);//如果文件目錄不存在，創建目錄if(!filePath.getParentFile().exists()) {filePath.getParentFile().mkdirs();}//將上傳文件保存到一個目標文件中myfile.transferTo(filePath);}//轉發到一個請求處理方法，查詢將要下載的文件return"forward:/showDownLoad";}/*** 顯示要下載的文件*/@RequestMapping("/showDownLoad")publicStringshowDownLoad(HttpServletRequest request, Model model) {Stringpath = request.getServletContext().getRealPath("/uploadFiles/");File fileDir = newFile(path);//從指定目錄獲得文件列表File filesList[] = fileDir.listFiles();model.addAttribute("filesList", filesList);return"showFile";}/*** 實現下載功能*/@RequestMapping("/download")publicResponseEntity<byte[]> download(HttpServletRequest request, @RequestParam("filename") Stringfilename,@RequestHeader("User-Agent") StringuserAgent) throws IOException {//下載文件路徑Stringpath = request.getServletContext().getRealPath("/uploadFiles/");//構建將要下載的文件對象File downFile = newFile(path + File.separator + filename);//ok表示HTTP中的狀態是200BodyBuilder builder = ResponseEntity.ok();//內容長度builder.contentLength(downFile.length());//application/octet-stream：二進制流數據（最常見的文件下載）builder.contentType(MediaType.APPLICATION_OCTET_STREAM);//使用URLEncoder.encode對文件名進行編碼filename = URLEncoder.encode(filename,"UTF-8");/*** 設置實際的響應文件名，告訴瀏覽器文件要用於「下載」和「保存」。* 不同的瀏覽器，處理方式不同，根據瀏覽器的實際情況區別對待。*/if(userAgent.indexOf("MSIE") > 0) {//IE瀏覽器，只需要用UTF-8字符集進行URL編碼builder.header("Content-Disposition", "attachment; filename="+ filename);}else{/**非IE瀏覽器，如FireFox、Chrome等瀏覽器，則需要說明編碼的字符集* filename後面有個*號，在UTF-8後面有兩個單引號*/builder.header("Content-Disposition", "attachment; filename*=UTF-8''"+ filename);}returnbuilder.body(FileUtils.readFileToByteArray(downFile));}}

●

創建文件下載視圖頁面

在ch7_2應用的src/main/resources/templates目錄下，創建文件下載視圖頁面showFile.html。核心代碼如下：

<body><divclass="panel panel-primary"><divclass="panel-heading"><h3class="panel-title">文件下載示例</h3></div></div><divclass="container"><divclass="panel panel-primary"><divclass="panel-heading"><h3class="panel-title">文件列表</h3></div><divclass="panel-body"><divclass="table table-responsive"><tableclass="table table-bordered table-hover"><tbodyclass="text-center"><trth:each="file,fileStat:${filesList}"><td><spanth:text="${fileStat.count}"></span></td><td><ath:href="@{download(filename=${file.name})}"><spanth:text="${file.name}"></span></a></td></tr></tbody></table></div></div></div></div></body>

●

運行

首先，運行Ch72Application主類。然後，訪問http://localhost:8080/ch7_2/uploadFile測試文件上傳與下載。

SSM + Spring Boot + Vue.js 3

全棧開發從入門到實戰