为Struts2 应用程序创建进度条(等待页面)

     

     对于一些需要较长时间才能完成的任务,在Web开发中,会由HTTP协议会因为超时而断开而面临许多风险,这是在桌面开发不曾遇到的。Struts 2提供的execAndWait拦截器就是为了处理和应付这种情况而设计的。注意,该拦截器不在"defaultStack"中,所以必须在使用它的动作里声明它,并且必须放在拦截器栈的最后一个。
      使用了该拦截器后,动作依然正常执行,只是该拦截器会分配一个后台线程处理动作的运行,并在动作完成之前把用户带到一个"等待"页面。,该页面每隔一段时间刷新一次,直到那个后台线程执行完毕为止。如果用户随后又触发了同一个动作,但顶一个动作尚未执行完毕,这个拦截器将继续向用户发送"等待"结果;如果他已经执行完毕,用户会看到该动作的最终结果。
      "等待"结果的行为与"dispatcher"结果的行为很相似,但是要注意的是,"等待"结果对应的视图带有如下的meta标签:
<meta http-equiv="refresh" content="5;url=/Struts2/default_progressbar.action"/>
该标签的作用就每隔多少秒就重新加载一次同样的URL。这里"5"表示5秒,"url=/Struts2/default_progressbar.action"表示要加载的URL。
   Struts 2是一个灵活强大的框架,如果你不喜欢Struts 2提供的默认"等待页面",你也可以自己设计自己的等待页面,若在动作声明中,没有找到"等待"结果,将使用默认值。

execAndWait拦截器
execAndWait拦截器 可以接收以下参数:
  • threadPriority:分配给相关线程的优先级,默认值为Thread.NORM_PRIORITY。
  • delay:向用户发送"等待"结果前的毫秒数,默认值为0。如果你不想立刻发送"等待"结果,可以将该参数设置为一个值。例如,你想让动作超过2秒还未完成时才发送"等待"结果,需要将其值设置为2000.
  • delaySleepInterval:每隔多少毫秒唤醒主线程(处理动作的后台线程)去检查后台线程是否已经处理完成,默认值是100。这个值设为0时无效。

模拟长时间运行的Action

      为了示例,首先来模拟一个运行时间长的Action:在这个Action中首先定义了一个int类型的progress属性及其getter/setter,用来向外界返回当前任务的完成进度。在execute方法中,让Action所在的线程在每次循环的时候sleep一秒钟,每次循环把进度加十。

这样,随着外界不断访问progress属性,就可以知道当前任务运行的进度了。示例代码如下:

 

java代码:
查看 复制到剪贴板 打印
  1. public class WaitAction extends ActionSupport{  
  2.     /** 
  3.      * 准备向等待页面返回工作的进度 
  4.      */  
  5.     private int progress;  
  6.     public int getProgress() {  
  7.         return progress;  
  8.     }  
  9.     public void setProgress(int progress) {  
  10.         this.progress = progress;  
  11.     }  
  12.       
  13.     public String execute() throws Exception {  
  14.         //循环十次,每次线程睡1秒,且进度加10  
  15.         for (int i=0;i<10;i++){  
  16.             Thread.sleep(1000L);  
  17.             progress += 10;  
  18.         }  
  19.         return SUCCESS;  
  20.     }  
  21. }  

19.2.2配置Action

       首先,在配置Action的时候,要让这个Action引用execAndWait拦截器,而且,这个拦截器会中止声明在它以后的拦截器的执行,因此这个拦截器的引用要出现在defaultStack拦截器栈之后。

       其次,还要为这个Action声明一个名称为wait的Result,由它来指定具体的等待页面。示例代码如下:

 

java代码:
查看 复制到剪贴板 打印
  1. <package name="helloworld" extends="struts-default">  
  2.     <action name="waitAction" class="cn.javass.wait.WaitAction">  
  3.         <interceptor-ref name="defaultStack"/>  
  4.         <interceptor-ref name="execAndWait"/>  
  5.         <result>/wait/success.jsp</result>  
  6.         <result name="wait">/wait/wait.jsp</result>  
  7.     </action>  
  8. </package>  

19.2.3实现“进度条”页面

       由于HTTP页面在显示之后,不会再与服务器交互,所以,要不断的刷新这个“进度条”页面才行。

