jspSmartUpload使用文档

一、安装篇

  jspSmartUpload是由www.jspsmart.com网站开发的一个可免费使用的全功能的文件上传下载组件,适于嵌入执行上传下载操作的JSP文件中。该组件有以下几个特点:

1、使用简单。在JSP文件中仅仅书写三五行JAVA代码就可以搞定文件的上传或下载,方便。

 

2、能全程控制上传。利用jspSmartUpload组件提供的对象及其操作方法,可以获得全部上传文件的信息(包括文件名,大小,类型,扩展名,文件数据等),方便存取。

 

3、能对上传的文件在大小、类型等方面做出限制。如此可以滤掉不符合要求的文件。

 

4、下载灵活。仅写两行代码,就能把Web服务器变成文件服务器。不管文件在Web服务器的目录下或在其它任何目录下,都可以利用jspSmartUpload进行下载。

 

5、能将文件上传到数据库中,也能将数据库中的数据下载下来。这种功能针对的是MYSQL数据库,因为不具有通用性,所以本文不准备举例介绍这种用法。

 

   jspSmartUpload组件可以从www.jspsmart.com网站上自由下载,压缩包的名字是jspSmartUpload.zip。下载后,用WinZipWinRAR将其解压到Tomcatwebapps目录下(本文以Tomcat服务器为例进行介绍)。解压后,将webapps/jspsmartupload目录下的子目录Web-inf名字改为全大写的WEB-INF,这样一改jspSmartUpload类才能使用。因为Tomcat对文件名大小写敏感,它要求Web应用程序相关的类所在目录为WEB-INF,且必须是大写。接着重新启动Tomcat,这样就可以在JSP文件中使用jspSmartUpload组件了。

 

  注意,按上述方法安装后,只有webapps/jspsmartupload目录下的程序可以使用jspSmartUpload组件,如果想让Tomcat服务器的所有Web应用程序都能用它,必须做如下工作:

 

1.进入命令行状态,将目录切换到Tomcatwebapps/jspsmartupload/WEB-INF目录下。

 

2.运行JAR打包命令:jar cvf jspSmartUpload.jar com

 

  (也可以打开资源管理器,切换到当前目录,用WinZipcom目录下的所有文件压缩成jspSmartUpload.zip,然后将jspSmartUpload.zip换名为jspSmartUpload.jar文件即可。)

 

3.将jspSmartUpload.jar拷贝到Tomcatshared/lib目录下。

 

二、相关类说明篇

 

 File

 

  这个类包装了一个上传文件的所有信息。通过它,可以得到上传文件的文件名、文件大小、扩展名、文件数据等信息。

 

File类主要提供以下方法:

 

1saveAs作用:将文件换名另存。

  原型:

         public void saveAs(java.lang.String destFilePathName)

  或

         public void saveAs(java.lang.String destFilePathName, int optionSaveAs)

   其中,destFilePathName是另存的文件名,optionSaveAs是另存的选项,该选项有三个值,分别是SAVEAS_PHYSICAL,SAVEAS_VIRTUALSAVEAS_AUTOSAVEAS_PHYSICAL表明以操作系统的根目录为文件根目录另存文件,SAVEAS_VIRTUAL表明以Web应用程序的根目录为文件根目录另存文件,SAVEAS_AUTO则表示让组件决定,当Web应用程序的根目录存在另存文件的目录时,它会选择SAVEAS_VIRTUAL,否则会选择SAVEAS_PHYSICAL

 

  例如,saveAs("/upload/sample.zip",SAVEAS_PHYSICAL)执行后若Web服务器安装在C盘,则另存的文件名实际是c:\upload\sample.zip。而saveAs("/upload/sample.zip",SAVEAS_VIRTUAL)执行后若Web应用程序的根目录是webapps/jspsmartupload,则另存的文件名实际是webapps/jspsmartupload/upload/sample.zipsaveAs("/upload/sample.zip",SAVEAS_AUTO)执行时若Web应用程序根目录下存在upload目录,则其效果同saveAs("/upload/sample.zip",SAVEAS_VIRTUAL),否则同saveAs("/upload/sample.zip",SAVEAS_PHYSICAL)

 

  建议:对于Web程序的开发来说,最好使用SAVEAS_VIRTUAL,以便移植。

 

2isMissing

  作用:这个方法用于判断用户是否选择了文件,也即对应的表单项是否有值。选择了文件时,它返回false。未选文件时,它返回true

  原型:public boolean isMissing()

 

3getFieldName

  作用:取HTML表单中对应于此上传文件的表单项的名字。

  原型:public String getFieldName()

 

