SpringBoot中实现接收文件和对象
作者:LitongZero
SpringBoot接收文件和对象
使用场景:某个接口,需要同时接收文件和实体,也就是参数
一、这个时候,前端就不能json格式传送数据了,要用到multipart/form-data;这种格式传送数据。
二、那么,这个时候,后端应该怎样接收这个参数和文件呢?
1.接收HttpServletRequest,自己处理request(不推荐)
@PostMapping(value = "/upload") @ResponseBody public String handleFileUpload(HttpServletRequest request) { MultipartHttpServletRequest params=((MultipartHttpServletRequest) request); // 获取文件 List<MultipartFile> files = ((MultipartHttpServletRequest) request).getFiles("file"); // 获取参数 String name=params.getParameter("name");
2.接收实体,将文件放到对象属性中(推荐)
public class UserFileReq { // 参数 private String username; // 文件 private MultipartFile file; // 省略get\set } @PostMapping(value = "/upload") @ResponseBody public String handleFileUpload(UserFileReq req) { // 文件和参数 都在实体中了 }
3.接收参数,将文件放到接收参数中
这种方法适合接收单个文件参数,多参数还是建议用对象接收,方便扩展
@PostMapping(value = "/upload") @ResponseBody public String handleFileUpload(MultipartFile file) { }
4.一个坑,使用第二种方法的时候
一定不要加@RequestBody,加了这个注解,就会报如下错误。
{ "timestamp": 1571196217195, "status": 415, "error": "Unsupported Media Type", "exception": "org.springframework.web.HttpMediaTypeNotSupportedException", "message": "Content type 'multipart/form-data;boundary=2gOOYeFBpE;charset=UTF-8' not supported", "path": "/file/upload" }
所以,接收文件,不要使用@RequestBody注解
但是@Validated注解(校验参数的注解)是可以使用的。
SpringBoot接口同时接收JSON数据和文件时遇到的问题
最近公司有一个需求,需要通过一个接口上传处理好的数据,由于数据太复杂,所以就采用了JSON格式提交数据,接口通过@RequestBody获取数据并且映射到对应的对象去,这块需要注意的一个问题就是前端在提交数据的时候需要将HTTP的Headers头里的Content-Type设置成application/json才行,本来写好测试完大功告成了,结果突然又改需求了。。要求在提交数据的时候同时上传一个文件,于是便查询了一下资料,发现@RequestBody对应的类型是application/json,而文件Multipart对应的类型是multipart/form-data,这两种格式不兼容,所以无论怎么写都是调用失败的。
原始代码如下
经过调查发现有两种办法解决问题
首先都是将Content-type类型设置为multipart/form-data;
1.简化参数,将JSON参数抽取出来,参数传递过去后再重新拼接。
2.将@RequestBody修饰的实体参数当做一个JSON字符串传递,传递过去后通过GSON或者FastJSON转换。
因为第二种方法简单,所以采用了第二种方法。
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。