快捷導(dǎo)航

Spring Boot應(yīng)用上傳文件時報錯的原因及解決方案

更新時間：2021年02月05日 10:28:03 作者：nuccch

這篇文章主要介紹了Spring Boot應(yīng)用上傳文件時報錯的原因及解決方案，幫助大家更好的理解和學(xué)習(xí)使用spring boot框架，感興趣的朋友可以了解下

問題描述

Spring Boot應(yīng)用（使用默認(rèn)的嵌入式Tomcat）在上傳文件時，偶爾會出現(xiàn)上傳失敗的情況，后臺報錯日志信息如下：“The temporary upload location is not valid”。

原因追蹤

這個問題的根本原因是Tomcat的文件上傳機制引起的！
Tomcat在處理文件上傳時，會將客戶端上傳的文件寫入臨時目錄，這個臨時目錄默認(rèn)在/tmp路徑下，如：“/tmp/tomcat.6574404581312272268.18333/work/Tomcat/localhost/ROOT”。
而操作系統(tǒng)對于/tmp目錄會不定時進(jìn)行清理，如果正好因為操作系統(tǒng)的清理導(dǎo)致對應(yīng)的臨時目錄被刪除，客戶端再上傳文件時就會報錯：“The temporary upload location is not valid”。
實際上，追蹤一下源碼會發(fā)現(xiàn)，如果不明確設(shè)置Tomcat的文件上傳臨時目錄，默認(rèn)讀取的是Servlet上下文對象的屬性“javax.servlet.context.tempdir”值，如下源碼：

org.apache.catalina.connector.Request

private void parseParts(boolean explicit) {
  //...
  MultipartConfigElement mce = this.getWrapper().getMultipartConfigElement();
  //...
  // 讀取MultipartConfigElement對象的location屬性
  String locationStr = mce.getLocation();
  File location;
  if (locationStr != null && locationStr.length() != 0) {
    location = new File(locationStr);
    if (!location.isAbsolute()) {
      location = (new File((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");
  }
  //...
}

解決辦法

既然是因為上傳文件的臨時路徑被刪除導(dǎo)致的問題，就要確保改臨時目錄不會被刪除。
2種解決方法：
(1)通過Spring Boot的配置參數(shù)“spring.servlet.multipart.location”明確指定上傳文件的臨時目錄，確保該路徑已經(jīng)存在，而且該目錄不會被操作系統(tǒng)清除。

spring.servlet.multipart.location=/data/tmp

如上所示，將上傳文件的臨時目錄指定到路徑“/data/tmp”下。

實際上，在Spring Boot中關(guān)于上傳文件的所有配置參數(shù)如下所示：

# MULTIPART (MultipartProperties)
spring.servlet.multipart.enabled=true # Whether to enable support of multipart uploads.
spring.servlet.multipart.file-size-threshold=0B # Threshold after which files are written to disk.
spring.servlet.multipart.location= # Intermediate location of uploaded files.
spring.servlet.multipart.max-file-size=1MB # Max file size.
spring.servlet.multipart.max-request-size=10MB # Max request size.
spring.servlet.multipart.resolve-lazily=false # Whether to resolve the multipart request lazily at the time of file or parameter access.

(2)在Spring容器中明確注冊MultipartConfigElement對象，通過MultipartConfigFactory指定一個路徑。
在上述源碼追蹤中就發(fā)現(xiàn)，Tomcat會使用MultipartConfigElement對象的location屬性作為上傳文件的臨時目錄。

/**
 * 配置上傳文件臨時目錄
 * @return
 */
@Bean
public MultipartConfigElement multipartConfigElement() {
  MultipartConfigFactory factory = new MultipartConfigFactory();
  // tmp.dir參數(shù)在啟動腳本中設(shè)置
  String path = System.getProperty("tmp.dir");
  if(path == null || "".equals(path.trim())) {
    path = System.getProperty("user.dir");
  }
  String location = path + "/tmp";
  File tmpFile = new File(location);
  // 如果臨時目錄不存在則創(chuàng)建
  if (!tmpFile.exists()) {
    tmpFile.mkdirs();
  }
  // 明確指定上傳文件的臨時目錄
  factory.setLocation(location);
  return factory.createMultipartConfig();
}