4getFileName

   作用:取文件名(不含目录信息)

   原型:public String getFileName()

 

5getFilePathName

   作用:取文件全名(带目录)

   原型:public String getFilePathName

 

6getFileExt

   作用:取文件扩展名(后缀)

   原型:public String getFileExt()

 

7getSize

  作用:取文件长度(以字节计)

  原型:public int getSize()

 

8getBinaryData

  作用:取文件数据中指定位移处的一个字节,用于检测文件等处理。

  原型:public byte getBinaryData(int index)。其中,index表示位移,其值在0getSize()-1之间。

 

 Files

  这个类表示所有上传文件的集合,通过它可以得到上传文件的数目、大小等信息。有以下方法:

 

1getCount

   作用:取得上传文件的数目。

   原型:public int getCount()

 

2getFile

   作用:取得指定位移处的文件对象File(这是com.jspsmart.upload.File,不是java.io.File,注意区分)。

   原型:public File getFile(int index)。其中,index为指定位移,其值在0getCount()-1之间。

 

3getSize

   作用:取得上传文件的总长度,可用于限制一次性上传的数据量大小。

   原型:public long getSize()

 

4getCollection

   作用:将所有上传文件对象以Collection的形式返回,以便其它应用程序引用,浏览上传文件信息。

   原型:public Collection getCollection()

 

5getEnumeration

   作用:将所有上传文件对象以Enumeration(枚举)的形式返回,以便其它应用程序浏览上传文件信息。

     原型:public Enumeration getEnumeration()

 

 Request

  这个类的功能等同于JSP内置的对象request。只所以提供这个类,是因为对于文件上传表单,通过request对象无法获得表单项的值,必须通过jspSmartUpload组件提供的Request对象来获取。该类提供如下方法:

 

1getParameter

   作用:获取指定参数之值。当参数不存在时,返回值为null

     原型:public String getParameter(String name)。其中,name为参数的名字。

 

2getParameterValues

    作用:当一个参数可以有多个值时,用此方法来取其值。它返回的是一个字符串数组。当参数不存在时,返回值为null

  原型:public String[] getParameterValues(String name)。其中,name为参数的名字。

 

3getParameterNames

   作用:取得Request对象中所有参数的名字,用于遍历所有参数。它返回的是一个枚举型的对象。

   原型:public Enumeration getParameterNames()

 

 SmartUpload类这个类完成上传下载工作。

A.上传与下载共用的方法:

   只有一个:initialize

     作用:执行上传下载的初始化工作,必须第一个执行。

     原型:有多个,主要使用下面这个:

        public final void initialize(javax.servlet.jsp.PageContext pageContext)

        其中,pageContextJSP页面内置对象(页面上下文)。

 

 B.上传文件使用的方法:

 

 1upload

   作用:上传文件数据。对于上传操作,第一步执行initialize方法,第二步就要执行这个方法。

     原型:public void upload()

 

2save

    作用:将全部上传文件保存到指定目录下,并返回保存的文件个数。

    原型:public int save(String destPathName) 和 public int save(String destPathName,int option)

    其中,destPathName为文件保存目录,option为保存选项,它有三个值,分别是SAVE_PHYSICAL,SAVE_VIRTUALSAVE_AUTO。(同File类的saveAs方法的选项之值类似)SAVE_PHYSICAL指示组件将文件保存到以操作系统根目录为文件根目录的目录下,SAVE_VIRTUAL指示组件将文件保存到以Web应用程序根目录为文件根目录的目录下,而SAVE_AUTO则表示由组件自动选择。

    注:save(destPathName)作用等同于save(destPathName,SAVE_AUTO)

 

3getSize

    作用:取上传文件数据的总长度

    原型:public int getSize()

 

4getFiles

    作用:取全部上传文件,以Files 对象形式返回,可以利用Files 类的操作方法来获得上传文件的数目等信息。
    原型:public Files getFiles()
5 getRequest

    作用:取得Request对象,以便由此对象获得上传表单参数之值。

    原型:public Request getRequest()

 

