当前位置 博文首页 > blackball1998的博客:文件上传下载
我们使用Spring Boot开发web应用,可以很轻松地实现文件上传和下载功能
要使用文件上传类,只需要使用Spring提供的MultipartFile
类即可,它可以封装上传的文件对象,方便我们对文件做各种操作
首先我们将MultipartFile
对象作为参数添加在请求处理方法的参数列表中,然后在这个对象上添加一个@RequestPart
注解,并且绑定文件的名字,也就是前端页面标签中的name属性的值
如果前端的一个标签上传的是多个文件,只需要将参数的对象改为数组即可
@RestController
public class MyController {
@RequestMapping("/upload")
public String upload(@RequestPart("img") MultipartFile img, @RequestPart("photos") MultipartFile[] photos) {
System.out.println(img.getSize());
System.out.println(photos.length);
return "SUCCESS";
}
}
MultipartFile
类有很多方法可以对文件对象做操作,getSize
方法可以获取文件的大小,getOriginalFilename
方法可以获取原文件的名字,getInputStream
方法可以获取原始的流
在Spring Boot中,文件上传功能默认的单个文件大小上限是1MB,单个请求中所有文件的总大小上限是10MB,我们可以通过修改配置文件来设置这两个值
spring:
servlet:
multipart:
max-file-size: 10MB
max-request-size: 100MB
我们添加一个测试页面来测试效果
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Index</title>
</head>
<body>
<form action="/upload" method="post" enctype="multipart/form-data">
<div><input type="file" name="img" id="img"/></div>
<div><input type="file" name="photos" id="photos" multiple/></div>
<div><input type="submit" value="submit"/></div>
</form>
</body>
</html>
注意表单提交带文件的请求,需要是POST类型,并且请求头中的Content-Type需要为multipart/form-data
在表单的第一个元素中添加一张图片,第二个元素中添加两张图片,点击提交
后台可以打印出上传文件的原名称,大小和文件的个数
需要保存文件到文件服务器,可以使用MultipartFile
类的transferTo
方法,使用时创建一个File对象,并指定文件的路径即可
@RestController
public class MyController {
@RequestMapping("/upload")
public String upload(@RequestPart("img") MultipartFile img, @RequestPart("photos") MultipartFile[] photos) throws IOException {
img.transferTo(new File("D:\\upload\\" + img.getOriginalFilename()));
for (MultipartFile photo : photos) {
photo.transferTo(new File("D:\\upload\\" + photo.getOriginalFilename()));
}
return "SUCCESS";
}
}
这个方法是磁盘IO操作,所以会抛出IO异常
使用之前的页面测试文件能否保存到本地磁盘中
测试结果如下,文件被读取到之后可以保存到指定路径
文件下载有两种方法,一种是使用原生IO流和原生HttpServletResponse
的方法,一种是使用Spring MVC提供的ResponseEntity
类的方法
将HttpServletResponse
对象作为参数添加到请求处理方法的参数列表中,然后调用对象的getOutputStream
得到原生的输出流,使用这个输出流操作IO
@RestController
public class MyController {
@RequestMapping("/download")
public String download(HttpServletResponse response) {
File file = new File("D:\\source\\test.png");
response.setHeader("Content-Disposition", "attachment;filename=" + file.getName());
try {
ServletOutputStream outputStream = response.getOutputStream();
InputStream inputStream = new FileInputStream(file);
byte[] buffer = new byte[2048];
int length;
while ((length = inputStream.read(buffer)) > 0) {
outputStream.write(buffer, 0, length);
}
outputStream.flush();
outputStream.close();
inputStream.close();
return "success";
} catch (IOException e) {
return "error";
}
}
}
在请求处理方法返回一个ResponseEntity
对象,将文件转换成字节数组并加入这个对象中
@RestController
public class MyController {
@RequestMapping("/download")
public ResponseEntity<byte[]> download() {
File file = new File("D:\\source\\test.png");
try {
InputStream inputStream = new FileInputStream(file);
byte[] body = new byte[inputStream.available()];
inputStream.read(body);
inputStream.close();
HttpHeaders headers = new HttpHeaders();
headers.add("Content-Disposition", "attachment;filename=" + file.getName());
return new ResponseEntity<>(body, headers, HttpStatus.OK);
} catch (IOException e) {
return null;
}
}
}
实际开发中,往往使用FTP服务器下载文件,而不会简单地使用以上的方式