パッケージ org.springframework.web.multipart

インターフェース MultipartFile

すべてのスーパーインターフェース:
InputStreamSource
すべての既知の実装クラス:
MockMultipartFile
public interface MultipartFile extends InputStreamSource
マルチパートリクエストで受信したアップロードファイルの表現。

ファイルの内容は、メモリに保存されるか、一時的にディスクに保存されます。どちらの場合でも、必要に応じて、ユーザーはファイルの内容をセッションレベルまたは永続ストアにコピーする責任があります。一時ストレージは、リクエスト処理の終了時にクリアされます。

導入:
29.09.2003
作成者:
Juergen Hoeller, Trevor D. Cook
関連事項:

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    byte[]
    getBytes()
    ファイルの内容をバイトの配列として返します。
    StringSE
    getContentType()
    ファイルのコンテンツ型を返します。
    InputStreamSE
    getInputStream()
    ファイルの内容を読み取る InputStream を返します。
    StringSE
    getName()
    マルチパート形式でパラメーターの名前を返します。
    StringSE
    getOriginalFilename()
    クライアントのファイルシステムにある元のファイル名を返します。
    default Resource
    getResource()
    この MultipartFile のリソース表現を返します。
    long
    getSize()
    ファイルのサイズをバイト単位で返します。
    boolean
    isEmpty()
    アップロードされたファイルが空かどうか、つまり、マルチパート形式でファイルが選択されていないか、選択されたファイルにコンテンツがないかを返します。
    void
    transferTo(FileSE dest)
    受信したファイルを指定された宛先ファイルに転送します。
    default void
    transferTo(PathSE dest)
    受信したファイルを指定された宛先ファイルに転送します。

  • メソッドの詳細

    • getName

      StringSE getName()
      マルチパート形式でパラメーターの名前を返します。
      戻り値:
      パラメーターの名前 (null または空ではない)

    • getOriginalFilename

      @Nullable StringSE getOriginalFilename()
      クライアントのファイルシステムにある元のファイル名を返します。

      これには、使用するブラウザーによってはパス情報が含まれる場合がありますが、通常は Opera 以外には含まれません。

      注意 : このファイル名はクライアントから提供されたものであり、盲目的に使用しないでください。ファイル名には、ディレクトリ部分を使用しないだけでなく、".." などの悪用される可能性のある文字が含まれている可能性があります。このファイル名を直接使用しないことをお勧めします。できれば、一意のものを生成し、必要に応じて、参照用にこれをどこかに保存してください。

      戻り値:
      元のファイル名、またはマルチパート形式でファイルが選択されていない場合は空の文字列、定義されていないか利用できない場合は null 
      関連事項:

    • getContentType

      @Nullable StringSE getContentType()
      ファイルのコンテンツ型を返します。
      戻り値:
      コンテンツ型、または定義されていない場合は null (または、マルチパート形式でファイルが選択されていません)

    • isEmpty

      boolean isEmpty()
      アップロードされたファイルが空かどうか、つまり、マルチパート形式でファイルが選択されていないか、選択されたファイルにコンテンツがないかを返します。

    • getSize

      long getSize()
      ファイルのサイズをバイト単位で返します。
      戻り値:
      ファイルのサイズ、または空の場合は 0

    • getBytes

      byte[] getBytes() throws IOExceptionSE
      ファイルの内容をバイトの配列として返します。
      戻り値:
      バイトとしてのファイルの内容、または空の場合は空のバイト配列
      例外:
      IOExceptionSE - アクセスエラーの場合 (一時ストアが失敗した場合)

    • getInputStream

      InputStreamSE getInputStream() throws IOExceptionSE
      ファイルの内容を読み取る InputStream を返します。

      ユーザーは、返されたストリームを閉じる責任があります。

      次で指定:
      インターフェース InputStreamSource の getInputStream 
      戻り値:
      ストリームとしてのファイルのコンテンツ、または空の場合は空のストリーム
      例外:
      IOExceptionSE - アクセスエラーの場合 (一時ストアが失敗した場合)
      関連事項:

    • getResource

      default Resource getResource()
      この MultipartFile のリソース表現を返します。これは、RestTemplate または WebClient への入力として使用して、コンテンツの長さとファイル名を InputStream とともに公開できます。
      戻り値:
      この MultipartFile は、リソース契約に適合しています
      導入:
      5.1

    • transferTo

      void transferTo(FileSE dest) throws IOExceptionSE, IllegalStateExceptionSE
      受信したファイルを指定された宛先ファイルに転送します。

      これにより、ファイルシステム内のファイルを移動したり、ファイルシステム内のファイルをコピーしたり、メモリ内のコンテンツを宛先ファイルに保存したりできます。宛先ファイルがすでに存在する場合、最初に削除されます。

      ターゲットファイルがファイルシステム内で移動されている場合、この操作は後で再度呼び出すことはできません。ストレージメカニズムを使用するには、このメソッドを 1 回だけ呼び出します。

      注意 : 基盤となるプロバイダーによっては、一時ストレージがコンテナーに依存する場合があります。これには、ここで指定された相対的な宛先のベースディレクトリが含まれます (たとえば、サーブレットのマルチパート処理を使用)。絶対的な宛先の場合、一時コピーがすでに存在する場合でも、ターゲットファイルは一時的な場所から名前変更または移動されたり、新しくコピーされたりすることがあります。

      パラメーター:
      dest - 宛先ファイル (通常は絶対)
      例外:
      IOExceptionSE - 読み取りまたは書き込みエラーの場合
      IllegalStateExceptionSE - ファイルがファイルシステム内ですでに移動されており、別の転送に使用できない場合
      関連事項:

    • transferTo

      default void transferTo(PathSE dest) throws IOExceptionSE, IllegalStateExceptionSE
      受信したファイルを指定された宛先ファイルに転送します。

      デフォルトの実装では、単にファイル入力ストリームをコピーします。

      例外:
      IOExceptionSE
      IllegalStateExceptionSE
      導入:
      5.1
      関連事項: