【转】Java SwingWorker（三）

前言：------------------------------
程序难免会使用到线程，在可视化Swing界面中大多数为客户端形式体现，其中界面流畅度就成了用户体验的影响之一，除了相应代码整洁减少冗余性及优化其中的算法和减少内存开销等方式，将一些处理过程耗时的命令交由一个新的线程去处理，使Swing组件可以继续接收用户操作即变相提高流畅性（耗时操作应该尽量不在EDT中进行）。
博主找了几篇较为优秀文章可帮助理解其中的奥妙。

以下内容转自 http://blog.sina.cn/dpool/blog/s/blog_4b6047bc010007tt.html?md=gd 

在此文章前请先阅读Java SwingWorker (一)(二)

——————————————————————————————————————————

实现ImageSearcher
SwingWorker的子类可能既会生成最终结果也会产生中间结果，记住线程在doInBackground方法结束后才产生最后结果，但任务线程也可以产生和公布中间数据。比如当ImageSearcher类从Flickr Web服务中获取缩略图列表时，每当下载一个缩略图时，列表便应显示这个缩略图，没理由要等待所有匹配图像下载完毕才把结果放在列表中。
实现SwingWorker子类时，在类声明处要指定最终和中间结果的类型，ImageSearcher搜索并下载匹配的缩略图。由于该类在任务结束时产生匹配图像的列表，所以该类使用List作为类的类型参数，为表明它中间发布的数据是匹配图片，它还使用ImageInfo作为类型参数，ImageSearcher的定义如下： public class ImageSearcher
extends SwingWorker<List<ImageInfo>, ImageInfo> {
public ImageSearcher(DefaultListModel model, String key,
String search, int page) {
this.model = model;
this.key = key;
this.search = search;
this.page = page;
}
...
} 这部分说明了几点：首先List<ImageInfo>类型参数说明任务结束时ImageSearcher的doInBackground和get方法返回一个ImageInfo对象列表；其次当类下载图像时它会发布一些ImageInfo对象，在它们可用后可以立即可以显示出来。因为类的构造函数参数之一是列表模型，因此任务线程会直接更新模型。正如后面看到的一样，它的确是直接更新列表模型；另外，任务线程需要一个Flickr API主键（由Flickr提供）和一个查询项。因为该web服务使用分页方式提供结果，还需要一个页码参数来决定选择哪些匹配的图集。为方便起见，该演示总是返回匹配页 面的第一页。因为doInBackground方法是任何任务线程的重心，先来看以下ImageSearcher的实现：
@Override
protected List<ImageInfo> doInBackground() {
...
Object strResults = null;
InputStream is = null;
URL url = null;
List<ImageInfo> infoList = null;
try {
url = new URL(searchURL);
is = url.openStream();
infoList = parseImageInfo(is);
retrieveAndProcessThumbnails(infoList);
} catch(MalformedURLException mfe) {
...
}
return infoList;
}
它从Web服务打开一个流，提供一个查询URL，parseImageInfo方法产生匹配图片的信息列表，解析由该web服务返回的一个XML文件。retrieveAndProcessThumbnails方法使用解析过的列表下载所有的缩略图。最终结果是一个完整的包含缩略图数据的ImageInfo对象列表。infoList对象同先前提到的类和方法定义类型相同，是List<ImageInfo>类型。
该类同ImageRetriever类相似，因为它也需要更新进度条，并提供图像数据。本文不再详细叙述ImageSearcher的doInBackground、done、get和setProgress方法，因为它们基本上同前面类中的方法相似。但是，ImageSearcher类不仅仅下载单个图片，它还要下载匹配的前100个缩略图片，这儿是演示SwingWorker其他功能的好地方：publish和process方法。
你可以使用publish方法来发布要处理的中间数据，当ImageSearcher线程下载缩略图时，它会随着下载而更新图片信息列表，还会发布每一批图像信息，以便UI能在图片数据到达时显示这些图片。如果SwingWorker子类发布了一些数据，那么也应该实现process方法来处理这些中间结果。任务对象的父类会在EDT线程上激活process方法，因此在此方法中程序可以安全的更新UI组件。
下面代码显示了ImageSearcher是如何使用publish和process方法的：
private void retrieveAndProcessThumbnails(List<ImageInfo> infoList) {
for (int x=0; x <infoList.size() && !isCancelled(); ++x) {
// http://static.flickr.com/{server-id}/{id}_{secret}_[mstb].jpg
ImageInfo info = infoList.get(x);
String strImageUrl = String.format('%s/%s/%s_%s_s.jpg',
IMAGE_URL, info.getServer(), info.getId(), info.getSecret());
Icon thumbNail = retrieveThumbNail(strImageUrl);
info.setThumbnail(thumbNail);
publish(info);
setProgress(100 * (x+1)/infoList.size());
}
}
/**
* Process is called as a result of this worker thread's calling the
* publish method. This method runs on the event dispatch thread.
*
* As image thumbnails are retrieved, the worker adds them to the
* list model.
*
*/
@Override
protected void process(List<ImageInfo> infoList) {
for(ImageInfo info: infoList) {
if (isCancelled()) {
break;
}
model.addElement(info);
}
}
为在任务执行中而非任务结束时发布数据，要调用publish方法，并以参数的形式提供要发布的数据。当然像前面所说的那样，必须在类声明中指定中间数据的类型。在本例中这个类型是ImageInfo。前面所述retrieveAndProcessThumbnails方法显示了如何在线程下载缩略图时发布ImageInfo对象。
当从任务线程调用publish方法时，SwingWorker类调度process方法。有意思的是process方法是在EDT上面执行，这意味着可以同Swing组件和其模型直接交互。process方法将ImageInfo对象的缩略图添加到列表模型中，这样图片就会立即显现在列表中。
注意process方法的参数，它并没有使用单个ImagInfo对象，而是这种对象的一个列表。原因是publish方法能够以批模式来调用process方法，就是说，每个publish调用并不总是产生相应的process调用。如果可能，publish方法会收集对象并以对象的列表为参数调用process方法。实现process方法要以对象列表的方式处理，就像下面的代码： @Override
protected void process(List<ImageInfo> infoList) {
for(ImageInfo info: infoList) {
...
model.addElement(info);
}
} 如果想允许程序用户取消任务，实现代码要在SwingWorker子类中周期性地检查取消请求。调用isCancelled方法来检查是否有取消请求。ImageSearcher代码的许多地方都有isCancelled方法的调用，在循环迭代或者其他检查点调用这个方法确保线程能即时获得取消请求。线程周期性地检查这种请求并停止工作。比如ImageSearcher类在以下几个点检查取消请求：
* doInBackground方法的子任务在获取每个缩略图之前
* process方法中在更新GUI列表模型之前
* done方法中在更新GUI列表模型最终结果之前
doInBackground方法调用retrieveAndProcessThumbnails方法，该方法循环列表的图像数据并获取这些图像的缩略图。然而当任务线程正在执行循环时，用户可以启动新的查询。因此这儿也需要检查取消请求： private void retrieveAndProcessThumbnails(List<ImageInfo> infoList) {
for (int x=0; x<infoList.size(); ++x) {
// Check whether this thread has been cancelled.
// Stop all thumbnail retrieval.
if (isCancelled()) {
break;
}
...
} 该类处理缩略图的同时就发布它们，其结果是在EDT上运行process方法。如果用户请求取消，或者启动新的搜索，可以通过在process方法内检查来避免这种情况的发生。 protected void process(List<ImageInfo> infoList) {
for (ImageInfo info: infoList) {
if (isCancelled()) {
break;
}
model.addElement(info);
}
} 最后，一旦任务线程完成，它还有一个机会更新GUI的模型，这就是在done方法中。因此在这儿也要检查取消请求： @Override
protected void done() {
...
if (isCancelled()) {
return;
}
...
// Update the model.
} ImageSearcher类是一个更为完整的SwingWorker的例子，它比ImageRetriever做的更多，ImageSearcher类往GUI上发布中间数据，并处理任务取消请求。两个类都在后台执行任务，并通过事件处理器跟踪进度。
使用ImageSearcher类
演示程序提供一个搜索输入栏。当用户输入图片查询条件时，MainFrame类创建一个ImageSearcher实例，输入一个查询条件并产生一个键盘事件，输入栏的键盘事件激活searchImage方法，该方法实例化一个ImageSearcher对象并执行之： private void searchImages(String strSearchText, int page) {
if (searcher != null && !searcher.isDone()) {
// Cancel current search to begin a new one.
// You want only one image search at a time.
searcher.cancel(true);
searcher = null;
}
...
// Provide the list model so that the ImageSearcher can publish
// images to the list immediately as they are available.
searcher = new ImageSearcher(listModel, API_KEY, strEncodedText, page);
searcher.addPropertyChangeListener(listenerMatchedImages);
progressMatchedImages.setIndeterminate(true);
// Start the search!
searcher.execute();
// This event thread continues immediately here without blocking.
} 注意代码在ImageSearcher构造函数中提供一个listModel作为参数，这个模型允许任务线程能直接访问更新列表内容。也可以向任务对象添加一个属性改变处理器。上文添加了一个属性改变处理器来更新进度条。除此外还需要添加一个处理器以响应任务线程的状态变化，特别是要侦听DONE状态并使用前文提到的get方法获取任务结果。
一旦执行任务线程，就会搜索并下载缩略图。该程序向任务对象提供了一个列表模型，因此它会直接更新列表。另外，ImageSearcher类提供了中间数据，因此可以在下载图片的同时更新JList组件。其运行的直接效果就是改善了程序的性能。如下图8所示，搜索结果是列表中显示的小图片：

X

图8. 缩略图是任务线程发布的中间数据
你可以通过调用其cancel方法取消SwingWorker线程。用户可以在当前搜索正在进行时输入新的搜索条件并提交来取消当前图像搜索。搜索输入栏的事件处理器检查现有线程是否正在运行，如果正在运行则调用cancel来取消之： private void sea rchImages(String strSearchText, int page) {
if (searcher != null && !searcher.isDone()) {
// Cancel current search to begin a new one.
// You want only one image search at a time.
searcher.cancel(true);
searcher = null;
}
...
} 当调用cancel方法时，代码产生新的任务实例，每一个新的搜索需要自己的任务实例。
总结
所有的GUI事件和交互都运行在EDT上，在EDT上运行耗时或者I/O密集型处理会导致界面变得缓慢失去响应，为改善这种状况应使用Java SE 6中提供的SwingWorker类将这些任务转移到任务线程中。
使用SwingWorker，你可以执行相同的任务而不会延迟EDT运行，会提高程序的性能。并且，任务线程可以安全同界面组件交互，因为有回调方法可以在EDT上运行，允许任务运行和完成时更新GUI组件。