林海菁
(江西工业贸易职业技术学院 南昌 330100)
摘 要:用action的stream结果类型实现文件的下载功能,从而有效地解决文件下载的权限控制问题,并根据系统的功能需求完成与下载相关的其它工作。
关键词:Struts框架;授权下载;stream结果类型;文件输入流
一、引言
网站中的文件下载是比较常用的功能,实现起来也很简单,只要有一个关联到相关资源文件的超链接就可以实现下载,不需要编写服务器端代码。然而这样的下载方式虽然易于实现,却难以实施权限控制。例如,我们希望资源对所有人可见,但只有登录用户可以下载,或者下载前需要扣除用户账户积分。对于这样的功能要求,常规的超链接直接关联到资源文件的方式便无法满足需求了,要考虑其它的技术手段。
在Struts框架中,一种可行的方法是用action来处理文件的下载,然后就可以通過登录检查拦截器来控制只有登录用户才能下载资源,或者在action中根据系统需要,在下载前扣除用户账户积分,如果账户积分不足,则不能下载,等等各种需求均可实现。
二、使用action处理文件下载
使用action来处理文件的下载而不是通过超链接直接链接到资源文件,这是实现授权下载的第一步。而通过action来实现文件下载则需要用到action的一种名为stream的result结果类型。这种结果类型可以向客户端提供文件输入流,既可用于文件下载,也可用于动态生成文件。
使用stream结果类型需要在Action类中定义一个返回InputStream的方法,所谓InputStream就是提供给客户端的文件输入流,即被下载文件的入口。返回InputStream的方法可以使用默认的名称getInputStream(),这样可以免去在配置文件中设置参数的麻烦。在getInputStream()方法中,可以调用ServletContext提供getResourceAsStream()方法返回指定文件对应的输入流,具体代码如下:
public InputStream getInputStream(){
String filepath="……";//要下载的文件路径名,可以使用自应用程序根目录开始的绝对路径,例如“/download/work.rar”,其中“download”是位于WebRoot文件夹中的子文件夹。
return ServletActionContext.getServletContext().getResourceAsStream(filepath);
}
这里使用变量filepath表示要下载的文件路径名,可以通过页面传递的参数间接得到要下载的文件名。例如用参数fileId得到页面提交的要下载的文件的资源编号,再调用资源类的有关方法获得这个资源的文件名filename,并根据所在文件夹的位置得到文件路径名filepath,为getInputStream()方法的执行提供必要的信息。
在Action类中定义了getInputStream()方法之后,接下来我们还需要创建具体处理下载任务的action方法。本例就直接使用默认的execute( )方法,并且先不做任何控制,直接在execute( )方法中写上“return SUCCESS;”语句,无条件下载文件。在这个Action类中,我们定义了私有变量fileId和它的setter及getter,用来接收页面传递的资源编号,从而知道是要下载哪个资源。另外还定义了私有属性filename和它的setter及getter,稍后将用它向struts.xml配置文件传递文件名信息。
定义action方法后,在struts.xml中配置action以及action的stream结果类型。当action返回success结果视图时,struts框架会自动调用getInputStream()方法得到指定文件的输入流,向客户端提供指定文件的下载。具体配置代码如下所示:
其中参数“contentDisposition”指定了文件下载的处理方式和保存下载文件的默认文件名。
文件下载的处理方式包括内联(inline)和附件(attachment)两种方式。在不设置的情况下默认是内联方式,浏览器会尝试直接显示文件。假如是浏览器可以打开的文件类型,如图像文件、文本文件等,就会直接把图像或文件内容显示在浏览器窗口。假如是浏览器无法打开的文件类型,如office文档、压缩文件等,就会出现另存为或新建下载任务对话框进行下载。附件方式则会直接出现另存为或新建下载任务对话框进行下载。
除出弹出对话框进行下载,通常我们还希望在对话框中显示默认的文件名,这个文件名通常是要下载的文件的原文件名,因此filename=${filename}就是用来将原文件名设置为下载时的默认文件名。${filename}是取action中变量filename的值,即要下载的文件的原文件名。为了解决配置文件显示${filename}值时出现的中文乱码的问题,可以在getFilename()方法中返回filename的“ISO-8859-1”编码格式的字符串。
至此,使用action下载文件的功能已实现,接下来就可以以此为依托,实现授权控制。
三、下载的授权控制
如果需要对下载权限进行控制,例如未登录用户不能下载,那么可以使用自定义的登录验证拦截器对刚才的下载action进行拦截,假如拦截器发现用户未登录,则显示提示信息并跳转到登录页面而不执行后续的下载action。
如果下载要扣除账户积分,积分不足则不能下载,那么可以在下载的action中比较当前登录用户的账户积分与下载资源所需要花费的积分,如果不足则返回其它结果视图并给出相应的提示信息,只有在账户积分足够的情况下才返回SUCCESS结果视图执行下载。
通常,对于已支付积分下载过的资源,再次下载时可以不用二次扣费。如果这样的话,那么可以用一个数据表记录用户付费下载过的资源,在下载前先查看用户是否为这个资源付过费,如果付过就不再扣积分也不能再查积分是否足够下载了。
还有很多其它的下载控制及相关工作,借助这个action方法,都可以实现,这里就不再赘述了。