SpringBoot文件上傳與下載功能實現(xiàn)詳解

更新時間：2022年10月28日 10:32:48 作者：showswoller

文件上傳與下載是Web應用開發(fā)中常用的功能之一。接下來我們將討論如何在Spring?Boot的Web應用開發(fā)中，如何實現(xiàn)文件的上傳與下載，感興趣的可以了解一下

前言

文件上傳與下載是Web應用開發(fā)中常用的功能之一，在實際的Web應用開發(fā)中，為了成功上傳文件，必須將表單的method設置為post，并將enctype設置為multipart/form-data 只有這樣設置，瀏覽器才能將所選文件的二進制數(shù)據(jù)發(fā)送給服務器

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

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

byte[]getBytes() 獲取文件數(shù)據(jù)

String getContentType() 獲取文件MIME類型

InputStream getInputStream() 獲取表單中文件組件的名字

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

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

long getSize() 獲取文件的字節(jié)大小

boolean isEmpty() 是否有選擇上傳文件

void transferTo() 將上傳文件保存到一個目標文件中

Spring Boot的spring-boot-starter-web已經(jīng)集成了Spring MVC 所以使用Spring Boot實現(xiàn)文件上傳更加敏捷，只需引入Apache Commons FileUpload組件依賴即可

下面通過一個實例來加深理解

操作步驟如下

1、引入Apache Commons FileUpload組件依賴

在Web應用的ch5_2的pom.xml文件中添加Apache Commons FileUpload組件依賴代碼如下

<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0">
<modelVersion>4.0.0</modelVersion>
-<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.5.RELEASE</version>
<relativePath/>
<!-- lookup parent from repository -->
</parent>
<groupId>com.ch</groupId>
<artifactId>ch5_2</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>ch5_2</name>
<description>Demo project for Spring Boot</description>
-<properties>
<java.version>11</java.version>
</properties>
-<dependencies>
-<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<!-- 由于commons-fileupload組件不屬于Spring Boot，所以需要加上版本 -->
<version>1.3.3</version>
</dependency>
-<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
-<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
-<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
-<build>
-<plugins>
-<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

2、設置上傳文件大小限制

在Web應用的ch5_2的配置文件application。properties中添加如下配置限制上傳文件大小

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

3、創(chuàng)建選擇文件視圖頁面

在ch5_2應用的src/main/resources/templates目錄下創(chuàng)建選擇文件視圖頁面uploadFile.html 該頁面中有一個enctype屬性值為multipart/form-data的form表單部分代碼如下

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
<link rel="stylesheet" th:href="@{css/bootstrap.min.css}" rel="external nofollow"  />
<!-- 默認訪問 src/main/resources/static下的css文件夾-->
<link rel="stylesheet" th:href="@{css/bootstrap-theme.min.css}" rel="external nofollow"  />
</head>
<body>
<div class="panel panel-primary">
		<div class="panel-heading">
			<h3 class="panel-title">文件上傳示例</h3>
		</div>
	</div>
	<div class="container">
		<div class="row">
			<div class="col-md-6 col-sm-6">
				<form class="form-horizontal" action="upload" method="post" enctype="multipart/form-data">
					<div class="form-group">
						<div class="input-group col-md-6">
							<span class="input-group-addon">
								<i class="glyphicon glyphicon-pencil"></i>
							</span>
							<input class="form-control" type="text"
							 name="description" th:placeholder="文件描述"/>
				</form>
			</div>
		</div>
	</div>
</body>
</html>

4、創(chuàng)建控制器

在ch5_2應用的com.ch.ch5_2.controller包中創(chuàng)建控制器類TestFileUpload 在該類中有4個處理方法一個是界面導航方法，uploadfile 一個是實現(xiàn)文件上傳的upload方法，一個是顯示將要被下載文件的showDownLoad 方法，一個是實現(xiàn)下載功能的download方法部分代碼如下

package com.ch.ch5_2.controller;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.io.FileUtils;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.ResponseEntity.BodyBuilder;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;
@Controller
public class TestFileUpload {
	/**
	 * 進入文件選擇頁面
	 */
	@RequestMapping("/uploadFile")
	public String uploadFile() {
		return "uploadFile";
	}
	/**
	 * 上傳文件自動綁定到MultipartFile對象中，
	 * 在這里使用處理方法的形參接收請求參數(shù)。
	 * @throws IOException 
	 * @throws IllegalStateException 
	 */
	@RequestMapping("/upload")
	public String upload(
			HttpServletRequest request,
			@RequestParam("description") String description,
			@RequestParam("myfile") MultipartFile myfile) throws IllegalStateException, IOException {
		System.out.println("文件描述：" + description);
		//如果選擇了上傳文件，將文件上傳到指定的目錄uploadFiles
		if(!myfile.isEmpty()) {
			//上傳文件路徑
			String path = request.getServletContext().getRealPath("/uploadFiles/");
			//獲得上傳文件原名
			String fileName = myfile.getOriginalFilename();
	}
	/**
	 * 實現(xiàn)下載功能
	 * @throws IOException 
	 */
	@RequestMapping("/download")
	public ResponseEntity<byte[]> download(
			HttpServletRequest request, 
			@RequestParam("filename") String filename,
			@RequestHeader("User-Agent") String userAgent) throws IOException {
		//下載文件路徑
		String path = request.getServletContext().getRealPath("/uploadFiles/");
		//構(gòu)建將要下載的文件對象
		File downFile = new File(path + File.separator + filename);
		//ok表示HTTP中的狀態(tài)是200
		BodyBuilder builder =  ResponseEntity.ok();
		//內(nèi)容長度
		builder.contentLength(downFile.length());
		//application/octet-stream：二進制流數(shù)據(jù)（最常見的文件下載）
		builder.contentType(MediaType.APPLICATION_OCTET_STREAM);
		//使用URLEncoder.encode對文件名進行編碼
		filename = URLEncoder.encode(filename,"UTF-8");
		/**
		 * 設置實際的響應文件名，告訴瀏覽器文件要用于“下載”和“保存”。
		 * 不同的瀏覽器，處理方式不同，根據(jù)瀏覽器的實際情況區(qū)別對待。
		 */
		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);
		}
		return builder.body(FileUtils.readFileToByteArray(downFile));
	}
}

5、創(chuàng)建文件下載視圖頁面

創(chuàng)建視圖頁面showFile.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Insert t
				</div>
			</div>
		</div>
	</div>
</body>
</html>