可以简单的使用<html>标签中的<meta>标签来设置这个页面不断进行自我刷新。示例代码如下:

 

java代码:
查看 复制到剪贴板 打印
  1. <%@ page language="java" contentType="text/html; charset=gb2312"  
  2.     pageEncoding="gb2312"%>  
  3. <%@taglib prefix="s" uri="/struts-tags" %>  
  4. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"  
  5.  "http://www.w3.org/TR/html4/loose.dtd">  
  6. <html>  
  7. <head>  
  8. <meta http-equiv="Content-Type" content="text/html; charset=gb2312">  
  9. <meta http-equiv="refresh" content="2;url=/helloworld/waitAction.action">  
  10. <title>Insert title here</title>  
  11. </head>  
  12. <body>  
  13.     您好,任务还未完成,已经运行到了任务的<s:property value="progress"/>%  
  14. </body>  
  15. </html>  

       <meta http-equiv="refresh" content="2;url=/helloworld/waitAction.action">这句话代表了当前页面会在显示2秒之后访问” /helloworld/waitAction.action”这个URL。由于wait.jsp就是从这个Action中跳转出来的,所以就相当于每隔2秒就刷新一次wait.jsp页面。同样可以通过<s:property/>标签访问值栈。

19.2.4实现完成页面

       实现一个完成页面,在完成页面中,简单的告知用户已经成功执行。示例代码如下:

 

java代码:
查看 复制到剪贴板 打印
  1. <%@ page language="java" contentType="text/html; charset=gb2312"  
  2.     pageEncoding="gb2312"%>  
  3. <head>  
  4. <meta http-equiv="Content-Type" content="text/html; charset=gb2312">  
  5. </head>  
  6.     恭喜您,任务结束!  

19.2.5运行测试

       在浏览器的地址栏输入“http://localhost:9080/helloworld/waitAction.action”,来直接访问waitAction。

在访问这个WaitAction的时候,第一次访问会使execute方法开始运行。但是,由于引用了execAndWait拦截器,并不是一直等到execute方法运行完之后再跳转到下一个页面,而是马上跳转到struts.xml中注册的名为wait的Result,也就是wait.jsp。

在wait.jsp中仍然可以访问值栈里面的值,因此,通过访问了progress属性来显示当前任务运行的进度。如下图所示:

为Struts2 应用程序创建进度条(等待页面)_第1张图片

图19.1  显示任务进度一

在wait.jsp,又指定了每隔2秒访问一次WaitAction,这时候,只要execute方法还没运行完,就马上再次转发到名为wait的Result,依次类推,直到execute方法运行完之后。因此页面显示的进度数据会一直增加,如图所示:

为Struts2 应用程序创建进度条(等待页面)_第2张图片

图19.2  显示任务进度二

       因此,如果不引用execAndWait拦截器,在访问WaitAction的时候,本应该等到10秒后浏览器才有反应。但是,现在引用了execAndWait拦截器,在访问WaitAction的时候,马上跳转到了wait.jsp,而且每隔2秒刷新一次,直到10秒之后,直到execute方法运行完成,浏览器正确的跳转到success.jsp。如下图所示:

为Struts2 应用程序创建进度条(等待页面)_第3张图片

图19.3 任务结束

19.2.6图形化的进度条

       看到这里,肯定有朋友会说,这哪里像是进度条啊,明明只是显示了一个运行进度而已。确实,从表现上看,不像我们熟悉的进度条,尤其是不像图形化的进度条。

1:JavaScript的图形化进度条

       其实,要实现图形化的进度条也很简单,使用Javascript就可以很方便的实现。先看个最简单的Javascript的进度条的实现,示例代码如下:

 

