smartupload 中文api幫助2007-11-02 16:18㈠ 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之間。
㈡ 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為下載后默認(rèn)的另存文件名。