Spring MVC 中的文件上传 和 文件下载
1. Spring MVC 中的文件上传
文件上传是:浏览器端向服务器发送文件,最终服务器将文件保存到服务器上
文件上传需要添加如下依赖,注意:使用 Spring MVC 6版本,不需要添加以下依赖:
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.5</version>
</dependency>
前端页面:
注意:
文件上传必须是 post 请求,因为文件是大数据。get 请求不够
文件上传的form标签中必须使用 enctype=“multipart/form-data”
enctype是用来设置请求头的内容类型的,默认值是: enctype=“application/x-www-form-urlencoded”
文件上传的组件是: 文件上传:<input type="file" name="fileName">
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>文件上传与下载</title>
</head>
<body>
<h1>文件上传下载</h1>
<hr>
<h2>测试</h2>
<!--文件上传,大文件,一定要用 post 请求才行-->
<!--文件上传表单-->
<form th:action="@{/fileup}" method="post" enctype="multipart/form-data">
文件:<input type="file" name="fileName"/><br>
<input type="submit" value="上传">
</form>
<br>
</body>
</html>
重点是:form表单采用post请求,enctype是multipart/form-data,并且上传组件是:type=“file”
web.xml文件:
注意:如果你用的是:Spring6 ,那么需要在web.xml 文件的 DispatcherServlet中进入如下的配置:
<multipart-config>
<!--设置单个支持最大文件的大小-->
<max-file-size>102400</max-file-size>
<!--设置整个表单所有文件上传的最大值-->
<max-request-size>102400</max-request-size>
<!--设置最小上传文件大小-->
<file-size-threshold>0</file-size-threshold>
</multipart-config>
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
version="5.0">
<!-- 字符编码过滤器-->
<filter>
<filter-name>CharacterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceRequestEncoding</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>forceResponseEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- 前端控制器-->
<servlet>
<servlet-name>DispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
<multipart-config>
<!--设置单个支持最大文件的大小-->
<max-file-size>10240000</max-file-size>
<!--设置整个表单所有文件上传的最大值-->
<max-request-size>10240000</max-request-size>
<!--设置最小上传文件大小-->
<file-size-threshold>0</file-size-threshold>
</multipart-config>
</servlet>
<servlet-mapping>
<servlet-name>DispatcherServlet</servlet-name>
<!-- 除了 jsp 页面其他的都走这个-->
<url-pattern>/</url-pattern>
</servlet-mapping>
<!-- 添加一个过滤器,这个过滤器是springmvc提前写好的,直接用就行了,这个过滤器可以帮助你将请求
POST转换成PUT请求/DELETE请求-->
<!-- 同时注意:该过滤器一定要在字符编码过滤器后面配置,不然,先设置的话,可能会出现获取到的请求数据是乱码-->
<filter>
<filter-name>HiddenHttpMethodFilter</filter-name>
<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>HiddenHttpMethodFilter</filter-name>
<!-- 表示任意的 请求-->
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
重点:在DispatcherServlet配置时,添加 multipart-config 配置信息。(这是Spring6,如果是Spring5,则不是这样配置,而是在springmvc.xml文件中配置:CommonsMultipartResolver)
SpringMVC6中把这个类已经删除了。废弃了。
文件上传的 Controller 代码编写:
package com.rainbowsea.springmvc.controller;
import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpRequest;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;
import javax.lang.model.element.VariableElement;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.util.UUID;
@Controller
public class FileController {
@RequestMapping(value = "/fileup",method = RequestMethod.POST)
public String fileup(@RequestParam("fileName")MultipartFile multipartFile, HttpServletRequest request) throws Exception {
// 获取请求参数的名字
String name = multipartFile.getName();
System.out.println(name); // fileName (前端 文件上传: <input type="file" name="fileName"><br> )
// 获取的是文件真实的名字
String originalFilename = multipartFile.getOriginalFilename();
System.out.println(originalFilename); // xiaomu
// 接下来就是看在 Java SE 当中的IO 功底了
// 一边读,一边写
//读什么?写什么
// 读客户端传过来的文件,写倒服务器上
// 输入流
InputStream in = multipartFile.getInputStream(); // 输入流,负责读客户端的文件
BufferedInputStream bis = new BufferedInputStream(in); // 封装成带有缓冲区的输入流
// 输出流
//BufferedOutputStream 文件的路径 = new BufferedOutputStream((new FileOutputStream("文件的路径")));
ServletContext application = request.getServletContext();
String realPath = application.getRealPath("/upload");
File file = new File(realPath);
// 文件不存在,就创建,存在不创建
if(!file.exists()) {
file.mkdirs();
}
File destFile = new File(file.getAbsoluteFile() + "/" + originalFilename);
//BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(new FileOutputStream(destFile));
// 可以采用UUID来生成文件名,防止服务器上传文件时产生覆盖
BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(new FileOutputStream(file.getAbsolutePath() + "/" + UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."))));
// 一边读一边写
byte[] bytes = new byte[1024 * 10];
int readCount = 0;
while ((readCount = bis.read(bytes))!=-1) {
bufferedOutputStream.write(bytes,0,readCount);
}
bufferedOutputStream.flush();
bufferedOutputStream.close();
bis.close();
return "ok";
}
//@RequestMapping(value = "/fileup", method = RequestMethod.POST)
/* public String fileUp(@RequestParam("fileName") MultipartFile multipartFile, HttpServletRequest request) throws IOException {
String name = multipartFile.getName();
System.out.println(name);
// 获取文件名
String originalFilename = multipartFile.getOriginalFilename();
System.out.println(originalFilename);
// 将文件存储到服务器中
// 获取输入流
InputStream in = multipartFile.getInputStream();
// 获取上传之后的存放目录
File file = new File(request.getServletContext().getRealPath("/upload"));
// 如果服务器目录不存在则新建
if(!file.exists()){
file.mkdirs();
}
// 开始写
//BufferedOutputStream out = new BufferedOutputStream(new FileOutputStream(file.getAbsolutePath() + "/" + originalFilename));
// 可以采用UUID来生成文件名,防止服务器上传文件时产生覆盖
BufferedOutputStream out = new BufferedOutputStream(new FileOutputStream(file.getAbsolutePath() + "/" + UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."))));
byte[] bytes = new byte[1024 * 100];
int readCount = 0;
while((readCount = in.read(bytes)) != -1){
out.write(bytes,0,readCount);
}
// 刷新缓冲流
out.flush();
// 关闭流
in.close();
out.close();
return "ok";
}*/
}
最终测试结果:
注意: 上传文件时,文件起名采用UUID。以防文件覆盖。
2. Spring MVC 中的文件下载
文件下载是:将服务器当中的文件,下载到本地客户端当中
前端页面:
<!--文件下载-->
<a th:href="@{/download}">文件下载</a>
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>文件上传与下载</title>
</head>
<body>
<h1>文件上传下载</h1>
<hr>
<h2>测试</h2>
<!--文件下载-->
<h1>下载</h1>
<a th:href="@{/download}">文件下载</a>
</body>
</html>
文件下载核心程序,使用ResponseEntity:
import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpRequest;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;
import javax.lang.model.element.VariableElement;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.util.UUID;
@Controller
public class FileController {
@GetMapping("/download")
public ResponseEntity<byte[]> downloadFile(HttpServletRequest request) throws IOException {
File file = new File(request.getServletContext().getRealPath("/upload") + "xiaomu.jpeg");
// 创建响应头对象
HttpHeaders httpHeaders = new HttpHeaders();
// 设置响应内容类型
httpHeaders.setContentType(MediaType.APPLICATION_OCTET_STREAM);
// 设置下载文件的名称
httpHeaders.setContentDispositionFormData("attachment",file.getName());
// 下载文件
ResponseEntity<byte[]> entity = new ResponseEntity<byte[]>(Files.readAllBytes(file.toPath()), httpHeaders, HttpStatus.OK);
return entity;
}
}
效果:
3. 总结:
- 文件上传:form表单采用post请求,enctype是multipart/form-data,并且上传组件是:type=“file”
- 上传文件时,文件起名采用UUID。以防文件覆盖。
4. 最后:
“在这个最后的篇章中,我要表达我对每一位读者的感激之情。你们的关注和回复是我创作的动力源泉,我从你们身上吸取了无尽的灵感与勇气。我会将你们的鼓励留在心底,继续在其他的领域奋斗。感谢你们,我们总会在某个时刻再次相遇。”