类 CommonsFileUploadSupport

  • 直接已知子类:
    CommonsMultipartResolver, CommonsPortletMultipartResolver

    public abstract class CommonsFileUploadSupport
    extends Object
    Base class for multipart resolvers that use Apache Commons FileUpload 1.2 or above.

    Provides common configuration properties and parsing functionality for multipart requests, using a Map of Spring CommonsMultipartFile instances as representation of uploaded files and a String-based parameter Map as representation of uploaded form fields.

    Subclasses implement concrete resolution strategies for Servlet or Portlet environments: see CommonsMultipartResolver and CommonsPortletMultipartResolver, respectively. This base class is not tied to either of those APIs, factoring out common functionality.

    从以下版本开始:
    2.0
    作者:
    Juergen Hoeller
    另请参阅:
    CommonsMultipartFile, CommonsMultipartResolver, CommonsPortletMultipartResolver
    • 字段详细资料

    • 方法详细资料

      • getFileItemFactory

        public org.apache.commons.fileupload.disk.DiskFileItemFactory getFileItemFactory()
        Return the underlying org.apache.commons.fileupload.disk.DiskFileItemFactory instance. There is hardly any need to access this.
        返回:
        the underlying DiskFileItemFactory instance
      • getFileUpload

        public org.apache.commons.fileupload.FileUpload getFileUpload()
        Return the underlying org.apache.commons.fileupload.FileUpload instance. There is hardly any need to access this.
        返回:
        the underlying FileUpload instance
      • setMaxUploadSize

        public void setMaxUploadSize​(long maxUploadSize)
        Set the maximum allowed size (in bytes) before an upload gets rejected. -1 indicates no limit (the default).
        参数:
        maxUploadSize - the maximum upload size allowed
        另请参阅:
        FileUploadBase.setSizeMax(long)
      • setMaxUploadSizePerFile

        public void setMaxUploadSizePerFile​(long maxUploadSizePerFile)
        Set the maximum allowed size (in bytes) for each individual file before an upload gets rejected. -1 indicates no limit (the default).
        参数:
        maxUploadSizePerFile - the maximum upload size per file
        从以下版本开始:
        4.2
        另请参阅:
        FileUploadBase.setFileSizeMax(long)
      • setMaxInMemorySize

        public void setMaxInMemorySize​(int maxInMemorySize)
        Set the maximum allowed size (in bytes) before uploads are written to disk. Uploaded files will still be received past this amount, but they will not be stored in memory. Default is 10240, according to Commons FileUpload.
        参数:
        maxInMemorySize - the maximum in memory size allowed
        另请参阅:
        DiskFileItemFactory.setSizeThreshold(int)
      • setDefaultEncoding

        public void setDefaultEncoding​(String defaultEncoding)
        Set the default character encoding to use for parsing requests, to be applied to headers of individual parts and to form fields. Default is ISO-8859-1, according to the Servlet spec.

        If the request specifies a character encoding itself, the request encoding will override this setting. This also allows for generically overriding the character encoding in a filter that invokes the ServletRequest.setCharacterEncoding method.

        参数:
        defaultEncoding - the character encoding to use
        另请参阅:
        ServletRequest.getCharacterEncoding(), ServletRequest.setCharacterEncoding(java.lang.String), WebUtils.DEFAULT_CHARACTER_ENCODING, FileUploadBase.setHeaderEncoding(java.lang.String)
      • newFileItemFactory

        protected org.apache.commons.fileupload.disk.DiskFileItemFactory newFileItemFactory()
        Factory method for a Commons DiskFileItemFactory instance.

        Default implementation returns a standard DiskFileItemFactory. Can be overridden to use a custom subclass, e.g. for testing purposes.

        返回:
        the new DiskFileItemFactory instance
      • newFileUpload

        protected abstract org.apache.commons.fileupload.FileUpload newFileUpload​(org.apache.commons.fileupload.FileItemFactory fileItemFactory)
        Factory method for a Commons FileUpload instance.

        To be implemented by subclasses.

        参数:
        fileItemFactory - the Commons FileItemFactory to build upon
        返回:
        the Commons FileUpload instance
      • prepareFileUpload

        protected org.apache.commons.fileupload.FileUpload prepareFileUpload​(String encoding)
        Determine an appropriate FileUpload instance for the given encoding.

        Default implementation returns the shared FileUpload instance if the encoding matches, else creates a new FileUpload instance with the same configuration other than the desired encoding.

        参数:
        encoding - the character encoding to use
        返回:
        an appropriate FileUpload instance.
      • cleanupFileItems

        protected void cleanupFileItems​(MultiValueMap<String,​MultipartFile> multipartFiles)
        Cleanup the Spring MultipartFiles created during multipart parsing, potentially holding temporary data on disk.

        Deletes the underlying Commons FileItem instances.

        参数:
        multipartFiles - Collection of MultipartFile instances
        另请参阅:
        FileItem.delete()