java代码:
查看 复制到剪贴板 打印
  1. <%@ page language="java" contentType="text/html; charset=gb2312"  
  2.     pageEncoding="gb2312"%>  
  3. <style type="text/css">  
  4. #out{width:300px;height:20px;background:#EEE000;}  
  5. #in{width:10px; height:20px;background:#0000ff;color:white;text-align:center;}  
  6. </style>  
  7. </HEAD>  
  8. <BODY onload="start();" >  
  9. <div id='out'>  
  10.     <div id="in" style="width:10%">10%</div>  
  11. <div>  
  12. <script type="text/javascript">  
  13.     var i=0;  
  14.     function start(){  
  15.         ba=setInterval("begin()",100);  
  16.     }  
  17.     function begin(){  
  18.         i+=1;  
  19.         if(i<=100){  
  20.             document.getElementById("in").style.width=i+"%";  
  21.             document.getElementById("in").innerHTML=i+"%";  
  22.         }else{  
  23.             clearInterval(ba);  
  24.             document.getElementById("out").style.display="none";  
  25.             document.write("进度条运行成功");  
  26.         }  
  27.     }  
  28. </script>  
  29. </BODY>  

具体的Javascript的知识,这里就不去深入了,要注意下面几点:

  • 进度条的效果是通过两个Div来实现的,id为out的div作为底框,id为in的div作为动态显示进度的进度框
  • 启动方法是<body>元素的onload属性所指定的方法
  • Start方法里面的setInterval(表达式,间隔时间),意思是:启动后,每隔指定的间隔时间,就执行前面的表达式一次,这个方法相当于一个定时器
  • 在begin方法里面,通过动态的改变id为in的div框所包含的文字,从而实现动态显示进度的效果
  • 运行到最后,一定要记得清除掉setInterval所设置的定时器,用的是clearInterval方法

当然,使用Javascript来实现进度条有很多种方式,这里只是其中的一种而已。

2:把Struts2的进度条图形化

       接下来把前面的wait.jsp页面显示的进度,改成图形化的进度条的形式。

       同样需要使用Javascript来图形化的显示进度条,只不过具体的进度数据应该从Struts2的waitAction中去获取,也就是直接把从Action中获取的进度数据,直接赋值给Javascript,然后通过Javascript来显示进度条。示例代码如下:

 

java代码:
查看 复制到剪贴板 打印
  1. <%@ page language="java" contentType="text/html; charset=gb2312"  
  2.     pageEncoding="gb2312"%>  
  3. <%@taglib prefix="s" uri="/struts-tags" %>  
  4. <html>  
  5. <head>  
  6. <style type="text/css">  
  7. #out{width:300px;height:20px;background:#EEE000;}  
  8. #in{width:10px; height:20px;background:#0000ff;color:white;text-align:center;}  
  9. </style>  
  10. <meta http-equiv="Content-Type" content="text/html; charset=gb2312">  
  11. <meta http-equiv="refresh" content="2;url=/helloworld/waitAction.action">  
  12. <title>Insert title here</title>  
  13. </head>  
  14. <body>  
  15. <BODY onload="start();" >  
  16. <div id='out'>  
  17.     您好,任务还未完成,已经运行到了任务的<div id="in" style="width:10%">10%</div>  
  18. <div>  
  19. <script type="text/javascript">     
  20.     function start(){  
  21.         ba=setInterval("begin()",100);  
  22.     }  
  23.     function begin(){  
  24.         var i = <s:property value="progress"/>;  
  25.         if(i<=100){  
  26.             document.getElementById("in").style.width=i+"%";  
  27.             document.getElementById("in").innerHTML=i+"%";  
  28.         }else{  
  29.             clearInterval(ba);  
  30.             document.getElementById("out").style.display="none";  
  31.             document.write("进度条运行成功");  
  32.         }  
  33.     }  
  34. </script>  
  35. </BODY>  
  36. </html>  

       最重要的变化就在加粗的那句话,把从Action获取的数据直接设置给了Javascript,要注意这个过程是在服务端完成的,到了客户端,值已经设置好了,因此Javascript同样能正常地运行。

       运行URL:http://localhost:9080/helloworld/waitAction.action,测试一下看看效果,如下图所示:

为Struts2 应用程序创建进度条(等待页面)_第4张图片

图19.4  Struts2的进度条图形化

       进度条会不断滚动,直到运行结束,转向success.jsp为止。


     本文参考自:http://www.cnblogs.com/suxiaolei/archive/2011/11/06/2232009.html

                    http://sishuok.com/forum/blogPost/list/4174.html


你可能感兴趣的:(为Struts2 应用程序创建进度条(等待页面))