JspSmartUpload文档使用说明

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:/uploadsample.zip

。

而

saveAs("/upload/sample.zip",SAVEAS_VIRTUAL)

执行后若

Web

应用程序的根目录是

webapps/
JS

Psmartupload

，则另存的文件名实际是

webapps/Psm
JS

artupload/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

.
JS

Psmart.upload.File

，不是

JAV
A

.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

类　　这个类的功能等同于

JS
P

内置的对象

Request

。只所以提供这个类，是因为对于文件上传
表单
，通过

Request


对象无法获得
表单

项的值，必须通过

JS
PSmartUpload

组件提供的

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(
JAVA

x.
servlet

.
JS

P.PageContext pageContext)

其中，

pageContext

为

JS

P

页面内置对象（页面上下文）。

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

、

get
Request


作用：取得

Request


对象，以便由此对象获得上传
表单

参数之值。

原型：

public
Request

get
Request

()

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

为允许上传的文件的总长度