JSP 文件上传组件commons-fileupload

 应用第三方的开源组件实现文件上传，目前比较常用的上传组件是jspSmartUpload和commons-fileupload。应用它们可以不必编写大量的代码，只需要简单地调用即可，具体的业务实现在组件中完成。这里仅介绍commons-fileupload的实现文件上传详解。

       1.commons-fileupload组件介绍

       commons-fileupload组件是apache的一个开源项目，该组件很好地处理处理了中文。即可应用该组件上传文件不会出现中文乱码问题，是目前应用最广泛的开源组件，该组件包文件commons-fileupload-1.2.2.jar可到apache官网上下载，一定要注意这个组件需要commons-io-2.1.jar组件支持。

       2.commons-fileupload组件核心类

       2.1  DiskFileUpload类

       DiskFileUpload类是Apache文件上传组件的核心类，应用程序开发人员通过这个类来与Apache文件上传组件进行交互。但现在Apache建议使用ServletFileUpload类，两个类的方法类似。下面介绍DiskFileUpload类中的几个常用的重要方法。

      2.1.1 setSizeMax方法

       setSizeMax方法用于设置请求消息实体内容的最大允许大小，以防止客户端故意通过上传特大的文件来塞满服务器端的存储空间，单位为字节。其完整语法定义如下：

       public void setSizeMax（long sizeMax）

        如果请求消息中的实体内容的大小超过了setSizeMax方法的设置值，该方法将会抛出FileUploadException异常。

       2.1.2  setSizeThreshold方法

        Apache文件上传组件在解析和处理上传数据中的每个字段内容时，需要临时保存解析出的数据。因为Java虚拟机默认可以使用的内存空间是有限的（笔者测试不大于100M），超出限制时将会发生“java.lang.OutOfMemoryError”错误，如果上传的文件很大，例如上传800M的文件，在内存中将无法保存该文件内容，Apache文件上传组件将用临时文件来保存这些数据；但如果上传的文件很小，例如上传600个字节的文件，显然将其直接保存在内存中更加有效。setSizeThreshold方法用于设置是否使用临时文件保存解析出的数据的那个临界值，该方法传入的参数的单位是字节。其完整语法定义如下：

       public void setSizeThreshold(int sizeThreshold)

       2.1.3. setRepositoryPath方法

       setRepositoryPath方法用于设置setSizeThreshold方法中提到的临时文件的存放目录，这里要求使用绝对路径。其完整语法定义如下：

       public void setRepositoryPath(String repositoryPath)

       如果不设置存放路径，那么临时文件将被储存在"java.io.tmpdir"这个JVM环境属性所指定的目录中，tomcat 5.5.9将这个属性设置为了“<tomcat安装目录>/temp/”目录。

      2.1.4  parseRequest方法

      parseRequest 方法是DiskFileUpload类的重要方法，它是对HTTP请求消息进行解析的入口方法，如果请求消息中的实体内容的类型不是“multipart/form-data”，该方法将抛出FileUploadException异常。parseRequest 方法解析出FORM表单中的每个字段的数据，并将它们分别包装成独立的FileItem对象，然后将这些FileItem对象加入进一个List类型的集合对象中返回。parseRequest 方法的完整语法定义如下：

      public List parseRequest(HttpServletRequest req)

      parseRequest 方法还有一个重载方法，该方法集中处理上述所有方法的功能，其完整语法定义如下：

     parseRequest(HttpServletRequest req,int sizeThreshold,long sizeMax, String path)

     这两个parseRequest方法都会抛出FileUploadException异常。

     2.1.5. isMultipartContent方法

    isMultipartContent方法方法用于判断请求消息中的内容是否是“multipart/form-data”类型，是则返回true，否则返回false。isMultipartContent方法是一个静态方法，不用创建DiskFileUpload类的实例对象即可被调用，其完整语法定义如下：

public static final boolean isMultipartContent(HttpServletRequest req)

       2.1.6. setHeaderEncoding方法

        由于浏览器在提交FORM表单时，会将普通表单中填写的文本内容传递给服务器，对于文件上传字段，除了传递原始的文件内容外，还要传递其文件路径名等信息，如后面的图1.3所示。不管FORM表单采用的是“application/x-www-form-urlencoded”编码，还是“multipart/form-data”编码，它们仅仅是将各个FORM表单字段元素内容组织到一起的一种格式，而这些内容又是由某种字符集编码来表示的。关于浏览器采用何种字符集来编码FORM表单字段中的内容，请参看笔者编著的《深入体验java Web开发内幕——核心基础》一书中的第6.9.2的讲解，“multipart/form-data”类型的表单为表单字段内容选择字符集编码的原理和方式与“application/x-www-form-urlencoded”类型的表单是相同的。FORM表单中填写的文本内容和文件上传字段中的文件路径名在内存中就是它们的某种字符集编码的字节数组形式，Apache文件上传组件在读取这些内容时，必须知道它们所采用的字符集编码，才能将它们转换成正确的字符文本返回。

       对于浏览器上传给WEB服务器的各个表单字段的描述头内容，Apache文件上传组件都需要将它们转换成字符串形式返回，setHeaderEncoding 方法用于设置转换时所使用的字符集编码，其原理与笔者编著的《深入体验java Web开发内幕——核心基础》一书中的第6.9.4节讲解的ServletRequest.setCharacterEncoding方法相同。setHeaderEncoding 方法的完整语法定义如下：

       public void setHeaderEncoding(String encoding)

       其中，encoding参数用于指定将各个表单字段的描述头内容转换成字符串时所使用的字符集编码。

注意：如果在使用Apache文件上传组件时遇到了中文字符的乱码问题，一般都是没有正确调用setHeaderEncoding方法的原因。

版权声明：本文为博主原创文章，未经博主允许不得转载。