SpringBoot上傳文件大小受限問題的解決辦法

更新時間：2022年05月11日 09:06:04 作者：一宿君

最近有一次由于項目升級發(fā)現(xiàn)了一個上傳方面的問題,下面這篇文章主要給大家介紹了關(guān)于SpringBoot上傳文件大小受限問題的解決辦法,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下

1、控制臺異常

org.springframework.web.multipart.MaxUploadSizeExceededException: Maximum upload size exceeded; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$FileSizeLimitExceededException: The field file exceeds its maximum permitted size of 1048576 bytes.
	at org.springframework.web.multipart.support.StandardMultipartHttpServletRequest.handleParseFailure(StandardMultipartHttpServletRequest.java:121)
	at org.springframework.web.multipart.support.StandardMultipartHttpServletRequest.parseRequest(StandardMultipartHttpServletRequest.java:114)

從上述異?？梢钥闯?，是因為上傳的file文件超過了spring默認配置的最大值1048576 bytes，上傳文件我們通常情況下是使用MultipartFile接口類接收前端上傳的文件，可見對于MultipartFile文件的默認限制也是1048576 bytes，即1M。

但是很多情況下我們用手機直接拍攝的證件照或者是文檔問阿金基本都是在2M以上，很顯然這不能滿足我們的日常需求，所以我們就要修改默認配置參數(shù)大小。

2、上傳文件默認參數(shù)

SpringBoot不同的版本，對應的設(shè)置參數(shù)不同：

Spring Boot 1.3.x and earlier

multipart.maxFileSize
multipart.maxRequestSize

Spring Boot 1.4.x and 1.5.x

spring.http.multipart.maxFileSize
spring.http.multipart.maxRequestSize

Spring Boot 2.x

spring.servlet.multipart.maxFileSize
spring.servlet.multipart.maxRequestSize

3、解決方法

3.1、方法1（在配置文件.yml或者.properties中直接修改參數(shù)）

例如我使用的是SpringBoot 2.1.3的版本，然后直接再配置文件中設(shè)置參數(shù)大小：

#做限制的參數(shù)配置
spring:
  servlet:
    multipart:
      enabled: true #默認支持文件上傳
      max-file-size: 20MB # 最大支持文件大小
      max-request-size: 30MB # 最大支持請求大小

#不做限制的參數(shù)配置
spring:
  servlet:
    multipart:
      enabled: true #默認支持文件上傳
      max-file-size: -1 #不做限制
      max-request-size: -1 #不做限制

設(shè)置完重啟項目即可成功上傳文件。

3.2、方法2（自定義config配置類）

將參數(shù)配置在遠程配置文件中心，如果是配置項目中的配置文件中，那就跟方法1一樣了，就沒必要再單獨寫配置類了，將參數(shù)配置在遠程配置中心，就是為了可以根據(jù)臨時需求動態(tài)修改參數(shù)，而不用重啟項目。

常見的遠程配置文件中心服務有Nacos、Apollo(阿波羅)、SpringCloud等等，我使用的是Nacos配置中心服務：

自定義MultipartFileConfig配置類：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.MultipartConfigFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.unit.DataSize;
import javax.servlet.MultipartConfigElement;

/**
 * @author: 一宿君
 * @date: 2022-03-23 19:18:51
 * @description: 
 */
@Configuration
public class MultipartFileConfig {

    @Value("${config.multifile.maxFileSize}")
    private Long maxFileSize;
    @Value("${config.multifile.maxRequestSize}")
    private Long maxRequestSize;

    @Bean
    public MultipartConfigElement multipartConfigElement() {
        MultipartConfigFactory factory = new MultipartConfigFactory();
        /**
         * 單個數(shù)據(jù)大小，
         * DataSize.ofMegabytes(maxFileSize)默認是配置字節(jié)，將字節(jié)轉(zhuǎn)化為MB
         */
        factory.setMaxFileSize(DataSize.ofMegabytes(maxFileSize));
        // 總上傳數(shù)據(jù)大小
        factory.setMaxRequestSize(DataSize.ofMegabytes(maxRequestSize));
        return factory.createMultipartConfig();
    }
}

這樣就可以隨時控制上傳文件的大小了！