一、安装篇
jspSmartUpload 是由 www.jspsmart.com 网站开发的一个可免费使用的全功能的文件上传下载组件,适于嵌入执行上传下载操作的 JSP 文件中。该组件有以下几个特点:
1 、使用简单。在 JSP 文件中仅仅书写三五行 JAVA 代码就可以搞定文件的上传或下载,方便。
2 、能全程控制上传。利用 jspSmartUpload 组件提供的对象及其操作方法,可以获得全部上传文件的信息(包括文件名,大小,类型,扩展名,文件数据等),方便存取。
3 、能对上传的文件在大小、类型等方面做出限制。如此可以滤掉不符合要求的文件。
4 、下载灵活。仅写两行代码,就能把 Web 服务器变成文件服务器。不管文件在 Web 服务器的目录下或在其它任何目录下,都可以利用 jspSmartUpload 进行下载。
5 、能将文件上传到数据库中,也能将数据库中的数据下载下来。这种功能针对的是 MYSQL 数据库,因为不具有通用性,所以本文不准备举例介绍这种用法。
jspSmartUpload 组件可以从 www.jspsmart.com 网站上自由下载,压缩包的名字是 jspSmartUpload.zip 。下载后,用 WinZip 或 WinRAR 将其解压到 Tomcat 的 webapps 目录下(本文以 Tomcat 服务器为例进行介绍)。解压后,将 webapps/jspsmartupload 目录下的子目录 Web-inf 名字改为全大写的 WEB-INF ,这样一改 jspSmartUpload 类才能使用。因为 Tomcat 对文件名大小写敏感,它要求 Web 应用程序相关的类所在目录为 WEB-INF ,且必须是大写。接着重新启动 Tomcat ,这样就可以在 JSP 文件中使用 jspSmartUpload 组件了。
注意,按上述方法安装后,只有 webapps/jspsmartupload 目录下的程序可以使用 jspSmartUpload 组件,如果想让 Tomcat 服务器的所有 Web 应用程序都能用它,必须做如下工作:
1 .进入命令行状态,将目录切换到 Tomcat 的 webapps/jspsmartupload/WEB-INF 目录下。
2 .运行 JAR 打包命令: jar cvf jspSmartUpload.jar com
(也可以打开资源管理器,切换到当前目录,用 WinZip 将 com 目录下的所有文件压缩成 jspSmartUpload.zip ,然后将 jspSmartUpload.zip 换名为 jspSmartUpload.jar 文件即可。)
3 .将 jspSmartUpload.jar 拷贝到 Tomcat 的 shared/lib 目录下。
二、相关类说明篇
㈠ File 类
这个类包装了一个上传文件的所有信息。通过它,可以得到上传文件的文件名、文件大小、扩展名、文件数据等信息。
File 类主要提供以下方法:
1 、 saveAs 作用:将文件换名另存。
原型:
public void saveAs(java.lang.String destFilePathName)
或
public void saveAs(java.lang.String destFilePathName, int optionSaveAs)
其中, destFilePathName 是另存的文件名, optionSaveAs 是另存的选项,该选项有三个值,分别是 SAVEAS_PHYSICAL,SAVEAS_VIRTUAL , SAVEAS_AUTO 。 SAVEAS_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.zip 。 saveAs("/upload/sample.zip",SAVEAS_AUTO) 执行时若 Web 应用程序根目录下存在 upload 目录,则其效果同 saveAs("/upload/sample.zip",SAVEAS_VIRTUAL) ,否则同 saveAs("/upload/sample.zip",SAVEAS_PHYSICAL) 。
建议:对于 Web 程序的开发来说,最好使用 SAVEAS_VIRTUAL ,以便移植。
2 、 isMissing
作用:这个方法用于判断用户是否选择了文件,也即对应的表单项是否有值。选择了文件时,它返回 false 。未选文件时,它返回 true 。
原型: public boolean isMissing()
3 、 getFieldName
作用:取 HTML 表单中对应于此上传文件的表单项的名字。
原型: public String getFieldName()
4 、 getFileName
作用:取文件名(不含目录信息)
原型: public String getFileName()
5 、 getFilePathName
作用:取文件全名(带目录)
原型: public String getFilePathName
6 、 getFileExt
作用:取文件扩展名(后缀)
原型: public String getFileExt()
7 、 getSize
作用:取文件长度(以字节计)
原型: public int getSize()
8 、 getBinaryData
作用:取文件数据中指定位移处的一个字节,用于检测文件等处理。
原型: public byte getBinaryData(int index) 。其中, index 表示位移,其值在 0 到 getSize()-1 之间。
㈡ Files 类
这个类表示所有上传文件的集合,通过它可以得到上传文件的数目、大小等信息。有以下方法:
1 、 getCount
作用:取得上传文件的数目。
原型: public int getCount()
2 、 getFile
作用:取得指定位移处的文件对象 File (这是 com.jspsmart.upload.File ,不是 java.io.File ,注意区分)。
原型: public File getFile(int index) 。其中, index 为指定位移,其值在 0 到 getCount()-1 之间。
3 、 getSize
作用:取得上传文件的总长度,可用于限制一次性上传的数据量大小。
原型: public long getSize()
4 、 getCollection
作用:将所有上传文件对象以 Collection 的形式返回,以便其它应用程序引用,浏览上传文件信息。
原型: public Collection getCollection()
5 、 getEnumeration
作用:将所有上传文件对象以 Enumeration (枚举)的形式返回,以便其它应用程序浏览上传文件信息。
原型: public Enumeration getEnumeration()
㈢ Request 类
这个类的功能等同于 JSP 内置的对象 request 。只所以提供这个类,是因为对于文件上传表单,通过 request 对象无法获得表单项的值,必须通过 jspSmartUpload 组件提供的 Request 对象来获取。该类提供如下方法:
1 、 getParameter
作用:获取指定参数之值。当参数不存在时,返回值为 null 。
原型: public String getParameter(String name) 。其中, name 为参数的名字。
2 、 getParameterValues
作用:当一个参数可以有多个值时,用此方法来取其值。它返回的是一个字符串数组。当参数不存在时,返回值为 null 。
原型: public String[] getParameterValues(String name) 。其中, name 为参数的名字。
3 、 getParameterNames
作用:取得 Request 对象中所有参数的名字,用于遍历所有参数。它返回的是一个枚举型的对象。
原型: public Enumeration getParameterNames()
㈣ SmartUpload 类这个类完成上传下载工作。
A .上传与下载共用的方法:
只有一个: initialize 。
作用:执行上传下载的初始化工作,必须第一个执行。
原型:有多个,主要使用下面这个:
public final void initialize(javax.servlet.jsp.PageContext pageContext)
其中, pageContext 为 JSP 页面内置对象(页面上下文)。
B .上传文件使用的方法:
1 、 upload
作用:上传文件数据。对于上传操作,第一步执行 initialize 方法,第二步就要执行这个方法。
原型: public void upload()
2 、 save
作用:将全部上传文件保存到指定目录下,并返回保存的文件个数。
原型: public int save(String destPathName)
和 public int save(String destPathName,int option)
其中, destPathName 为文件保存目录, option 为保存选项,它有三个值,分别是 SAVE_PHYSICAL,SAVE_VIRTUAL 和 SAVE_AUTO 。(同 File 类的 saveAs 方法的选项之值类似) SAVE_PHYSICAL 指示组件将文件保存到以操作系统根目录为文件根目录的目录下, SAVE_VIRTUAL 指示组件将文件保存到以 Web 应用程序根目录为文件根目录的目录下,而 SAVE_AUTO 则表示由组件自动选择。
注: save(destPathName) 作用等同于 save(destPathName,SAVE_AUTO) 。
3 、 getSize
作用:取上传文件数据的总长度
原型: public int getSize()
4 、 getFiles
作用:取全部上传文件,以 Files 对象形式返回,可以利用 Files 类的操作方法来获得上传文件的数目等信息。
原型: public Files getFiles()
5 、 getRequest
作用:取得 Request 对象,以便由此对象获得上传表单参数之值。
原型: public Request getRequest()
6 、 setAllowedFilesList
作用:设定允许上传带有指定扩展名的文件,当上传过程中有文件名不允许时,组件将抛出异常。
原型: public void setAllowedFilesList(String allowedFilesList)
其中, allowedFilesList 为允许上传的文件扩展名列表,各个扩展名之间以逗号分隔。如果想允许上传那些没有扩展名的文件,可以用两个逗号表示。例如: setAllowedFilesList("doc,txt,,") 将允许上传带 doc 和 txt 扩展名的文件以及没有扩展名的文件。
7 、 setDeniedFilesList
作用:用于限制上传那些带有指定扩展名的文件。若有文件扩展名被限制,则上传时组件将抛出异常。
原型: public void setDeniedFilesList(String deniedFilesList)
其中, deniedFilesList 为禁止上传的文件扩展名列表,各个扩展名之间以逗号分隔。如果想禁止上传那些没有扩展名的文件,可以用两个逗号来表示。例如: setDeniedFilesList("exe,bat,,") 将禁止上传带 exe 和 bat 扩展名的文件以及没有扩展名的文件。
8 、 setMaxFileSize
作用:设定每个文件允许上传的最大长度。
原型: public void setMaxFileSize(long maxFileSize)
其中, maxFileSize 为为每个文件允许上传的最大长度,当文件超出此长度时,将不被上传。
9 、 setTotalMaxFileSize
作用:设定允许上传的文件的总长度,用于限制一次性上传的数据量大小。
原型: public void setTotalMaxFileSize(long totalMaxFileSize)
其中, totalMaxFileSize 为允许上传的文件的总长度。
C .下载文件常用的方法
1 、 setContentDisposition
作用:将数据追加到 MIME 文件头的 CONTENT-DISPOSITION 域。 jspSmartUpload 组件会在返回下载的信息时自动填写 MIME 文件头的 CONTENT-DISPOSITION 域,如果用户需要添加额外信息,请用此方法。
原型: public void setContentDisposition(String contentDisposition)
其中, contentDisposition 为要添加的数据。如果 contentDisposition 为 null ,则组件将自动添加 "attachment;" ,以表明将下载的文件作为附件,结果是 IE 浏览器将会提示另存文件,而不是自动打开这个文件( IE 浏览器一般根据下载的文件扩展名决定执行什么操作,扩展名为 doc 的将用 word 程序打开,扩展名为 pdf 的将用 acrobat 程序打开,等等)。
2 、 downloadFile
作用:下载文件。
原型:共有以下三个原型可用,第一个最常用,后两个用于特殊情况下的文件下载(如更改内容类型,更改另存的文件名)。
① 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"
下面是一个用于上传文件的 FORM 表单的例子:
<FORM METHOD="POST" ENCTYPE="multipart/form-data"
ACTION="/jspSmartUpload/upload.jsp">
<INPUT TYPE="FILE" NAME="MYFILE">
<INPUT TYPE="SUBMIT">
</FORM>
㈡ 上传的例子
1 、上传页面 upload.html
本页面提供表单,让用户选择要上传的文件,点击 " 上传 " 按钮执行上传操作。
页面源码如下:
<!--
文件名: upload.html
作 者:纵横软件制作中心雨亦奇 (zhsoft88@sohu.com)
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title> 文件上传 </title>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
</head>
<body>
<p> </p>
<p align="center"> 上传文件选择 </p>
<FORM METHOD="POST" ACTION="jsp/do_upload.jsp"
ENCTYPE="multipart/form-data">
<input type="hidden" name="TEST" value="good">
<table width="75%" border="1" align="center">
<tr>
<td><div align="center">1 、
<input type="FILE" name="FILE1" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">2 、
<input type="FILE" name="FILE2" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">3 、
<input type="FILE" name="FILE3" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">4 、
<input type="FILE" name="FILE4" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">
<input type="submit" name="Submit" value=" 上传它! ">
</div></td>
</tr>
</table>
</FORM>
</body>
</html>
2 、上传处理页面 do_upload.jsp
本页面执行文件上传操作。页面源码中详细介绍了上传方法的用法,在此不赘述了。
页面源码如下:
<%--
文件名: do_upload.jsp
作 者:纵横软件制作中心雨亦奇 (zhsoft88@sohu.com)
--%>
<%@ page contentType="text/html; charset=gb2312" language="java"
import="java.util.*,com.jspsmart.upload.*" errorPage="" %>
<html>
<head>
<title> 文件上传处理页面 </title>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
</head>
<body>
<%
// 新建一个 SmartUpload 对象
SmartUpload su = new SmartUpload();
// 上传初始化
su.initialize(pageContext);
// 设定上传限制
// 1. 限制每个上传文件的最大长度。
// su.setMaxFileSize(10000);
// 2. 限制总上传数据的长度。
// su.setTotalMaxFileSize(20000);
// 3. 设定允许上传的文件(通过扩展名限制) , 仅允许 doc,txt 文件。
// su.setAllowedFilesList("doc,txt");
// 4. 设定禁止上传的文件(通过扩展名限制) , 禁止上传带有 exe,bat,
jsp,htm,html 扩展名的文件和没有扩展名的文件。
// su.setDeniedFilesList("exe,bat,jsp,htm,html,,");
// 上传文件
su.upload();
// 将上传文件全部保存到指定目录
int count = su.save("/upload");
out.println(count+" 个文件上传成功! <br>");
// 利用 Request 对象获取参数之值
out.println("TEST="+su.getRequest().getParameter("TEST")
+"<BR><BR>");
// 逐一提取上传文件信息,同时可保存文件。
for (int i=0;i<su.getFiles().getCount();i++)
{
com.jspsmart.upload.File file = su.getFiles().getFile(i);
// 若文件不存在则继续
if (file.isMissing()) continue;
// 显示当前文件信息
out.println("<TABLE BORDER=1>");
out.println("<TR><TD> 表单项名( FieldName ) </TD><TD>"
+ file.getFieldName() + "</TD></TR>");
out.println("<TR><TD> 文件长度( Size ) </TD><TD>" +
file.getSize() + "</TD></TR>");
out.println("<TR><TD> 文件名( FileName ) </TD><TD>"
+ file.getFileName() + "</TD></TR>");
out.println("<TR><TD> 文件扩展名( FileExt ) </TD><TD>"
+ file.getFileExt() + "</TD></TR>");
out.println("<TR><TD> 文件全名( FilePathName ) </TD><TD>"
+ file.getFilePathName() + "</TD></TR>");
out.println("</TABLE><BR>");
// 将文件另存
// file.saveAs("/upload/" + myFile.getFileName());
// 另存到以 WEB 应用程序的根目录为文件根目录的目录下
// file.saveAs("/upload/" + myFile.getFileName(),
su.SAVE_VIRTUAL);
// 另存到操作系统的根目录为文件根目录的目录下
// file.saveAs("c://temp//" + myFile.getFileName(),
su.SAVE_PHYSICAL);
}
%>
</body>
</html>
四、文件下载篇
1 、下载链接页面 download.html
页面源码如下:
<!--
文件名: download.html
作 者:纵横软件制作中心雨亦奇 (zhsoft88@sohu.com)
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title> 下载 </title>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
</head>
<body>
<a href="jsp/do_download.jsp"> 点击下载 </a>
</body>
</html>
2 、下载处理页面 do_download.jsp do_download.jsp 展示了如何利用 jspSmartUpload 组件来下载文件,从下面的源码中就可以看到,下载何其简单。
源码如下:
<%@ page contentType="text/html;charset=gb2312"
import="com.jspsmart.upload.*" %><%
// 新建一个 SmartUpload 对象
SmartUpload su = new SmartUpload();
// 初始化
su.initialize(pageContext);
// 设定 contentDisposition 为 null 以禁止浏览器自动打开文件,
// 保证点击链接后是下载文件。若不设定,则下载的文件扩展名为
//doc 时,浏览器将自动用 word 打开它。扩展名为 pdf 时,
// 浏览器将用 acrobat 打开。
su.setContentDisposition(null);
// 下载文件
su.downloadFile("/upload/ 如何赚取我的第一桶金 .doc");
%>
注意,执行下载的页面,在 Java 脚本范围外(即 <% ... %> 之外),不要包含 HTML 代码、空格、回车或换行等字符,有的话将不能正确下载。不信的话,可以在上述源码中 %><% 之间加入一个换行符,再下载一下,保证出错。因为它影响了返回给浏览器的数据流,导致解析出错。
3 、如何下载中文文件
jspSmartUpload 虽然能下载文件,但对中文支持不足。若下载的文件名中有汉字,则浏览器在提示另存的文件名时,显示的是一堆乱码,很扫人兴。上面的例子就是这样。(这个问题也是众多下载组件所存在的问题,很少有人解决,搜索不到相关资料,可叹!)
为了给 jspSmartUpload 组件增加下载中文文件的支持,我对该组件进行了研究,发现对返回给浏览器的另存文件名进行 UTF-8 编码后,浏览器便能正确显示中文名字了。这是一个令人高兴的发现。于是我对 jspSmartUpload 组件的 SmartUpload 类做了升级处理,增加了 toUtf8String 这个方法,改动部分源码如下:
public void downloadFile(String s, String s1, String s2, int i)
throws ServletException, IOException, SmartUploadException
{
if(s == null)
throw new IllegalArgumentException("File '" + s +
"' not found (1040).");
if(s.equals(""))
throw new IllegalArgumentException("File '" + s +
"' not found (1040).");
if(!isVirtual(s) && m_denyPhysicalPath)
throw new SecurityException("Physical path is
denied (1035).");
if(isVirtual(s))
s = m_application.getRealPath(s);
java.io.File file = new java.io.File(s);
FileInputStream fileinputstream = new FileInputStream(file);
long l = file.length();
boolean flag = false;
int k = 0;
byte abyte0[] = new byte[i];
if(s1 == null)
m_response.setContentType("application/x-msdownload");
else
if(s1.length() == 0)
m_response.setContentType("application/x-msdownload");
else
m_response.setContentType(s1);
m_response.setContentLength((int)l);
m_contentDisposition = m_contentDisposition != null ?
m_contentDisposition : "attachment;";
if(s2 == null)
m_response.setHeader("Content-Disposition",
m_contentDisposition + " filename=" +
toUtf8String(getFileName(s)));
else
if(s2.length() == 0)
m_response.setHeader("Content-Disposition",
m_contentDisposition);
else
m_response.setHeader("Content-Disposition",
m_contentDisposition + " filename=" + toUtf8String(s2));
while((long)k < l)
{
int j = fileinputstream.read(abyte0, 0, i);
k += j;
m_response.getOutputStream().write(abyte0, 0, j);
}
fileinputstream.close();
}
/**
* 将文件名中的汉字转为 UTF8 编码的串 , 以便下载时能正确显示另存的文件名 .
* 纵横软件制作中心雨亦奇 2003.08.01
* @param s 原文件名
* @return 重新编码后的文件名
*/
public static String toUtf8String(String s) {
StringBuffer sb = new StringBuffer();
for (int i=0;i<s.length();i++) {
char c = s.charAt(i);
if (c >= 0 && c <= 255) {
sb.append(c);
} else {
byte[] b;
try {
b = Character.toString(c).getBytes("utf-8");
} catch (Exception ex) {
System.out.println(ex);
b = new byte[0];
}
for (int j = 0; j < b.length; j++) {
int k = b[j];
if (k < 0) k += 256;
sb.append("%" + Integer.toHexString(k).
toUpperCase());
}
}
}
return sb.toString();
}
注意源码中粗体部分,原 jspSmartUpload 组件对返回的文件未作任何处理,现在做了编码的转换工作,将文件名转换为 UTF-8 形式的编码形式。 UTF-8 编码对英文未作任何处理,对中文则需要转换为 %XX 的形式。 toUtf8String 方法中,直接利用 Java 语言提供的编码转换方法获得汉字字符的 UTF-8 编码,之后将其转换为 %XX 的形式。
将源码编译后打包成 jspSmartUpload.jar ,拷贝到 Tomcat 的 shared/lib 目录下(可为所有 WEB 应用程序所共享),然后重启 Tomcat 服务器就可以正常下载含有中文名字的文件了。另, toUtf8String 方法也可用于转换含有中文的超级链接,以保证链接的有效,因为有的 WEB 服务器不支持中文链接。
小结: jspSmartUpload 组件是应用 JSP 进行 B/S 程序开发过程中经常使用的上传下载组件,它使用简单,方便。现在我又为其加上了下载中文名字的文件的支持,真个是如虎添翼,必将赢得更多开发者的青睐。
jspSmartUpload 是由 www.jspsmart.com 网站开发的一个可免费使用的全功能的文件上传下载组件,适于嵌入执行上传下载操作的 JSP 文件中。该组件有以下几个特点:
1 、使用简单。在 JSP 文件中仅仅书写三五行 JAVA 代码就可以搞定文件的上传或下载,方便。
2 、能全程控制上传。利用 jspSmartUpload 组件提供的对象及其操作方法,可以获得全部上传文件的信息(包括文件名,大小,类型,扩展名,文件数据等),方便存取。
3 、能对上传的文件在大小、类型等方面做出限制。如此可以滤掉不符合要求的文件。
4 、下载灵活。仅写两行代码,就能把 Web 服务器变成文件服务器。不管文件在 Web 服务器的目录下或在其它任何目录下,都可以利用 jspSmartUpload 进行下载。
5 、能将文件上传到数据库中,也能将数据库中的数据下载下来。这种功能针对的是 MYSQL 数据库,因为不具有通用性,所以本文不准备举例介绍这种用法。
jspSmartUpload 组件可以从 www.jspsmart.com 网站上自由下载,压缩包的名字是 jspSmartUpload.zip 。下载后,用 WinZip 或 WinRAR 将其解压到 Tomcat 的 webapps 目录下(本文以 Tomcat 服务器为例进行介绍)。解压后,将 webapps/jspsmartupload 目录下的子目录 Web-inf 名字改为全大写的 WEB-INF ,这样一改 jspSmartUpload 类才能使用。因为 Tomcat 对文件名大小写敏感,它要求 Web 应用程序相关的类所在目录为 WEB-INF ,且必须是大写。接着重新启动 Tomcat ,这样就可以在 JSP 文件中使用 jspSmartUpload 组件了。
注意,按上述方法安装后,只有 webapps/jspsmartupload 目录下的程序可以使用 jspSmartUpload 组件,如果想让 Tomcat 服务器的所有 Web 应用程序都能用它,必须做如下工作:
1 .进入命令行状态,将目录切换到 Tomcat 的 webapps/jspsmartupload/WEB-INF 目录下。
2 .运行 JAR 打包命令: jar cvf jspSmartUpload.jar com
(也可以打开资源管理器,切换到当前目录,用 WinZip 将 com 目录下的所有文件压缩成 jspSmartUpload.zip ,然后将 jspSmartUpload.zip 换名为 jspSmartUpload.jar 文件即可。)
3 .将 jspSmartUpload.jar 拷贝到 Tomcat 的 shared/lib 目录下。
二、相关类说明篇
㈠ File 类
这个类包装了一个上传文件的所有信息。通过它,可以得到上传文件的文件名、文件大小、扩展名、文件数据等信息。
File 类主要提供以下方法:
1 、 saveAs 作用:将文件换名另存。
原型:
public void saveAs(java.lang.String destFilePathName)
或
public void saveAs(java.lang.String destFilePathName, int optionSaveAs)
其中, destFilePathName 是另存的文件名, optionSaveAs 是另存的选项,该选项有三个值,分别是 SAVEAS_PHYSICAL,SAVEAS_VIRTUAL , SAVEAS_AUTO 。 SAVEAS_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.zip 。 saveAs("/upload/sample.zip",SAVEAS_AUTO) 执行时若 Web 应用程序根目录下存在 upload 目录,则其效果同 saveAs("/upload/sample.zip",SAVEAS_VIRTUAL) ,否则同 saveAs("/upload/sample.zip",SAVEAS_PHYSICAL) 。
建议:对于 Web 程序的开发来说,最好使用 SAVEAS_VIRTUAL ,以便移植。
2 、 isMissing
作用:这个方法用于判断用户是否选择了文件,也即对应的表单项是否有值。选择了文件时,它返回 false 。未选文件时,它返回 true 。
原型: public boolean isMissing()
3 、 getFieldName
作用:取 HTML 表单中对应于此上传文件的表单项的名字。
原型: public String getFieldName()
4 、 getFileName
作用:取文件名(不含目录信息)
原型: public String getFileName()
5 、 getFilePathName
作用:取文件全名(带目录)
原型: public String getFilePathName
6 、 getFileExt
作用:取文件扩展名(后缀)
原型: public String getFileExt()
7 、 getSize
作用:取文件长度(以字节计)
原型: public int getSize()
8 、 getBinaryData
作用:取文件数据中指定位移处的一个字节,用于检测文件等处理。
原型: public byte getBinaryData(int index) 。其中, index 表示位移,其值在 0 到 getSize()-1 之间。
㈡ Files 类
这个类表示所有上传文件的集合,通过它可以得到上传文件的数目、大小等信息。有以下方法:
1 、 getCount
作用:取得上传文件的数目。
原型: public int getCount()
2 、 getFile
作用:取得指定位移处的文件对象 File (这是 com.jspsmart.upload.File ,不是 java.io.File ,注意区分)。
原型: public File getFile(int index) 。其中, index 为指定位移,其值在 0 到 getCount()-1 之间。
3 、 getSize
作用:取得上传文件的总长度,可用于限制一次性上传的数据量大小。
原型: public long getSize()
4 、 getCollection
作用:将所有上传文件对象以 Collection 的形式返回,以便其它应用程序引用,浏览上传文件信息。
原型: public Collection getCollection()
5 、 getEnumeration
作用:将所有上传文件对象以 Enumeration (枚举)的形式返回,以便其它应用程序浏览上传文件信息。
原型: public Enumeration getEnumeration()
㈢ Request 类
这个类的功能等同于 JSP 内置的对象 request 。只所以提供这个类,是因为对于文件上传表单,通过 request 对象无法获得表单项的值,必须通过 jspSmartUpload 组件提供的 Request 对象来获取。该类提供如下方法:
1 、 getParameter
作用:获取指定参数之值。当参数不存在时,返回值为 null 。
原型: public String getParameter(String name) 。其中, name 为参数的名字。
2 、 getParameterValues
作用:当一个参数可以有多个值时,用此方法来取其值。它返回的是一个字符串数组。当参数不存在时,返回值为 null 。
原型: public String[] getParameterValues(String name) 。其中, name 为参数的名字。
3 、 getParameterNames
作用:取得 Request 对象中所有参数的名字,用于遍历所有参数。它返回的是一个枚举型的对象。
原型: public Enumeration getParameterNames()
㈣ SmartUpload 类这个类完成上传下载工作。
A .上传与下载共用的方法:
只有一个: initialize 。
作用:执行上传下载的初始化工作,必须第一个执行。
原型:有多个,主要使用下面这个:
public final void initialize(javax.servlet.jsp.PageContext pageContext)
其中, pageContext 为 JSP 页面内置对象(页面上下文)。
B .上传文件使用的方法:
1 、 upload
作用:上传文件数据。对于上传操作,第一步执行 initialize 方法,第二步就要执行这个方法。
原型: public void upload()
2 、 save
作用:将全部上传文件保存到指定目录下,并返回保存的文件个数。
原型: public int save(String destPathName)
和 public int save(String destPathName,int option)
其中, destPathName 为文件保存目录, option 为保存选项,它有三个值,分别是 SAVE_PHYSICAL,SAVE_VIRTUAL 和 SAVE_AUTO 。(同 File 类的 saveAs 方法的选项之值类似) SAVE_PHYSICAL 指示组件将文件保存到以操作系统根目录为文件根目录的目录下, SAVE_VIRTUAL 指示组件将文件保存到以 Web 应用程序根目录为文件根目录的目录下,而 SAVE_AUTO 则表示由组件自动选择。
注: save(destPathName) 作用等同于 save(destPathName,SAVE_AUTO) 。
3 、 getSize
作用:取上传文件数据的总长度
原型: public int getSize()
4 、 getFiles
作用:取全部上传文件,以 Files 对象形式返回,可以利用 Files 类的操作方法来获得上传文件的数目等信息。
原型: public Files getFiles()
5 、 getRequest
作用:取得 Request 对象,以便由此对象获得上传表单参数之值。
原型: public Request getRequest()
6 、 setAllowedFilesList
作用:设定允许上传带有指定扩展名的文件,当上传过程中有文件名不允许时,组件将抛出异常。
原型: public void setAllowedFilesList(String allowedFilesList)
其中, allowedFilesList 为允许上传的文件扩展名列表,各个扩展名之间以逗号分隔。如果想允许上传那些没有扩展名的文件,可以用两个逗号表示。例如: setAllowedFilesList("doc,txt,,") 将允许上传带 doc 和 txt 扩展名的文件以及没有扩展名的文件。
7 、 setDeniedFilesList
作用:用于限制上传那些带有指定扩展名的文件。若有文件扩展名被限制,则上传时组件将抛出异常。
原型: public void setDeniedFilesList(String deniedFilesList)
其中, deniedFilesList 为禁止上传的文件扩展名列表,各个扩展名之间以逗号分隔。如果想禁止上传那些没有扩展名的文件,可以用两个逗号来表示。例如: setDeniedFilesList("exe,bat,,") 将禁止上传带 exe 和 bat 扩展名的文件以及没有扩展名的文件。
8 、 setMaxFileSize
作用:设定每个文件允许上传的最大长度。
原型: public void setMaxFileSize(long maxFileSize)
其中, maxFileSize 为为每个文件允许上传的最大长度,当文件超出此长度时,将不被上传。
9 、 setTotalMaxFileSize
作用:设定允许上传的文件的总长度,用于限制一次性上传的数据量大小。
原型: public void setTotalMaxFileSize(long totalMaxFileSize)
其中, totalMaxFileSize 为允许上传的文件的总长度。
C .下载文件常用的方法
1 、 setContentDisposition
作用:将数据追加到 MIME 文件头的 CONTENT-DISPOSITION 域。 jspSmartUpload 组件会在返回下载的信息时自动填写 MIME 文件头的 CONTENT-DISPOSITION 域,如果用户需要添加额外信息,请用此方法。
原型: public void setContentDisposition(String contentDisposition)
其中, contentDisposition 为要添加的数据。如果 contentDisposition 为 null ,则组件将自动添加 "attachment;" ,以表明将下载的文件作为附件,结果是 IE 浏览器将会提示另存文件,而不是自动打开这个文件( IE 浏览器一般根据下载的文件扩展名决定执行什么操作,扩展名为 doc 的将用 word 程序打开,扩展名为 pdf 的将用 acrobat 程序打开,等等)。
2 、 downloadFile
作用:下载文件。
原型:共有以下三个原型可用,第一个最常用,后两个用于特殊情况下的文件下载(如更改内容类型,更改另存的文件名)。
① 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"
下面是一个用于上传文件的 FORM 表单的例子:
<FORM METHOD="POST" ENCTYPE="multipart/form-data"
ACTION="/jspSmartUpload/upload.jsp">
<INPUT TYPE="FILE" NAME="MYFILE">
<INPUT TYPE="SUBMIT">
</FORM>
㈡ 上传的例子
1 、上传页面 upload.html
本页面提供表单,让用户选择要上传的文件,点击 " 上传 " 按钮执行上传操作。
页面源码如下:
<!--
文件名: upload.html
作 者:纵横软件制作中心雨亦奇 (zhsoft88@sohu.com)
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title> 文件上传 </title>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
</head>
<body>
<p> </p>
<p align="center"> 上传文件选择 </p>
<FORM METHOD="POST" ACTION="jsp/do_upload.jsp"
ENCTYPE="multipart/form-data">
<input type="hidden" name="TEST" value="good">
<table width="75%" border="1" align="center">
<tr>
<td><div align="center">1 、
<input type="FILE" name="FILE1" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">2 、
<input type="FILE" name="FILE2" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">3 、
<input type="FILE" name="FILE3" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">4 、
<input type="FILE" name="FILE4" size="30">
</div></td>
</tr>
<tr>
<td><div align="center">
<input type="submit" name="Submit" value=" 上传它! ">
</div></td>
</tr>
</table>
</FORM>
</body>
</html>
2 、上传处理页面 do_upload.jsp
本页面执行文件上传操作。页面源码中详细介绍了上传方法的用法,在此不赘述了。
页面源码如下:
<%--
文件名: do_upload.jsp
作 者:纵横软件制作中心雨亦奇 (zhsoft88@sohu.com)
--%>
<%@ page contentType="text/html; charset=gb2312" language="java"
import="java.util.*,com.jspsmart.upload.*" errorPage="" %>
<html>
<head>
<title> 文件上传处理页面 </title>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
</head>
<body>
<%
// 新建一个 SmartUpload 对象
SmartUpload su = new SmartUpload();
// 上传初始化
su.initialize(pageContext);
// 设定上传限制
// 1. 限制每个上传文件的最大长度。
// su.setMaxFileSize(10000);
// 2. 限制总上传数据的长度。
// su.setTotalMaxFileSize(20000);
// 3. 设定允许上传的文件(通过扩展名限制) , 仅允许 doc,txt 文件。
// su.setAllowedFilesList("doc,txt");
// 4. 设定禁止上传的文件(通过扩展名限制) , 禁止上传带有 exe,bat,
jsp,htm,html 扩展名的文件和没有扩展名的文件。
// su.setDeniedFilesList("exe,bat,jsp,htm,html,,");
// 上传文件
su.upload();
// 将上传文件全部保存到指定目录
int count = su.save("/upload");
out.println(count+" 个文件上传成功! <br>");
// 利用 Request 对象获取参数之值
out.println("TEST="+su.getRequest().getParameter("TEST")
+"<BR><BR>");
// 逐一提取上传文件信息,同时可保存文件。
for (int i=0;i<su.getFiles().getCount();i++)
{
com.jspsmart.upload.File file = su.getFiles().getFile(i);
// 若文件不存在则继续
if (file.isMissing()) continue;
// 显示当前文件信息
out.println("<TABLE BORDER=1>");
out.println("<TR><TD> 表单项名( FieldName ) </TD><TD>"
+ file.getFieldName() + "</TD></TR>");
out.println("<TR><TD> 文件长度( Size ) </TD><TD>" +
file.getSize() + "</TD></TR>");
out.println("<TR><TD> 文件名( FileName ) </TD><TD>"
+ file.getFileName() + "</TD></TR>");
out.println("<TR><TD> 文件扩展名( FileExt ) </TD><TD>"
+ file.getFileExt() + "</TD></TR>");
out.println("<TR><TD> 文件全名( FilePathName ) </TD><TD>"
+ file.getFilePathName() + "</TD></TR>");
out.println("</TABLE><BR>");
// 将文件另存
// file.saveAs("/upload/" + myFile.getFileName());
// 另存到以 WEB 应用程序的根目录为文件根目录的目录下
// file.saveAs("/upload/" + myFile.getFileName(),
su.SAVE_VIRTUAL);
// 另存到操作系统的根目录为文件根目录的目录下
// file.saveAs("c://temp//" + myFile.getFileName(),
su.SAVE_PHYSICAL);
}
%>
</body>
</html>
四、文件下载篇
1 、下载链接页面 download.html
页面源码如下:
<!--
文件名: download.html
作 者:纵横软件制作中心雨亦奇 (zhsoft88@sohu.com)
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title> 下载 </title>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
</head>
<body>
<a href="jsp/do_download.jsp"> 点击下载 </a>
</body>
</html>
2 、下载处理页面 do_download.jsp do_download.jsp 展示了如何利用 jspSmartUpload 组件来下载文件,从下面的源码中就可以看到,下载何其简单。
源码如下:
<%@ page contentType="text/html;charset=gb2312"
import="com.jspsmart.upload.*" %><%
// 新建一个 SmartUpload 对象
SmartUpload su = new SmartUpload();
// 初始化
su.initialize(pageContext);
// 设定 contentDisposition 为 null 以禁止浏览器自动打开文件,
// 保证点击链接后是下载文件。若不设定,则下载的文件扩展名为
//doc 时,浏览器将自动用 word 打开它。扩展名为 pdf 时,
// 浏览器将用 acrobat 打开。
su.setContentDisposition(null);
// 下载文件
su.downloadFile("/upload/ 如何赚取我的第一桶金 .doc");
%>
注意,执行下载的页面,在 Java 脚本范围外(即 <% ... %> 之外),不要包含 HTML 代码、空格、回车或换行等字符,有的话将不能正确下载。不信的话,可以在上述源码中 %><% 之间加入一个换行符,再下载一下,保证出错。因为它影响了返回给浏览器的数据流,导致解析出错。
3 、如何下载中文文件
jspSmartUpload 虽然能下载文件,但对中文支持不足。若下载的文件名中有汉字,则浏览器在提示另存的文件名时,显示的是一堆乱码,很扫人兴。上面的例子就是这样。(这个问题也是众多下载组件所存在的问题,很少有人解决,搜索不到相关资料,可叹!)
为了给 jspSmartUpload 组件增加下载中文文件的支持,我对该组件进行了研究,发现对返回给浏览器的另存文件名进行 UTF-8 编码后,浏览器便能正确显示中文名字了。这是一个令人高兴的发现。于是我对 jspSmartUpload 组件的 SmartUpload 类做了升级处理,增加了 toUtf8String 这个方法,改动部分源码如下:
public void downloadFile(String s, String s1, String s2, int i)
throws ServletException, IOException, SmartUploadException
{
if(s == null)
throw new IllegalArgumentException("File '" + s +
"' not found (1040).");
if(s.equals(""))
throw new IllegalArgumentException("File '" + s +
"' not found (1040).");
if(!isVirtual(s) && m_denyPhysicalPath)
throw new SecurityException("Physical path is
denied (1035).");
if(isVirtual(s))
s = m_application.getRealPath(s);
java.io.File file = new java.io.File(s);
FileInputStream fileinputstream = new FileInputStream(file);
long l = file.length();
boolean flag = false;
int k = 0;
byte abyte0[] = new byte[i];
if(s1 == null)
m_response.setContentType("application/x-msdownload");
else
if(s1.length() == 0)
m_response.setContentType("application/x-msdownload");
else
m_response.setContentType(s1);
m_response.setContentLength((int)l);
m_contentDisposition = m_contentDisposition != null ?
m_contentDisposition : "attachment;";
if(s2 == null)
m_response.setHeader("Content-Disposition",
m_contentDisposition + " filename=" +
toUtf8String(getFileName(s)));
else
if(s2.length() == 0)
m_response.setHeader("Content-Disposition",
m_contentDisposition);
else
m_response.setHeader("Content-Disposition",
m_contentDisposition + " filename=" + toUtf8String(s2));
while((long)k < l)
{
int j = fileinputstream.read(abyte0, 0, i);
k += j;
m_response.getOutputStream().write(abyte0, 0, j);
}
fileinputstream.close();
}
/**
* 将文件名中的汉字转为 UTF8 编码的串 , 以便下载时能正确显示另存的文件名 .
* 纵横软件制作中心雨亦奇 2003.08.01
* @param s 原文件名
* @return 重新编码后的文件名
*/
public static String toUtf8String(String s) {
StringBuffer sb = new StringBuffer();
for (int i=0;i<s.length();i++) {
char c = s.charAt(i);
if (c >= 0 && c <= 255) {
sb.append(c);
} else {
byte[] b;
try {
b = Character.toString(c).getBytes("utf-8");
} catch (Exception ex) {
System.out.println(ex);
b = new byte[0];
}
for (int j = 0; j < b.length; j++) {
int k = b[j];
if (k < 0) k += 256;
sb.append("%" + Integer.toHexString(k).
toUpperCase());
}
}
}
return sb.toString();
}
注意源码中粗体部分,原 jspSmartUpload 组件对返回的文件未作任何处理,现在做了编码的转换工作,将文件名转换为 UTF-8 形式的编码形式。 UTF-8 编码对英文未作任何处理,对中文则需要转换为 %XX 的形式。 toUtf8String 方法中,直接利用 Java 语言提供的编码转换方法获得汉字字符的 UTF-8 编码,之后将其转换为 %XX 的形式。
将源码编译后打包成 jspSmartUpload.jar ,拷贝到 Tomcat 的 shared/lib 目录下(可为所有 WEB 应用程序所共享),然后重启 Tomcat 服务器就可以正常下载含有中文名字的文件了。另, toUtf8String 方法也可用于转换含有中文的超级链接,以保证链接的有效,因为有的 WEB 服务器不支持中文链接。
小结: jspSmartUpload 组件是应用 JSP 进行 B/S 程序开发过程中经常使用的上传下载组件,它使用简单,方便。现在我又为其加上了下载中文名字的文件的支持,真个是如虎添翼,必将赢得更多开发者的青睐。