Spring Boot应用上传文件时报错的原因及解决方案
问题描述
SpringBoot应用(使用默认的嵌入式Tomcat)在上传文件时,偶尔会出现上传失败的情况,后台报错日志信息如下:“Thetemporaryuploadlocationisnotvalid”。
原因追踪
这个问题的根本原因是Tomcat的文件上传机制引起的!
Tomcat在处理文件上传时,会将客户端上传的文件写入临时目录,这个临时目录默认在/tmp路径下,如:“/tmp/tomcat.6574404581312272268.18333/work/Tomcat/localhost/ROOT”。
而操作系统对于/tmp目录会不定时进行清理,如果正好因为操作系统的清理导致对应的临时目录被删除,客户端再上传文件时就会报错:“Thetemporaryuploadlocationisnotvalid”。
实际上,追踪一下源码会发现,如果不明确设置Tomcat的文件上传临时目录,默认读取的是Servlet上下文对象的属性“javax.servlet.context.tempdir”值,如下源码:
- org.apache.catalina.connector.Request
privatevoidparseParts(booleanexplicit){ //... MultipartConfigElementmce=this.getWrapper().getMultipartConfigElement(); //... //读取MultipartConfigElement对象的location属性 StringlocationStr=mce.getLocation(); Filelocation; if(locationStr!=null&&locationStr.length()!=0){ location=newFile(locationStr); if(!location.isAbsolute()){ location=(newFile((File)context.getServletContext().getAttribute("javax.servlet.context.tempdir"),locationStr)).getAbsoluteFile(); } }else{ //如果location属性值为空,则读取Servlet上下文对象的属性“javax.servlet.context.tempdir”值(如:/tmp/tomcat.6574404581312272268.18333/work/Tomcat/localhost/ROOT) location=(File)context.getServletContext().getAttribute("javax.servlet.context.tempdir"); } //... }
解决办法
既然是因为上传文件的临时路径被删除导致的问题,就要确保改临时目录不会被删除。
2种解决方法:
(1)通过SpringBoot的配置参数“spring.servlet.multipart.location”明确指定上传文件的临时目录,确保该路径已经存在,而且该目录不会被操作系统清除。
spring.servlet.multipart.location=/data/tmp
如上所示,将上传文件的临时目录指定到路径“/data/tmp”下。
实际上,在SpringBoot中关于上传文件的所有配置参数如下所示:
#MULTIPART(MultipartProperties) spring.servlet.multipart.enabled=true#Whethertoenablesupportofmultipartuploads. spring.servlet.multipart.file-size-threshold=0B#Thresholdafterwhichfilesarewrittentodisk. spring.servlet.multipart.location=#Intermediatelocationofuploadedfiles. spring.servlet.multipart.max-file-size=1MB#Maxfilesize. spring.servlet.multipart.max-request-size=10MB#Maxrequestsize. spring.servlet.multipart.resolve-lazily=false#Whethertoresolvethemultipartrequestlazilyatthetimeoffileorparameteraccess.
(2)在Spring容器中明确注册MultipartConfigElement对象,通过MultipartConfigFactory指定一个路径。
在上述源码追踪中就发现,Tomcat会使用MultipartConfigElement对象的location属性作为上传文件的临时目录。
/** *配置上传文件临时目录 *@return */ @Bean publicMultipartConfigElementmultipartConfigElement(){ MultipartConfigFactoryfactory=newMultipartConfigFactory(); //tmp.dir参数在启动脚本中设置 Stringpath=System.getProperty("tmp.dir"); if(path==null||"".equals(path.trim())){ path=System.getProperty("user.dir"); } Stringlocation=path+"/tmp"; FiletmpFile=newFile(location); //如果临时目录不存在则创建 if(!tmpFile.exists()){ tmpFile.mkdirs(); } //明确指定上传文件的临时目录 factory.setLocation(location); returnfactory.createMultipartConfig(); }
参考
https://stackoverflow.com/questions/50523407/the-temporary-upload-location-tmp-tomcat-4296537502689403143-5000-work-tomcat/50523578
以上就是SpringBoot应用上传文件时报错的原因及解决方案的详细内容,更多关于SpringBoot应用上传文件时报错的资料请关注毛票票其它相关文章!