本文章详细介绍使用Springboot如何实现上传文件和下载文件接口
1. 新建一个Springboot项目
File -> New Project 根据下图指引做:
2. 点击next,选择Springboot版本和组件,版本可以跟我不同。
3. 点击 Finish完成项目创建,然后开始导入Pom依赖:
如果依赖下载的太慢的话,可以使用aliyun,方法是在你的 pom.xml里加入下面的代码:
<repositories>
<repository>
<id>nexus-aliyun</id>
<name>nexus-aliyun</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>public</id>
<name>aliyun nexus</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
加完之后再刷新一下:
4. 导入依赖之后会出现Springboot的启动按钮:
直接点击绿色的三角启动运行项目。 运行效果: 看到这个 8080 表示你的项目启动好了。
5. 开始写文件上传接口
package com.example.demo;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
@RestController
@RequestMapping("/file")
public class FileController {
private static final String BASE_DIR = "D:\\代码\\demos\\demo\\files\\";
@PostMapping("/upload")
public void upload(@RequestParam MultipartFile file) {
String fileName = file.getOriginalFilename();
try {
File uploadFile = new File(BASE_DIR + fileName);
if (!uploadFile.getParentFile().exists()) {
uploadFile.getParentFile().mkdirs();
}
file.transferTo(uploadFile);
} catch (IOException e) {
e.printStackTrace();
}
}
}
6. 测试下文件上传接口,使用postman测试:
重启下项目,然后测试。 点击这里重启。
请注意下面的5个步骤,缺一不可
然后我们选择本地的一张图片做测试,注意key必须是 file,跟你接口的参数名字保持一致! 开始测试:
7. 文件下载接口
import javax.servlet.http.HttpServletResponse;
import java.net.URLEncoder;
@GetMapping("/download")
public void download(@RequestParam String fileName, HttpServletResponse response) {
try (FileInputStream fis = new FileInputStream(BASE_DIR + fileName);
BufferedInputStream bis = new BufferedInputStream(fis);
OutputStream os = response.getOutputStream()) {
byte[] bytes = new byte[bis.available()];
bis.read(bytes);
response.reset();
response.setContentType("application/octet-stream");
response.setHeader("Content-disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
os.write(bytes);
os.flush();
} catch (Exception e) {
e.printStackTrace();
}
}
8. 测试下载接口
重启下项目,然后测试。 点击这里重启。
可以使用刚才上传的文件进行测试,路径为 http://localhost:8080/file/download?fileName=dog.png 回车后即可完成下载!
9. 文件上传接口返回下载地址
我们可以把刚才的文件上传接口进行稍微的改造:
@PostMapping("/upload")
public String upload(@RequestParam MultipartFile file) {
String fileName = file.getOriginalFilename();
try {
File uploadFile = new File(BASE_DIR + fileName);
if (!uploadFile.getParentFile().exists()) {
uploadFile.getParentFile().mkdirs();
}
file.transferTo(uploadFile);
} catch (IOException e) {
e.printStackTrace();
}
return "http://localhost:8080/file/download?fileName=" + fileName;
}
这样就咋上传完成后直接返回了下载的地址。
再来测试下: 换了一个文件,在文件上传完成后直接返回了文件的下载链接,非常nice。
10. 前端网页上传文件
在static文件夹新建 index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>文件</title>
</head>
<body>
<div style="padding: 30px">
<input type="file" id="fileInput">
<div style="margin: 20px 0">
<button onclick="upload()">上传文件</button>
</div>
<div id="url"></div>
</div>
<script>
function upload() {
const fileInput = document.getElementById('fileInput')
const fd = new FormData()
fd.append('file', fileInput.files[0])
fetch('http://localhost:8080/file/upload', {
method: 'POST',
body: fd
}).then(res => res.json()).then(res => {
console.log(res)
document.getElementById("url").innerText = `上传成功,文件url: ${res.url}`
})
}
</script>
</body>
</html>
前端使用 fetch 上传文件,请求后台接口,但是要求后台返回的数据是json格式,怎么设置后台返回格式为json呢?
我们可以对上传接口改造,使用 Map返回数据,map中有个属性 url,就是我们返回的数据。
@PostMapping("/upload")
public Map<String, Object> upload(@RequestParam MultipartFile file) {
String fileName = file.getOriginalFilename();
try {
File uploadFile = new File(BASE_DIR + fileName);
if (!uploadFile.getParentFile().exists()) {
uploadFile.getParentFile().mkdirs();
}
file.transferTo(uploadFile);
} catch (IOException e) {
e.printStackTrace();
}
Map<String, Object> map = new HashMap<>();
map.put("url", "http://localhost:8080/file/download?fileName=" + fileName);
return map;
}
这样,我们就完成了后台 upload接口的改造了。
来看看效果:
OK,至此,我们完成了后台接口和前端的请求,怎么样?很简单吧?快去试试吧!
我是程序员青戈, Java程序员一枚~
关注我的B站: 程序员青戈 ,学习更多干货教程!
|