SpringMVC 文件上传与下载：一场关于字节的旅行
各位看官，大家好！今天咱们来聊聊SpringMVC中“搬运”文件的那点事儿，也就是文件上传和下载。这就像咱们在网络世界里搞快递，把文件从你的电脑“嗖”的一下送到服务器，或者反过来，把服务器上的宝贝文件“嗖”的一下拿到手。
别看这事儿听起来简单，里面的门道可不少。稍不留神，你就可能遇到各种奇葩问题，比如文件太大传不上去，下载下来发现文件损坏了，甚至更可怕的，被黑客利用漏洞搞事情。所以，咱们今天就要把这个“快递业务”彻底搞明白，争取做到安全、高效、稳定。
一、文件上传：把宝贝送上云端
文件上传，顾名思义，就是把客户端（比如你的浏览器）的文件送到服务器。在SpringMVC中，这事儿主要靠MultipartResolver接口和@RequestParam注解来完成。
1.1 配置MultipartResolver：让SpringMVC认识文件
首先，我们要告诉SpringMVC，我们要做文件上传了，让它做好准备。这就要配置MultipartResolver。它就像一个“文件翻译官”，能把HTTP请求中的文件部分解析出来，方便我们处理。
有两种常用的MultipartResolver实现：
-
CommonsMultipartResolver： 基于 Apache Commons FileUpload 组件。这是经典选择，需要引入
commons-fileupload和commons-io依赖。<!-- Spring MVC配置文件 --> <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"> <!-- 设置上传文件的最大尺寸，单位：字节 --> <property name="maxUploadSize" value="10485760"/> <!-- 10MB --> <!-- 设置请求的最大尺寸，包括上传的文件和其他参数 --> <property name="maxInMemorySize" value="4096"/> <!-- 4KB --> <!-- 设置编码格式 --> <property name="defaultEncoding" value="UTF-8"/> </bean>// Maven依赖 <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.5</version> </dependency> <dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> <version>2.15.1</version> </dependency> -
StandardServletMultipartResolver： 基于 Servlet 3.0 的 multipart 功能。不需要额外的依赖，但要求你的Servlet容器支持Servlet 3.0及以上。
<!-- Spring MVC配置文件 --> <bean id="multipartResolver" class="org.springframework.web.multipart.support.StandardServletMultipartResolver"/>注意： 使用
StandardServletMultipartResolver需要在web.xml(或等价的配置)中启用 multipart 支持。<!-- web.xml --> <servlet> <servlet-name>dispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/spring-mvc.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> <multipart-config> <max-file-size>10485760</max-file-size> <!-- 10MB --> <max-request-size>10485760</max-request-size> <!-- 10MB --> <file-size-threshold>0</file-size-threshold> </multipart-config> </servlet>
1.2 编写Controller：接收文件并保存
配置好MultipartResolver后，就可以在Controller里接收文件了。
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
@Controller
public class FileUploadController {
@PostMapping("/upload")
public String uploadFile(@RequestParam("file") MultipartFile file) {
if (!file.isEmpty()) {
try {
// 获取文件名
String fileName = file.getOriginalFilename();
// 定义文件保存路径
String filePath = "/path/to/your/upload/directory/"; // 替换为你的实际路径
// 创建File对象
File dest = new File(filePath + fileName);
// 保存文件
file.transferTo(dest);
return "uploadSuccess"; // 上传成功页面
} catch (IOException e) {
e.printStackTrace();
return "uploadFailure"; // 上传失败页面
}
} else {
return "uploadFailure"; // 文件为空
}
}
}代码解释：
@RequestParam("file") MultipartFile file：@RequestParam注解用于接收名为"file"的文件，MultipartFile是Spring提供的文件对象，包含了文件的各种信息和操作方法。file.getOriginalFilename()：获取文件的原始名称。file.transferTo(dest)：将文件保存到指定路径。
1.3 前端页面：选择文件并提交
最后，我们需要一个前端页面来让用户选择文件并提交。
<!DOCTYPE html>
<html>
<head>
<title>文件上传</title>
</head>
<body>
<form action="/upload" method="post" enctype="multipart/form-data">
选择文件：<input type="file" name="file"><br><br>
<input type="submit" value="上传">
</form>
</body>
</html>注意：
enctype="multipart/form-data"：这是必须的，告诉浏览器以multipart格式提交数据，这样才能包含文件。name="file"：这个name属性要和Controller中@RequestParam注解指定的名称一致。
二、文件下载：把宝贝取回来
文件下载，就是把服务器上的文件发送给客户端。SpringMVC中，主要通过设置HTTP响应头来实现。
2.1 编写Controller：设置响应头并输出文件流
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
@Controller
public class FileDownloadController {
@GetMapping("/download")
public void downloadFile(HttpServletResponse response) {
// 文件路径
String filePath = "/path/to/your/download/file/example.pdf"; // 替换为你的实际路径
File file = new File(filePath);
if (file.exists()) {
// 设置响应头
response.setContentType("application/octet-stream"); // 通用下载类型
response.setContentLength((int) file.length());
response.setHeader("Content-Disposition", "attachment; filename="example.pdf""); // 指定文件名
// 读取文件并写入响应
try (FileInputStream fis = new FileInputStream(file);
BufferedInputStream bis = new BufferedInputStream(fis);
OutputStream os = response.getOutputStream()) {
byte[] buffer = new byte[1024];
int len;
while ((len = bis.read(buffer)) != -1) {
os.write(buffer, 0, len);
}
os.flush(); // 确保所有数据都已发送
} catch (IOException e) {
e.printStackTrace();
// 处理异常，比如记录日志
}
} else {
// 文件不存在，返回错误信息
try {
response.sendError(HttpServletResponse.SC_NOT_FOUND, "File not found");
} catch (IOException e) {
e.printStackTrace();
}
}
}
}代码解释：
response.setContentType("application/octet-stream")：设置响应的Content-Type为application/octet-stream，这是一个通用的下载类型，告诉浏览器这是一个二进制文件，需要下载。response.setContentLength((int) file.length())：设置响应的Content-Length，告诉浏览器文件的大小，方便浏览器显示下载进度。response.setHeader("Content-Disposition", "attachment; filename="example.pdf"")：设置响应的Content-Disposition，告诉浏览器这是一个附件，需要下载，并指定文件名。filename的值就是下载时显示的文件名。FileInputStream、BufferedInputStream、OutputStream：使用IO流读取文件并写入响应，将文件内容发送给客户端。
2.2 前端页面：发起下载请求
<!DOCTYPE html>
<html>
<head>
<title>文件下载</title>
</head>
<body>
<a href="/download">下载文件</a>
</body>
</html>点击链接，浏览器就会发起一个GET请求到/download，服务器就会返回文件，浏览器就会自动下载。
三、文件上传与下载的优化：让“快递”更快更稳
文件上传和下载的功能实现了，但我们还可以做得更好，让“快递”更快更稳。
3.1 大文件上传优化：分片上传
如果文件太大，一次性上传可能会失败，或者非常慢。这时，我们可以采用分片上传的策略。
原理：
将大文件分割成多个小块（chunk），逐个上传，服务器接收到所有分片后，再将它们合并成完整的文件。
优点：
- 断点续传： 如果上传过程中断了，可以从上次上传的分片继续上传，避免重新上传整个文件。
- 提高上传速度： 并行上传多个分片，可以提高上传速度。
- 降低服务器压力： 每次上传的数据量较小，可以降低服务器压力。
实现思路：
- 前端： 将文件分割成多个分片，计算每个分片的MD5值（用于校验），然后逐个上传。
- 后端： 接收每个分片，保存到临时目录，记录已上传的分片信息。当所有分片都上传完成后，合并分片，验证MD5值，保存完整的文件。
示例代码（简化版）：
-
前端（JavaScript）：
// 选择文件后触发 document.getElementById('fileInput').addEventListener('change', function(event) { const file = event.target.files[0]; const chunkSize = 1024 * 1024; // 1MB const chunkCount = Math.ceil(file.size / chunkSize); for (let i = 0; i < chunkCount; i++) { const start = i * chunkSize; const end = Math.min(file.size, start + chunkSize); const chunk = file.slice(start, end); uploadChunk(chunk, i, chunkCount, file.name); } }); function uploadChunk(chunk, chunkIndex, chunkCount, fileName) { const formData = new FormData(); formData.append('file', chunk, fileName + '_' + chunkIndex); // 文件名包含分片序号 formData.append('chunkIndex', chunkIndex); formData.append('chunkCount', chunkCount); formData.append('fileName', fileName); fetch('/uploadChunk', { method: 'POST', body: formData }).then(response => { // 处理响应 }); } -
后端（Java）：
@PostMapping("/uploadChunk") public String uploadChunk(@RequestParam("file") MultipartFile file, @RequestParam("chunkIndex") int chunkIndex, @RequestParam("chunkCount") int chunkCount, @RequestParam("fileName") String fileName) { // 保存分片到临时目录 String chunkFilePath = "/path/to/your/temp/directory/" + fileName + "_" + chunkIndex; try { file.transferTo(new File(chunkFilePath)); // 检查是否所有分片都已上传 if (isAllChunksUploaded(fileName, chunkCount)) { // 合并分片 mergeChunks(fileName, chunkCount); } return "chunkUploadSuccess"; } catch (IOException e) { e.printStackTrace(); return "chunkUploadFailure"; } } // 简单实现，实际需要更健壮的逻辑 private boolean isAllChunksUploaded(String fileName, int chunkCount) { for (int i = 0; i < chunkCount; i++) { File chunkFile = new File("/path/to/your/temp/directory/" + fileName + "_" + i); if (!chunkFile.exists()) { return false; } } return true; } private void mergeChunks(String fileName, int chunkCount) throws IOException { String mergedFilePath = "/path/to/your/upload/directory/" + fileName; try (FileOutputStream fos = new FileOutputStream(mergedFilePath)) { for (int i = 0; i < chunkCount; i++) { String chunkFilePath = "/path/to/your/temp/directory/" + fileName + "_" + i; File chunkFile = new File(chunkFilePath); try (FileInputStream fis = new FileInputStream(chunkFile); BufferedInputStream bis = new BufferedInputStream(fis)) { byte[] buffer = new byte[1024]; int len; while ((len = bis.read(buffer)) != -1) { fos.write(buffer, 0, len); } } // 删除临时分片文件 chunkFile.delete(); } } }
3.2 文件下载优化：使用Range请求头
对于大文件下载，如果用户只需要下载文件的一部分，可以利用HTTP的Range请求头实现断点续传和分片下载。
原理：
客户端在请求头中指定需要下载的字节范围，服务器只返回指定范围的数据。
实现思路：
- 客户端： 在请求头中添加
Range字段，指定需要下载的字节范围，例如Range: bytes=0-1023表示下载前1024个字节。 - 服务器： 解析
Range请求头，读取指定范围的文件内容，设置响应头Content-Range和Content-Length，返回部分数据。
示例代码：
@GetMapping("/downloadRange")
public void downloadRangeFile(HttpServletRequest request, HttpServletResponse response) {
String filePath = "/path/to/your/download/file/example.pdf";
File file = new File(filePath);
if (file.exists()) {
long fileSize = file.length();
String rangeHeader = request.getHeader("Range");
if (rangeHeader != null && rangeHeader.startsWith("bytes=")) {
try {
String[] ranges = rangeHeader.substring(6).split("-");
long start = Long.parseLong(ranges[0]);
long end = (ranges.length > 1) ? Long.parseLong(ranges[1]) : fileSize - 1;
if (start > end || end >= fileSize) {
response.setStatus(HttpServletResponse.SC_REQUESTED_RANGE_NOT_SATISFIABLE);
return;
}
long contentLength = end - start + 1;
response.setStatus(HttpServletResponse.SC_PARTIAL_CONTENT);
response.setContentType("application/octet-stream");
response.setContentLength((int) contentLength);
response.setHeader("Content-Range", "bytes " + start + "-" + end + "/" + fileSize);
response.setHeader("Content-Disposition", "attachment; filename="example.pdf"");
try (RandomAccessFile raf = new RandomAccessFile(file, "r");
OutputStream os = response.getOutputStream()) {
raf.seek(start);
byte[] buffer = new byte[1024];
long bytesRead = 0;
while (bytesRead < contentLength) {
int len = raf.read(buffer, 0, (int) Math.min(contentLength - bytesRead, buffer.length));
if (len == -1) {
break;
}
os.write(buffer, 0, len);
bytesRead += len;
}
os.flush();
} catch (IOException e) {
e.printStackTrace();
}
} catch (NumberFormatException e) {
response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
}
} else {
// 没有Range头，返回整个文件
downloadFile(response); // 调用上面的downloadFile方法
}
} else {
try {
response.sendError(HttpServletResponse.SC_NOT_FOUND, "File not found");
} catch (IOException e) {
e.printStackTrace();
}
}
}3.3 安全性优化：防止恶意文件上传
文件上传是一个潜在的安全风险，恶意用户可能会上传病毒、木马等恶意文件，甚至利用漏洞攻击服务器。
安全措施：
- 文件类型验证： 严格验证上传文件的类型，只允许上传指定类型的文件，例如图片、文档等。不要仅仅依赖文件的扩展名，而要检查文件的内容。
- 文件大小限制： 限制上传文件的大小，防止恶意用户上传超大文件，导致服务器资源耗尽。
- 文件名过滤： 过滤文件名中的特殊字符，防止恶意用户利用文件名进行攻击。
- 文件存储权限控制： 设置文件存储目录的权限，只允许特定用户访问，防止未经授权的访问。
- 病毒扫描： 对上传的文件进行病毒扫描，确保文件安全。
- 内容安全扫描： 对上传的文件进行内容安全扫描，防止上传包含敏感信息的文件。
3.4 异步处理：提升用户体验
文件上传和下载可能会比较耗时，如果同步处理，会导致用户界面卡顿，影响用户体验。
优化方案：
使用异步处理，将文件上传和下载的任务交给后台线程执行，避免阻塞主线程。
实现方式：
- Spring的
@Async注解： 使用@Async注解标记方法，Spring会自动将方法交给线程池执行。 - 消息队列： 将文件上传和下载的任务发送到消息队列，由消费者异步处理。
四、总结：文件上传与下载的艺术
文件上传和下载是Web开发中常见的需求，但要做好却不容易。我们需要考虑性能、安全、稳定性等多个方面。
通过合理配置MultipartResolver、编写Controller、优化上传和下载流程，我们可以构建一个安全、高效、稳定的文件上传和下载系统，让我们的“快递业务”更加顺畅。
希望这篇文章能帮助你更好地理解SpringMVC中文件上传和下载的实现与优化。记住，代码只是工具，理解背后的原理才是关键。祝你编码愉快！