Spring Boot アップロード時のファイルサイズ制限を拡張する方法

2021.10.16 2021.10.16

Spring Bootでアップロード時のファイルサイズ制限を拡張する方法です。

Spring Boot アップロード時のファイルサイズ制限を拡張する方法

Spring Bootでは、1MB以上のファイルをアップロードすると、下記のようなエラーが発生します。

org.apache.tomcat.util.http.fileupload.FileUploadBase$FileSizeLimitExceededException: The field file-select exceeds its maximum permitted size of 1048576 bytes.

これはSpring Bootのデフォルト値が1MBとなっているからです。拡張設定を記述することで1MB以上のファイルをアップロードできます。

ここでは Spring Bootでアップロード時のファイルサイズ制限を拡張する方法 を紹介します。

1 検証したバージョン
2 application.yml設定する
3 まとめ

検証したバージョン

Spring Boot v2.2.2.RELEASE

application.yml設定する

application.ymlに下記を追加すればOKです。


spring:
  servlet:
    multipart:
      max-file-size: 10MB # Max file size. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes, respectively.
      max-request-size: 10MB # Max request size. Values can use the suffixes "MB" or "KB" to indicate megabytes or kilobytes, respectively.

application.propertiesなら下記のようになります。


spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB

まとめ

Spring Bootでアップロード時のファイルサイズ制限を拡張する方法を紹介しました。

今回検証したのはSpring Boot v2.2.2.RELEASEだったので、multipartプロパティは「spring.servlet」配下にありました。

・Common Application properties

バージョンによって記述方法が変わっているので、自分の使っている環境に合わせてドキュメントをチェックしてみてください。

・Index of /spring-boot/docs

おつかれさまでした。