【转】Java SwingWorker(二)

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

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

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

本节简要介绍SwingWorker的功能。SwingWorker的定义如下:
public abstract class SwingWorker<T,V> extends Object implements RunnableFuture
SwingWorker是抽象类,因此必须继承它才能执行所需的特定任务。注意该类有两个类型参数:T及V。T是doInBackground和get方法的返回类型,V是publish和process方法要处理的数据类型。后文将作详细解释。 该类实现了java.util.concurrent.RunnableFuture接口。RunnableFuture接口是Runnable和Future两个接口的简单封装。由于SwingWorker实现了Runnable接口,因此SwingWorker有一个run方法。Runnable对象一般作为线程的一部分执行,当Thread对象启动时,它激活Runnable对象的run方法。由于SwingWorker实现了Future接口,因此SwingWorker产生类型为T的结果值并提供同线程交互的方法。SwingWorker实现以下接口方法:
* boolean cancel(boolean mayInterruptIfRunning)
* T get()
* T get(long timeout, TimeUnit unit)
* boolean isCancelled()
* boolean isDone()
SwingWorker实现了所有的接口方法,实际上你仅需要实现以下SwingWorker的抽象方法:
protected T doInBackground() throws Exception
doInBackground方法作为任务线程的一部分执行,它负责完成线程的基本任务,并以返回值来作为线程的执行结果。继承类须覆盖该方法并确保包含或代理任务线程的基本任务。不要直接调用该方法,应使用任务对象的execute方法来调度执行。
在获得执行结果后应使用SwingWorker的 get方法获取doInBackground方法的结果。可以在EDT上调用get方法,但该方法将一直处于阻塞状态,直到任务线程完成。最好只有在知道结果时才调用get方法,这样用户便不用等待。为防止阻塞,可以使用isDone方法来检验doInBackground是否完成。另外调用方法get(long timeout, TimeUnit unit)将会一直阻塞直到任务线程结束或超时。获取任务结果的最好地方是在done方法内:
protected void done()
在doInBackground方法完成之后,SwingWorker调用done方法。如果任务需要在完成后使用线程结果更新GUI组件或者做些清理工作,可覆盖done方法来完成它们。这儿是调用get方法的最好地方,因为此时已知道线程任务完成了,SwingWorker在EDT上激活done方法,因此可以在此方法内安全地和任何GUI组件交互。
没必要等到线程完成就可以获得中间结果。中间结果是任务线程在产生最后结果之前就能产生的数据。当任务线程执行时,它可以发布类型为V的中间结果,覆盖process方法来处理中间结果。后文还将提供这些方法的更多详细信息。当属性改变时,SwingWorker实例能通知处理器,SwingWorker有两个重要的属性:状态和进程。任务线程有几种状态,以下面SwingWorker.StateValue枚举值来表示:
* PENDING
* STARTED
* DONE
任务线程一创建就处于PENDING状态,当doInBackground方法开始时,任务线程就进入STARTED状态,当doInBackground方法完成后,任务线程就处于DONE状态,随着线程进入各个阶段,SwingWorker超类自动设置这些状态值。你可以添加处理器,当这些属性发生变化来接收通知。
最后,任务对象有一个进度属性,随着任务进展时,可以将这个属性从0更新到100标识任务进度,当该属性发生变化时,任务通知处理器进行处理。
实现简单的ImageRetriever
当点击列表所略图时,事件处理器创建了一个ImageRetriever实例并执行之。ImageRetriever下载选中的图片并在列表下面展示它。当实现SwingWorker子类,须指定doInBackground和get方法返回值的类型。因为ImageRetriever并不生成中间结果,它使用特殊类型Void作为中间类型,ImageRetriever的任务的结果是一图片,因此使用Icon类型作为doInBackground和get方法的返回类型,下面代码显示了ImageRetriever的大部分实现: public class ImageRetriever extends SwingWorker<Icon, Void> {
private ImageRetriever() {}
public ImageRetriever(JLabel lblImage, String strImageUrl) {
this.strImageUrl = strImageUrl;
this.lblImage = lblImage;
}
@Override
protected Icon doInBackground() throws Exception {
Icon icon = retrieveImage(strImageUrl);
return icon;
}
private Icon retrieveImage(String strImageUrl)
throws MalformedURLException, IOException {
InputStream is = null;
URL imgUrl = null;
imgUrl = new URL(strImageUrl);
is = imgUrl.openStream();
ImageInputStream iis = ImageIO.createImageInputStream(is);
Iterator<ImageReader> it =
ImageIO.getImageReadersBySuffix('jpg');
ImageReader reader = it.next();
reader.setInput(iis); ...
Image image = reader.read(0);
Icon icon = new ImageIcon(image);
return icon;
}
@Override
protected void done() {
Icon icon = null;
String text = null;
try {
icon = get();
} catch (Exception ignore) {
ignore.printStackTrace();
text = 'Image unavailable';
}
lblImage.setIcon(icon);
lblImage.setText(text);
}
private String strImageUrl;
private JLabel lblImage;
} 因为ImageRetriever类下载图象并把它以label图标的方式展现,因此为了方便在其构造函数中要提供一个JLabel实例和图象URL。ImageRetriever需要图象URL来下载图象,需要一个JLabel实例来展现下载的图象,如果使用内部类实现任务线程ImageRetriever,由于可以直接访问这些信息,你甚至不需要在构造函数中提供这些信息(图象URL以及展现图象的JLabel实例)。这样做这些信息不会在ImageRetriever实例之间共享,所以更容易帮助程序实现线程安全。
注意ImageRetriever指定Icon作为doInBackground和get方法的返回类型,因为并不产生任何中间数据,所以指定Void类型作为中间结果类型。
public class ImageRetriever extends SwingWorker<Icon, Void> 在该实现中,doInBackground方法必须遵循类协议,返回一个Icon类型的对象。通过在类定义指定Icon类型,编译器强制doInBackground和get方法要返回Icon类型的值。不要覆盖get方法,因为该方法在SwingWorker中是一个final方法。
doInBackground方法从类构造函数中提供的URL中获得图象并产生一个Icon结果: @Override
protected Icon doInBackground() throws Exception {
Icon icon = retrieveImage(strImageUrl);
return icon;
} 当doInBackground方法完成后,SwingWorker在EDT上调用done方法,不要直接调用这个方法,因为SwingWorker超类会调用这个方法。done方法获得Icon结果并把它放到标签label上。在本例中,lblImage引用通过ImageRetriever构造函数传入进来。
@Override
protected void done() {
...
icon = get();
...
lblImage.setIcon(icon);
...
}
progress属性值范围是从0到100,当你在任务实例内处理这些信息时,你可以调用setProgress方法来更新这个属性。当ImageRetriever通过ImageIO API下载图象时,它调用setProgress方法来更新其progress属性。下面的代码展示如何使用IIOReadProgressListener实例来跟踪ImageReader对象任务、下载图象并更新progress属性:
reader.addIIOReadProgressListener(new IIOReadProgressListener() { ... public void imageProgress(ImageReader source, float percentageDone) { setProgress((int) percentageDone); } public void imageComplete(ImageReader source) { setProgress(100); } }); 当任务属性发生变化时,它通知处理器对象。在前面例子代码中,当ImageRetriever类从ImageIO API那儿收到更新信息时调用setProgress方法并使用这些信息来设置自己的进度属性,作为结果,属性变化处理器知道了当前下载了多少图象数据。
图7显示ImageRetriever下载图象完成后的结果:

使用SwingWorker之二X

图7.SwingWorker线程在任务完成后更新进度条和标签图标
ImageRetriever演示了一个SwingWorker的简单实现,在简单实现中,只需覆盖方法doInBackground就行。然而,因为只有doInBackground方法完成之后,任务最后的结果才能获得,所以你也应该覆盖done方法。
SwingWorker在doInBackground方法完成之后激活done方法,所以应该从done方法中获得任务结果,并且应该使用get方法获得任务结果。通过在ImageRetriever构造函数提供这些UI组件,保证了能在任务线程的done方法中直接更新这些组件。前面的例子显示了如何使用从Flickr站点获取的图象设置标签label的图标。参考ImageRetriever的完整实现了解如何从Flickr网站获得图像。
使用简单ImageRetriever
现在已经创建了简单的SwingWorker实现ImageRetriever,如何使用它呢?首先,要实例化,接着调用它的execute方法。当用户从JList中选择一个缩略图,演示应用程序的MainFrame类就使用ImageRetriever任务线程。当用户点击一个缩略图,列表选择发生变化,产生一个列表选择事件,listImageValueChanged方法是事件处理器。listImageValueChanged方法获得选中的列表项,并生成相应缩略图片对应的图象的Flikr服务URL字符串,事件处理器接着调用retrieveImage方法,retrieveImage方法包含生成和使用ImageRetriever任务线程的重要代码。


