一个JSP编程进度条设计实例

许多Web应用、企业应用涉及到长时间的操作，例如复杂的数据库查询或繁重的XML处理等，虽然这些任务主要由数据库系统或中间件完成，但任务执行的结果仍旧要借助JSP才能发送给用户。本文介绍了一种通过改进前端表现层来改善用户感觉、减轻服务器负载的办法。

当JSP调用一个必须长时间运行的操作，且该操作的结果不能（在服务器端）缓冲，用户每次请求该页面时都必须长时间等待。很多时候，用户会失去耐心，接着尝试点击浏览器的刷新按钮，最终失望地离开。

本文介绍的技术是把繁重的计算任务分离开来，由一个独立的线程运行，从而解决上述问题。当用户调用JSP页面时，JSP页面会立即返回，并提示用户任务已经启动且正在执行；JSP页面自动刷新自己，报告在独立线程中运行的繁重计算任务的当前进度，直至任务完成。


一、模拟任务




　　首先我们设计一个TaskBean类，它实现java.lang.Runnable接口，其run()方法在一个由JSP页面（start.jsp）启动的独立线程中运行。终止run()方法执行由另一个JSP页面stop.jsp负责。TaskBean类还实现了java.io.Serializable接口，这样JSP页面就可以将它作为JavaBean调用：




package test.barBean;
import java.io.Serializable;




public class TaskBean implements Runnable, Serializable {
private int counter;
private int sum;
private boolean started;
private boolean running;
private int sleep;




public TaskBean() {
counter = 0;
sum = 0;
started = false;
running = false;
sleep = 100;
}
}




　　TaskBean包含的“繁重任务”是计算1+2+3…+100的值，不过它不通过100*(100+1)/2=5050公式计算，而是由run()方法调用work()方法100次完成计算。work()方法的代码如下所示，其中调用Thread.sleep()是为了确保任务总耗时约10秒。




protected void work() {
try {
Thread.sleep(sleep);
counter++;
sum += counter;
} catch (InterruptedException e) {
setRunning(false);
}
}

　　status.jsp页面通过调用下面的getPercent()方法获得任务的完成状况：




public synchronized int getPercent() {
return counter;
}

如果任务已经启动，isStarted()方法将返回true：


public synchronized boolean isStarted() {
return started;
}





　　如果任务已经完成，isCompleted()方法将返回true：




public synchronized boolean isCompleted() {
return counter == 100;
}





　　如果任务正在运行，isRunning()方法将返回true：




public synchronized boolean isRunning() {
return running;
}





　　SetRunning()方法由start.jsp或stop.jsp调用，当running参数是true时。SetRunning()方法还要将任务标记为“已经启动”。调用setRunning(false)表示要求run()方法停止执行。




public synchronized void setRunning(boolean running) {
this.running = running;
if (running)
started = true;
}

　　任务执行完毕后，调用getResult()方法返回计算结果；如果任务尚未执行完毕，它返回null：




public synchronized Object getResult() {
if (isCompleted())
return new Integer(sum);
else
return null;
}

　　当running标记为true、completed标记为false时，run()方法调用work()。在实际应用中，run()方法也许要执行复杂的SQL查询、解析大型XML文档，或者调用消耗大量CPU时间的EJB方法。注意“繁重的任务”可能要在远程服务器上执行。报告结果的JSP页面有两种选择：或者等待任务结束，或者使用一个进度条。




public void run() {
try {
setRunning(true);
while (isRunning() amp;amp; !isCompleted())
work();
} finally {
setRunning(false);
}
}

二、启动任务






　　start.jsp是web.xml部署描述符中声明的欢迎页面，web.xml的内容是：










PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">






start.jsp






　　start.jsp启动一个专用的线程来运行“繁重的任务”，然后把HTTP请求传递给status.jsp。




　　start.jsp页面利用标记创建一个TaskBean的实例，将scope属性定义为session使得对于来自同一浏览器的HTTP请求，其他页面也能提取到同一个Bean对象。start.jsp通过调用session.removeAttribute("task")确保创建了一个新的Bean对象，而不是提取一个旧对象（例如，同一个用户会话中更早的JSP页面所创建的Bean对象）。




　　下面是start.jsp页面的代码清单：




<% session.removeAttribute("task"); %>





class="test.barBean.TaskBean"/>




<% task.setRunning(true); %>
<% new Thread(task).start(); %>


　　start.jsp创建并设置好TaskBean对象之后，接着创建一个Thread，并将Bean对象作为一个Runnable实例传入。调用start()方法时新创建的线程将执行TaskBean对象的run()方法。




　　现在有两个线程在并发执行：执行JSP页面的线程（称之为“JSP线程”），由JSP页面创建的线程（称之为“任务线程”）。接下来，start.jsp利用调用status.jsp，status.jsp显示出进度条以及任务的执行情况。注意status.jsp和start.jsp在同一个JSP线程中运行。




　　start.jsp在创建线程之前就把TaskBean的running标记设置成了true，这样，即使当JSP线程已开始执行status.jsp而任务线程的run()方法尚未启动，也能够确保用户会得到“任务已开始运行”的状态报告。




　　将running标记设置成true、启动任务线程这两行代码可以移入TaskBean构成一个新的方法，然后由JSP页面调用这个新方法。一般而言，JSP页面应当尽量少用Java代码，即我们应当尽可能地把Java代码放入Java类。不过本例中我们不遵从这一规则，把new Thread(task).start()直接放入start.jsp突出表明JSP线程创建并启动了任务线程。




　　在JSP页面中操作多线程必须谨慎，注意JSP线程和其它线程实际上是并发执行的，就象在桌面应用程序中，我们用一个线程来处理GUI事件，另外再用一个或多个线程来处理后台任务。不过在JSP环境中，考虑到多个用户同时请求某一个页面的情况