jspSmartUpload是由www.jspsmart.com網(wǎng)站開發(fā)的一個可免費使用的全功能的文件上傳組件,適于嵌入執(zhí)行上傳操作的JSP文件中。該組件有以下幾個特點:
1、使用簡單。在JSP文件中僅僅書寫三五行JAVA代碼就可以搞定文件的上傳或,方便?! ?
2、能全程控制上傳。利用jspSmartUpload組件提供的對象及其操作方法,可以獲得全部上傳文件的信息(包括文件名,大小,類型,擴展名,文件數(shù)據(jù)等),方便存取。
3、能對上傳的文件在大小、類型等方面做出限制。如此可以濾掉不符合要求的文件。
4、靈活。僅寫兩行代碼,就能把Web服務(wù)器變成文件服務(wù)器。不管文件在Web服務(wù)器的目錄下或在其它任何目錄下,都可以利用jspSmartUpload進行。
5、能將文件上傳到數(shù)據(jù)庫中,也能將數(shù)據(jù)庫中的數(shù)據(jù)下來。這種功能針對的是MYSQL數(shù)據(jù)庫,因為不具有通用性,所以本文不準備舉例介紹這種用法。
jspSmartUpload組件可以從www.jspsmart.com網(wǎng)站上自由,壓縮包的名字是jspSmartUpload.zip。后,用WinZip或WinRAR將其解壓到Tomcat的webapps目錄下(本文以Tomcat服務(wù)器為例進行介紹)。解壓后,將webapps/jspsmartupload目錄下的子目錄Web-inf名字改為全大寫的WEB-INF,這樣一改jspSmartUpload類才能使用。因為Tomcat對文件名大小寫敏感,它要求Web應(yīng)用程序相關(guān)的類所在目錄為WEB-INF,且必須是大寫。接著重新啟動Tomcat,這樣就可以在JSP文件中使用jspSmartUpload組件了。
注意,按上述方法安裝后,只有webapps/jspsmartupload目錄下的程序可以使用jspSmartUpload組件,如果想讓Tomcat服務(wù)器的所有Web應(yīng)用程序都能用它,必須做如下工作:
1.進入命令行狀態(tài),將目錄切換到Tomcat的webapps/jspsmartupload/WEB-INF目錄下。
2.運行JAR打包命令:jar cvf jspSmartUpload.jar com
?。ㄒ部梢源蜷_資源管理器,切換到當(dāng)前目錄,用WinZip將com目錄下的所有文件壓縮成jspSmartUpload.zip,然后將jspSmartUpload.zip換名為jspSmartUpload.jar文件即可。)
3.將jspSmartUpload.jar拷貝到Tomcat的shared/lib目錄下。
二、相關(guān)類說明篇
?、?File類
這個類包裝了一個上傳文件的所有信息。通過它,可以得到上傳文件的文件名、文件大小、擴展名、文件數(shù)據(jù)等信息。
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表明以操作系統(tǒng)的根目錄為文件根目錄另存文件,SAVEAS_VIRTUAL表明以Web應(yīng)用程序的根目錄為文件根目錄另存文件,SAVEAS_AUTO則表示讓組件決定,當(dāng)Web應(yīng)用程序的根目錄存在另存文件的目錄時,它會選擇SAVEAS_VIRTUAL,否則會選擇SAVEAS_PHYSICAL。
例如,saveAs("/upload/sample.zip",SAVEAS_PHYSICAL)執(zhí)行后若Web服務(wù)器安裝在C盤,則另存的文件名實際是c:\upload\sample.zip。而saveAs("/upload/sample.zip",SAVEAS_VIRTUAL)執(zhí)行后若Web應(yīng)用程序的根目錄是webapps/jspsmartupload,則另存的文件名實際是webapps/jspsmartupload/upload/sample.zip。saveAs("/upload/sample.zip",SAVEAS_AUTO)執(zhí)行時若Web應(yīng)用程序根目錄下存在upload目錄,則其效果同saveAs("/upload/sample.zip",SAVEAS_VIRTUAL),否則同saveAs("/upload/sample.zip",SAVEAS_PHYSICAL)。
建議:對于Web程序的開發(fā)來說,最好使用SAVEAS_VIRTUAL,以便移植。
2、isMissing
作用:這個方法用于判斷用戶是否選擇了文件,也即對應(yīng)的表單項是否有值。選擇了文件時,它返回false。未選文件時,它返回true。
原型:public boolean isMissing()
3、getFieldName
作用:取HTML表單中對應(yīng)于此上傳文件的表單項的名字。
原型:public String getFieldName()
4、getFileName
作用:取文件名(不含目錄信息)
原型:public String getFileName()
5、getFilePathName
作用:取文件全名(帶目錄)
原型:public String getFilePathName
6、getFileExt
作用:取文件擴展名(后綴)
原型:public String getFileExt()
7、getSize
作用:取文件長度(以字節(jié)計)
原型:public int getSize()
8、getBinaryData
作用:取文件數(shù)據(jù)中指定位移處的一個字節(jié),用于檢測文件等處理?! ?
原型:public byte getBinaryData(int index)。其中,index表示位移,其值在0到getSize()-1之間。
?。ㄎ赐辏?br> ?、?Files類
這個類表示所有上傳文件的集合,通過它可以得到上傳文件的數(shù)目、大小等信息。有以下方法:
1、getCount
作用:取得上傳文件的數(shù)目。
原型:public int getCount()
2、getFile
作用:取得指定位移處的文件對象File(這是com.jspsmart.upload.File,不是java.io.File,注意區(qū)分)。
原型:public File getFile(int index)。其中,index為指定位移,其值在0到getCount()-1之間。
3、getSize
作用:取得上傳文件的總長度,可用于限制一次性上傳的數(shù)據(jù)量大小。
原型:public long getSize()
4、getCollection
作用:將所有上傳文件對象以Collection的形式返回,以便其它應(yīng)用程序引用,瀏覽上傳文件信息。
原型:public Collection getCollection()
5、getEnumeration
作用:將所有上傳文件對象以Enumeration(枚舉)的形式返回,以便其它應(yīng)用程序瀏覽上傳文件信息。
原型:public Enumeration getEnumeration()
㈢ Request類
這個類的功能等同于JSP內(nèi)置的對象request。只所以提供這個類,是因為對于文件上傳表單,通過request對象無法獲得表單項的值,必須通過jspSmartUpload組件提供的Request對象來獲取。該類提供如下方法:
1、getParameter
作用:獲取指定參數(shù)之值。當(dāng)參數(shù)不存在時,返回值為null。
原型:public String getParameter(String name)。其中,name為參數(shù)的名字。
2、getParameterValues
作用:當(dāng)一個參數(shù)可以有多個值時,用此方法來取其值。它返回的是一個字符串?dāng)?shù)組。當(dāng)參數(shù)不存在時,返回值為null。
原型:public String[] getParameterValues(String name)。其中,name為參數(shù)的名字。
3、getParameterNames
作用:取得Request對象中所有參數(shù)的名字,用于遍歷所有參數(shù)。它返回的是一個枚舉型的對象。
原型:public Enumeration getParameterNames()
?、?SmartUpload類這個類完成上傳工作。
A.上傳與共用的方法:
只有一個:initialize。
作用:執(zhí)行上傳的初始化工作,必須第一個執(zhí)行。
原型:有多個,主要使用下面這個:
public final void initialize(javax.servlet.jsp.PageContext pageContext)
其中,pageContext為JSP頁面內(nèi)置對象(頁面上下文)。
B.上傳文件使用的方法:
1、upload
作用:上傳文件數(shù)據(jù)。對于上傳操作,第一步執(zhí)行initialize方法,第二步就要執(zhí)行這個方法。
原型:public void upload()
2、save
作用:將全部上傳文件保存到指定目錄下,并返回保存的文件個數(shù)。
原型:public int save(String destPathName)
和public int save(String destPathName,int option)
其中,destPathName為文件保存目錄,option為保存選項,它有三個值,分別是SAVE_PHYSICAL,SAVE_VIRTUAL和SAVE_AUTO。(同F(xiàn)ile類的saveAs方法的選項之值類似)SAVE_PHYSICAL指示組件將文件保存到以操作系統(tǒng)根目錄為文件根目錄的目錄下,SAVE_VIRTUAL指示組件將文件保存到以Web應(yīng)用程序根目錄為文件根目錄的目錄下,而SAVE_AUTO則表示由組件自動選擇。
注:save(destPathName)作用等同于save(destPathName,SAVE_AUTO)。
3、getSize
作用:取上傳文件數(shù)據(jù)的總長度
原型:public int getSize()
4、getFiles
作用:取全部上傳文件,以Files對象形式返回,可以利用Files類的操作方法來獲得上傳文件的數(shù)目等信息。
原型:public Files getFiles()
5、getRequest
作用:取得Request對象,以便由此對象獲得上傳表單參數(shù)之值。
原型:public Request getRequest()
6、setAllowedFilesList
作用:設(shè)定允許上傳帶有指定擴展名的文件,當(dāng)上傳過程中有文件名不允許時,組件將拋出異常。
原型: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
作用:設(shè)定每個文件允許上傳的最大長度。
原型:public void setMaxFileSize(long maxFileSize)
其中,maxFileSize為為每個文件允許上傳的最大長度,當(dāng)文件超出此長度時,將不被上傳?!?
9、setTotalMaxFileSize
作用:設(shè)定允許上傳的文件的總長度,用于限制一次性上傳的數(shù)據(jù)量大小?! ?
原型:public void setTotalMaxFileSize(long totalMaxFileSize)
其中,totalMaxFileSize為允許上傳的文件的總長度?! ?
C.文件常用的方法
1、setContentDisposition
作用:將數(shù)據(jù)追加到MIME文件頭的CONTENT-DISPOSITION域。jspSmartUpload組件會在返回的信息時自動填寫MIME文件頭的CONTENT-DISPOSITION域,如果用戶需要添加額外信息,請用此方法?!?
原型:public void setContentDisposition(String contentDisposition)
其中,contentDisposition為要添加的數(shù)據(jù)。如果contentDisposition為null,則組件將自動添加"attachment;",以表明將的文件作為附件,結(jié)果是IE瀏覽器將會提示另存文件,而不是自動打開這個文件(IE瀏覽器一般根據(jù)的文件擴展名決定執(zhí)行什么操作,擴展名為doc的將用word程序打開,擴展名為pdf的將用acrobat程序打開,等等)。
2、downloadFile
作用:文件?! ?
原型:共有以下三個原型可用,第一個最常用,后兩個用于特殊情況下的文件(如更改內(nèi)容類型,更改另存的文件名)?! ?
?、?public void downloadFile(String sourceFilePathName)
其中,sourceFilePathName為要的文件名(帶目錄的文件全名)
?、?public void downloadFile(String sourceFilePathName,String contentType)
其中,sourceFilePathName為要的文件名(帶目錄的文件全名),contentType為內(nèi)容類型(MIME格式的文件類型信息,可被瀏覽器識別)?! ?
?、?public void downloadFile(String sourceFilePathName,String contentType,String destFileName)
其中,sourceFilePathName為要的文件名(帶目錄的文件全名),contentType為內(nèi)容類型(MIME格式的文件類型信息,可被瀏覽器識別),destFileName為后默認的另存文件名。(未完)
三、文件上傳篇
?、?表單要求
對于上傳文件的FORM表單,有兩個要求:
1、METHOD應(yīng)用POST,即METHOD="POST"。
2、增加屬性:ENCTYPE="multipart/form-data"
下面是一個用于上傳文件的FORM表單的例子:
㈡ 上傳的例子
1、上傳頁面upload.html
本頁面提供表單,讓用戶選擇要上傳的文件,點擊"上傳"按鈕執(zhí)行上傳操作。
頁面源碼如下:
上傳文件選擇
2、上傳處理頁面do_upload.jsp
本頁面執(zhí)行文件上傳操作。頁面源碼中詳細介紹了上傳方法的用法,在此不贅述了?! ?
頁面源碼如下:
<%@ page contentType="text/html; charset=gb2312" language="java"
import="java.util.*,com.jspsmart.upload.*" errorPage="" %>
<%
// 新建一個SmartUpload對象
SmartUpload su = new SmartUpload();
// 上傳初始化
su.initialize(pageContext);
// 設(shè)定上傳限制
// 1.限制每個上傳文件的最大長度。
// su.setMaxFileSize(10000);
// 2.限制總上傳數(shù)據(jù)的長度。
// su.setTotalMaxFileSize(20000);
// 3.設(shè)定允許上傳的文件(通過擴展名限制),僅允許doc,txt文件。
// su.setAllowedFilesList("doc,txt");
// 4.設(shè)定禁止上傳的文件(通過擴展名限制),禁止上傳帶有exe,bat,
jsp,htm,html擴展名的文件和沒有擴展名的文件。
// su.setDeniedFilesList("exe,bat,jsp,htm,html,,");
// 上傳文件
su.upload();
// 將上傳文件全部保存到指定目錄
int count = su.save("/upload");
out.println(count+"個文件上傳成功!
");
// 利用Request對象獲取參數(shù)之值
out.println("TEST="+su.getRequest().getParameter("TEST")
+"
");
// 逐一提取上傳文件信息,同時可保存文件。
for (int i=0;i
{
com.jspsmart.upload.File file = su.getFiles().getFile(i);
// 若文件不存在則繼續(xù)
if (file.isMissing()) continue;
// 顯示當(dāng)前文件信息
out.println("
表單項名(FieldName) | "
+ file.getFieldName() + " |
文件長度(Size) | " +
file.getSize() + " |
文件名(FileName) | "
+ file.getFileName() + " |
文件擴展名(FileExt) | "
+ file.getFileExt() + " |
文件全名(FilePathName) | "
+ file.getFilePathName() + " |
");
// 將文件另存
// file.saveAs("/upload/" + myFile.getFileName());
// 另存到以WEB應(yīng)用程序的根目錄為文件根目錄的目錄下
// file.saveAs("/upload/" + myFile.getFileName(),
su.SAVE_VIRTUAL);
// 另存到操作系統(tǒng)的根目錄為文件根目錄的目錄下
// file.saveAs("c:\\temp\\" + myFile.getFileName(),
su.SAVE_PHYSICAL);
}
%>
四、文件篇
1、鏈接頁面download.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);
// 設(shè)定contentDisposition為null以禁止瀏覽器自動打開文件,
//保證點擊鏈接后是文件。若不設(shè)定,則的文件擴展名為
//doc時,瀏覽器將自動用word打開它。擴展名為pdf時,
//瀏覽器將用acrobat打開。
su.setContentDisposition(null);
// 文件
su.downloadFile("/upload/如何賺取我的第一桶金.doc");
%>
注意,執(zhí)行的頁面,在Java腳本范圍外(即<% ... %>之外),不要包含HTML代碼、空格、回車或換行等字符,有的話將不能正確。不信的話,可以在上述源碼中%><%之間加入一個換行符,再一下,保證出錯。因為它影響了返回給瀏覽器的數(shù)據(jù)流,導(dǎo)致解析出錯。
(未完)
3、如何中文文件
jspSmartUpload雖然能文件,但對中文支持不足。若的文件名中有漢字,則瀏覽器在提示另存的文件名時,顯示的是一堆亂碼,很掃人興。上面的例子就是這樣。(這個問題也是眾多組件所存在的問題,很少有人解決,搜索不到相關(guān)資料,可嘆?。?
為了給jspSmartUpload組件增加中文文件的支持,我對該組件進行了研究,發(fā)現(xiàn)對返回給瀏覽器的另存文件名進行UTF-8編碼后,瀏覽器便能正確顯示中文名字了。這是一個令人高興的發(fā)現(xiàn)。于是我對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();
}
/**
* 將文件名中的漢字轉(zhuǎn)為UTF8編碼的串,以便時能正確顯示另存的文件名.
* @param s 原文件名
* @return 重新編碼后的文件名
*/
public static String toUtf8String(String s) {
StringBuffer sb = new StringBuffer();
for (int i=0;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組件對返回的文件未作任何處理,現(xiàn)在做了編碼的轉(zhuǎn)換工作,將文件名轉(zhuǎn)換為UTF-8形式的編碼形式。UTF-8編碼對英文未作任何處理,對中文則需要轉(zhuǎn)換為%XX的形式。toUtf8String方法中,直接利用Java語言提供的編碼轉(zhuǎn)換方法獲得漢字字符的UTF-8編碼,之后將其轉(zhuǎn)換為%XX的形式。
將源碼編譯后打包成jspSmartUpload.jar,拷貝到Tomcat的shared/lib目錄下(可為所有WEB應(yīng)用程序所共享),然后重啟Tomcat服務(wù)器就可以正常含有中文名字的文件了。另,toUtf8String方法也可用于轉(zhuǎn)換含有中文的超級鏈接,以保證鏈接的有效,因為有的WEB服務(wù)器不支持中文鏈接。
小結(jié):jspSmartUpload組件是應(yīng)用JSP進行B/S程序開發(fā)過程中經(jīng)常使用的上傳組件,它使用簡單,方便?,F(xiàn)在我又為其加上了中文名字的文件的支持,真?zhèn)€是如虎添翼,必將贏得更多開發(fā)者的青睞。 (完)