private void listImagesValueChanged(ListSelectionEvent evt) { 

...

 ImageInfo info = (ImageInfo) 

listImages.getSelectedValue(); 

String id = info.getId(); 

String server = info.getServer(); 

String secret = info.getSecret(); // No need to search an invalid thumbnail image 

if (id == null || server == null || secret == null) {

 return; 

String strImageUrl = String.format(IMAGE_URL_FORMAT, server, id, secret); retrieveImage(strImageUrl);

 ...

 } 

private void retrieveImage(String imageUrl) { 

// SwingWorker objects can't be reused, so create a new one as needed. 

ImageRetriever imgRetriever = new ImageRetriever(lblImage, imageUrl);

 progressSelectedImage.setValue(0);

 /* Listen for changes in the 'progress' property.  You can reuse the listener even though the worker thread .will be a new SwingWorker. */ 

imgRetriever.addPropertyChangeListener(listenerSelectedImage); 

progressSelectedImage.setIndeterminate(true);

  // Tell the worker thread to begin with this asynchronous method.

 imgRetriever.execute(); 

 //This event thread continues immediately here without blocking. */ 

} 注意每次下载新的图像,retrieveImage方法都生成新的ImageRetriever实例。SwingWorker实例不可复用,每次执行任务必须生成新的实例。
正确使用SwingWorker的方法是实例化,如果需要获知线程发生的状态变化通知,则要添加属性变化处理器,最后执行。execute方法是异步执行,它立即返回到调用者。在execute方法执行后,EDT立即继续执行。图6显示这两条线程之间的交互。
前面所讲的retrieveImage方法生成一个ImageRetriever,并向该实例提供一个JLabel引用,任务线程使用它显示图象,retrieveImage方法和EDT不需要再访问任务线程。这些代码生成线程、执行、并根据需要继续处理UI事件。
注意retrieveImage方法在执行线程之前往ImageRetriever实例添加属性改变处理器,MainFrame类包含进度条跟踪当前图像下载的状态,事件处理器会接收到所有SwingWorker线程事件的通知,其中一个事件是进度事件。
下面的事件处理器类响应进度事件,更新进度条。本文程序有两个进度条,一个跟踪搜索以及下载缩略图进度,另一个跟踪下载大图片的进度。程序使用相同的ProgressListener类,不同实例,来跟踪任务进度,因此需要在ProgressListener构造函数中传要更新的进度条,下面是ProgressListener的代码:
/** * ProgressListener listens to 'progress' property * changes in the SwingWorkers that search and load * images. */

 class ProgressListener implements PropertyChangeListener {

 // Prevent creation without providing a progress bar. private 

ProgressListener() {} 

ProgressListener(JProgressBar progressBar) { 

this.progressBar = progressBar; 

this.progressBar.setValue(0); 

}

 public void propertyChange(PropertyChangeEvent evt) { 

String strPropertyName = evt.getPropertyName(); 

if ('progress'.equals(strPropertyName)) { 

progressBar.setIndeterminate(false); 

int progress = (Integer)evt.getNewValue(); 

progressBar.setValue(progress); 

private JProgressBar progressBar; 

ImageRetriever类的使用是简单的,给定一个图像URL,它负责下载该图像,向事件处理器提供进度信息来更新MainFrame类的进度条,你不需要知道关于创建和使用任务线程任何信息。只要一点努力,就可以从SwingWorker子类获取更多效果。下一节将显示如何实现并使用更复杂的任务子类。
(待续)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章