6setAllowedFilesList

    作用:设定允许上传带有指定扩展名的文件,当上传过程中有文件名不允许时,组件将抛出异常。

    原型:public void setAllowedFilesList(String allowedFilesList)

    其中,allowedFilesList为允许上传的文件扩展名列表,各个扩展名之间以逗号分隔。如果想允许上传那些没有扩展名的文件,可以用两个逗号表示。例如:setAllowedFilesList("doc,txt,,")将允许上传带doctxt扩展名的文件以及没有扩展名的文件。

 

 7setDeniedFilesList

    作用:用于限制上传那些带有指定扩展名的文件。若有文件扩展名被限制,则上传时组件将抛出异常。

    原型:public void setDeniedFilesList(String deniedFilesList)

   其中,deniedFilesList为禁止上传的文件扩展名列表,各个扩展名之间以逗号分隔。如果想禁止上传那些没有扩展名的文件,可以用两个逗号来表示。例如:setDeniedFilesList("exe,bat,,")将禁止上传带exebat扩展名的文件以及没有扩展名的文件。

 

 8setMaxFileSize

   作用:设定每个文件允许上传的最大长度。

   原型:public void setMaxFileSize(long maxFileSize)

   其中,maxFileSize为为每个文件允许上传的最大长度,当文件超出此长度时,将不被上传。

 

9setTotalMaxFileSize

    作用:设定允许上传的文件的总长度,用于限制一次性上传的数据量大小。

    原型:public void setTotalMaxFileSize(long totalMaxFileSize)

    其中,totalMaxFileSize为允许上传的文件的总长度。

 

C.下载文件常用的方法

 1setContentDisposition

    作用:将数据追加到MIME文件头的CONTENT-DISPOSITION域。jspSmartUpload组件会在返回下载的信息时自动填写MIME文件头的CONTENT-DISPOSITION域,如果用户需要添加额外信息,请用此方法。

    原型:public void setContentDisposition(String contentDisposition)

    其中,contentDisposition为要添加的数据。如果contentDispositionnull,则组件将自动添加"attachment;",以表明将下载的文件作为附件,结果是IE浏览器将会提示另存文件,而不是自动打开这个文件(IE浏览器一般根据下载的文件扩展名决定执行什么操作,扩展名为doc的将用word程序打开,扩展名为pdf的将用acrobat程序打开,等等)。

 

 2downloadFile

    作用:下载文件。

    原型:共有以下三个原型可用,第一个最常用,后两个用于特殊情况下的文件下载(如更改内容类型,更改另存的文件名)。

     public void downloadFile(String sourceFilePathName)

       其中,sourceFilePathName为要下载的文件名(带目录的文件全名)

    public void downloadFile(String sourceFilePathName,String contentType)

       其中,sourceFilePathName为要下载的文件名(带目录的文件全名),contentType为内容类型(MIME格式的文件类型信息,可被浏览器识别)。

    public void downloadFile(String sourceFilePathName,String contentType,String destFileName)

       其中,sourceFilePathName为要下载的文件名(带目录的文件全名),contentType为内容类型(MIME格式的文件类型信息,可被浏览器识别),destFileName为下载后默认的另存文件名。

 

 三、文件上传篇

     表单要求

        对于上传文件的FORM表单,有两个要求:

           1 METHOD 应用POST ,即METHOD="POST"
           2 、增加属性:ENCTYPE="multipart/form-data"

             

 上传的例子

    1、上传页面upload.html本页面提供表单,让用户选择要上传的文件,点击"上传"按钮执行上传操作。

  页面源码如下: 

