文件上传
Spring 文件上传
我们可以定义如下的模板：
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8" />
<title>文件上传页面</title>
</head>
<body>
<h1>文件上传页面</h1>
<form method="post" action="/upload" enctype="multipart/form-data">
选择要上传的文件：<input type="file" name="file" /><br />
<hr />
<input type="submit" value="提交" />
</form>
</body>
</html>
然后创建文件上传的处理控制器，命名为 UploadController：
@Controller
@Slf4j
public class UploadController {
@Value("${file.upload.path}")
private String path;
@GetMapping("/")
public String uploadPage() {
return "upload";
}
@PostMapping("/upload")
@ResponseBody
public String create(@RequestPart MultipartFile file) throws IOException {
String fileName = file.getOriginalFilename();
String filePath = path + fileName;
File dest = new File(filePath);
Files.copy(file.getInputStream(), dest.toPath());
return "Upload file success : " + dest.getAbsolutePath();
}
}
其中包含这几个重要元素：
- 成员变量 path，通过@Value 注入配置文件中的 file.upload.path 属性。这个配置用来定义文件上传后要保存的目录位置。
- GET 请求，路径/，用于显示 upload.html 这个文件上传页面。
- POST 请求。路径/upload，用于处理上传的文件，即：保存到 file.upload.path 配置的路径下面。
编辑 application.properties 配置文件：
spring.servlet.multipart.max-file-size=2MB
spring.servlet.multipart.max-request-size=2MB
file.upload.path=/Users/didi/
多文件处理
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8" />
<title>文件上传页面 - didispace.com</title>
</head>
<body>
<h1>文件上传页面</h1>
<form method="post" action="/upload" enctype="multipart/form-data">
文件1：<input type="file" name="files" /><br />
文件2：<input type="file" name="files" /><br />
<hr />
<input type="submit" value="提交" />
</form>
</body>
</html>
可以看到这里多增加一个 input 文件输入框，同时文件输入框的名称修改为了 files，因为是多个文件，所以用了复数。注意：这几个输入框的 name 是一样的，这样才能在后端处理文件的时候组织到一个数组中。
@PostMapping("/upload")
@ResponseBody
public String create(@RequestPart MultipartFile[] files) throws IOException {
StringBuffer message = new StringBuffer();
for (MultipartFile file : files) {
String fileName = file.getOriginalFilename();
String filePath = path + fileName;
File dest = new File(filePath);
Files.copy(file.getInputStream(), dest.toPath());
message.append("Upload file success : " + dest.getAbsolutePath()).append("<br>");
}
return message.toString();
}
- MultipartFile 使用数组，参数名称 files 对应 html 页面中 input 的 name，一定要对应。
- 后续处理文件的主体（for 循环内）跟之前的一样，就是对 MultipartFile 数组通过循环遍历的方式对每个文件进行存储，然后拼接结果返回信息。
单元测试
普通接口的单元测试我们是如何写的？看看我们入门例子中的单元测试：
@SpringBootTest
public class Chapter11ApplicationTests {
private MockMvc mvc;
@Before
public void setUp() {
mvc = MockMvcBuilders.standaloneSetup(new HelloController()).build();
}
@Test
public void getHello() throws Exception {
mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))
.andExpect(status().isOk())
.andExpect(content().string(equalTo("Hello World")));
}
}
这里我们所用到的核心是 MockMvc 工具，通过模拟 http 请求的提交并指定相关的期望返回来完成。对于文件上传接口，本质上还是 http 请求的处理，所以 MockMvc 依然逃不掉，就是上传内容发生了改变，我们只需要去找一下文件上传的模拟对象是哪个，就可以轻松完成这个任务。
@SpringBootTest(classes = Chapter43Application.class)
public class FileTest {
@Autowired
protected WebApplicationContext context;
protected MockMvc mvc;
@BeforeEach
public void setUp() {
mvc = MockMvcBuilders.webAppContextSetup(context).build();
}
@Test
public void uploadFile() throws Exception {
MockMultipartFile file = new MockMultipartFile(
"file",
"hello.txt",
MediaType.TEXT_PLAIN_VALUE,
"Hello, World!".getBytes()
);
final MvcResult result = mvc.perform(
MockMvcRequestBuilders
.multipart("/upload")
.file(file))
.andDo(print())
.andExpect(status().isOk())
.andReturn();
}
}