Html代码   收藏代码
  1. <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>  
  2. <html>  
  3.   <head>  
  4.     <title>随手拍</title>  
  5.     <style>  
  6.         .shuiMing{ color:red; font-size:9pt;}  
  7.     .table{background-color:#c9c9c9;font-size: 9pt; font-style: normal; font-weight: normal;text-decoration: none;}  
  8.     .table td{background-color:#e8e8e8;}  
  9.     </style>  
  10.   </head>  
  11.   <body>  
  12.   <form action="WenJianDaoRoServlet" enctype="multipart/form-data" method="post">  
  13.           <table class="table" width="100%" cellpadding="2" cellspacing="1">  
  14.              <tr>  
  15.                <td align="right" > 证据类型: </td>  
  16.                <td>  
  17.                    <select name="zjlx" id="zjlx">  
  18.                      <option value="1"> 图片 </option>  
  19.                      <option value="2"> 视频 </option>  
  20.                    </select>  
  21.                </td>  
  22.                <td colspan="3">    
  23.                     证据上传: <input name="zhengJu" id="zhengJu" type="File">  
  24.                </td>  
  25.              </tr>  
  26.              <tr>  
  27.                <td colspan="5" align="center">  
  28.                 <input type="submit" name="Button1" value="提交" onClick="return CheckForm();" id="Button1" />  
  29.                     &nbsp;&nbsp;  
  30.                     <input type="reset" />  
  31.                    </td>  
  32.              </tr>      
  33.          </table>  
  34.    </form>  
  35.   </body>  
  36. </html>  

    说名:实现一次上传多个文件可以用多个file表单

              <input name="zhengJu" id="zhengJu" type="File">

              <input name="zhengJu" id="zhengJu" type="File">

              <input name="zhengJu" id="zhengJu" type="File">

              。。。。。。

 

2、上传处理servlet 源码如下:

Html代码   收藏代码
  1. public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException,IOException{  
  2.     request.setCharacterEncoding("UTF-8");  
  3.     //得到jsp页面的pageContext对象  
  4.     JspFactory jsp = JspFactory.getDefaultFactory();  
  5.     PageContext pageContext = jsp.getPageContext(this, request, response, null, true,8192, true);  
  6.     // 新建一个SmartUpload对象  
  7.     SmartUpload su = new SmartUpload();  
  8.     // 上传初始化  
  9.     su.initialize(pageContext);  
  10.     try {  
  11.         //将文件读取到内存中,还没有上传  
  12.         su.upload();      
  13.         //设定每个文件允许上传的最大长度  
  14.         su.setMaxFileSize(1024*1024*5);  
  15.         //设定允许上传的文件的总长度  
  16.         su.setTotalMaxFileSize(1024*1024*5*10);  
  17.         //将所有文件保存到服务器上不相应目录下  
  18.         su.save("/resouse");      
  19.        /////////////////////下面是改变文件名逐个上传的方法//////////////////////////////  
  20.         //得到所有文件  
  21.         //Files myFiles = su.getFiles();  
  22.         //得到文件中的第一个  
  23.         //File file = myFiles.getFile(0);  
  24.         //得到第一个文件的文件名  
  25.         //String name = file.getFileName();  
  26.         //file.getFileExt(),获得文件后缀名  
  27.         //System.currentTimeMillis(),获得系统时间搓  
  28.         //String wenJianMing =  System.currentTimeMillis() + "." + file.getFileExt();  
  29.         //file.saveAs("/resouse/" + wenJianMing);     
  30.     } catch (SmartUploadException e) {  
  31.         e.printStackTrace();  
  32.     }  
  33. }  

 

四、文件下载篇

1、下载链接页面download.html

    页面源码如下:

Html代码   收藏代码
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">  
  2. <html>  
  3.    <head>  
  4.        <title>下载</title>  
  5.        <meta http-equiv="Content-Type" content="text/html; charset=gb2312">  
  6.    </head>  
  7.    <body>  
  8.        <a href="jsp/do_download.jsp">点击下载</a>  
  9.    </body>  
  10. </html>  
 

 

2、下载处理页面do_download.jsp do_download.jsp展示了如何利用jspSmartUpload组件来下载文件,从下面的源码中就可以看到,下载何其简单。

    源码如下:

Html代码   收藏代码
  1. <%@ page contentType="text/html;charset=gb2312" import="com.jspsmart.upload.*" %>  
  2. lt;%  
  3.         // 新建一个SmartUpload对象  
  4.         SmartUpload su = new SmartUpload();  
  5.         // 初始化  
  6.         su.initialize(pageContext);  
  7.         // 设定contentDisposition为null以禁止浏览器自动打开文件,  
  8.         //保证点击链接后是下载文件。若不设定,则下载的文件扩展名为  
  9.         //doc时,浏览器将自动用word打开它。扩展名为pdf时,  
  10.         //浏览器将用acrobat打开。  
  11.         su.setContentDisposition(null);  
  12.         // 下载文件  
  13.         su.downloadFile("/upload/如何赚取我的第一桶金.doc");  
  14. >  

   注意,执行下载的页面,在Java脚本范围外(即<% ... %>之外),不要包含HTML代码、空格、回车或换行等字符,有的话将不能正确下载。不信的话,可以在上述源码中%><%之间加入一个换行符,再下载一下,保证出错。因为它影响了返回给浏览器的数据流,导致解析出错。

 

3、如何下载中文文件

 

   jspSmartUpload虽然能下载文件,但对中文支持不足。若下载的文件名中有汉字,则浏览器在提示另存的文件名时,显示的是一堆乱码,很扫人兴。上面的例子就是这样。(这个问题也是众多下载组件所存在的问题,很少有人解决,搜索不到相关资料,可叹!)

 

    为了给jspSmartUpload组件增加下载中文文件的支持,我对该组件进行了研究,发现对返回给浏览器的另存文件名进行UTF-8编码后,浏览器便能正确显示中文名字了。这是一个令人高兴的发现。于是我对jspSmartUpload组件的SmartUpload类做了升级处理,增加了toUtf8String这个方法,改动部分源码如下:

Java代码   收藏代码
  1. public void downloadFile(String s, String s1, String s2, int i)  
  2.   
  3.          throws ServletException, IOException, SmartUploadException  
  4.   
  5.     {  
  6.          if(s == null)  
  7.              throw new IllegalArgumentException("File '" + s +  "' not found (1040).");  
  8.          if(s.equals(""))  
  9.              throw new IllegalArgumentException("File '" + s + "' not found (1040).");  
  10.          if(!isVirtual(s) && m_denyPhysicalPath)  
  11.              throw new SecurityException("Physical path is denied (1035).");  
  12.          if(isVirtual(s))  
  13.              s = m_application.getRealPath(s);  
  14.          java.io.File file = new java.io.File(s);  
  15.          FileInputStream fileinputstream = new FileInputStream(file);  
  16.          long l = file.length();  
  17.          boolean flag = false;  
  18.          int k = 0;  
  19.          byte abyte0[] = new byte[i];  
  20.          if(s1 == null)  
  21.              m_response.setContentType("application/x-msdownload");  
  22.          else  
  23.          if(s1.length() == 0)  
  24.              m_response.setContentType("application/x-msdownload");  
  25.          else  
  26.              m_response.setContentType(s1);  
  27.          m_response.setContentLength((int)l);  
  28.          m_contentDisposition = m_contentDisposition != null ?  
  29.          m_contentDisposition : "attachment;";  
  30.          if(s2 == null)  
  31.              m_response.setHeader("Content-Disposition",  
  32.              m_contentDisposition + " filename=" +  
  33.              toUtf8String(getFileName(s)));  
  34.          else  
  35.          if(s2.length() == 0)  
  36.              m_response.setHeader("Content-Disposition",  
  37.              m_contentDisposition);  
  38.          else  
  39.              m_response.setHeader("Content-Disposition",  
  40.              m_contentDisposition + " filename=" + toUtf8String(s2));  
  41.          while((long)k < l)  
  42.          {  
  43.              int j = fileinputstream.read(abyte0, 0, i);  
  44.              k += j;  
  45.              m_response.getOutputStream().write(abyte0, 0, j);  
  46.          }  
  47.          fileinputstream.close();  
  48.     }  
  49.   
  50.     /** 
  51.      * 将文件名中的汉字转为UTF8编码的串,以便下载时能正确显示另存的文件名. 
  52.      * @return 重新编码后的文件名 
  53.      */  
  54.   
  55.     public static String toUtf8String(String s) {  
  56.          StringBuffer sb = new StringBuffer();  
  57.          for (int i=0;i<s.length();i++) {  
  58.              char c = s.charAt(i);  
  59.              if (c >= 0 && c <= 255) {  
  60.                    sb.append(c);  
  61.              } else {  
  62.                    byte[] b;  
  63.                    try {  
  64.                        b = Character.toString(c).getBytes("utf-8");  
  65.                    } catch (Exception ex) {  
  66.                        System.out.println(ex);  
  67.                        b = new byte[0];  
  68.                    }  
  69.                    for (int j = 0; j < b.length; j++) {  
  70.                        int k = b[j];  
  71.                        if (k < 0) k += 256;  
  72.                        sb.append("%" + Integer.toHexString(k).  
  73.                        toUpperCase());  
  74.                    }  
  75.              }  
  76.          }  
  77.          return sb.toString();  
  78.     }  

 

  注意源码中粗体部分,原jspSmartUpload组件对返回的文件未作任何处理,现在做了编码的转换工作,将文件名转换为UTF-8形式的编码形式。UTF-8编码对英文未作任何处理,对中文则需要转换为%XX的形式。toUtf8String方法中,直接利用Java语言提供的编码转换方法获得汉字字符的UTF-8编码,之后将其转换为%XX的形式。

 

将源码编译后打包成jspSmartUpload.jar,拷贝到Tomcatshared/lib目录下(可为所有WEB应用程序所共享),然后重启Tomcat服务器就可以正常下载含有中文名字的文件了。另,toUtf8String方法也可用于转换含有中文的超级链接,以保证链接的有效,因为有的WEB服务器不支持中文链接。

 

小结:jspSmartUpload组件是应用JSP进行B/S程序开发过程中经常使用的上传下载组件,它使用简单,方便。现在我又为其加上了下载中文名字的文件的支持,真个是如虎添翼,必将赢得更多开发者的青睐。

你可能感兴趣的:(SmartUpload)