1.耗时的操作(例如从数据库查询大量数据,读取URI资源等)一定不能运行在EDT(事件派发线程)上,否则会导致Swing用户界面失去响应。
2.只能在EDT线程上对Swing Components进行访问。
基于上面两点原因,在一个Java Swing程序中,要想使用户界面响应灵敏,至少应该有两个线程;一个线程用来执行耗时操作,EDT线程用来执行所有与Swing Components的交互,例如更新文本,重绘图形等等。这就要求两个线程之间要相互通讯,给程序的开发带来了不少的难度,Swing Worker的出现从根本上解决了这个问题,使程序员快速开发反应灵敏的的Swing程序成为可能。SwingWoker被设计应用在此种场景下,你有一个耗时操作需要运行在后台,在该操作完成或部分完成时,你要利用操作返回的结果去更新用户界面。
让我们假想有这样一个应用场景,我有一个保存联系人的文件,我需要从中读取并解析出所有联系人的信息,并及时更新在一个JTable中;假设这个文件非常的大,解析出所有联系人的信息需要花费几分钟的时间,如果不能很好的协调这个任务和EDT线程,则很有可能会造成用户在几分钟时间里得不到结果,而Swing界面处于无响应状态。在这种情况下,SwingWorker就是一个绝佳的选择。我们首先看一下SwingWorker的定义:
public abstract class SwingWorker<T,V> extends Object implements RunnableFuture <T>
显然,这时一个抽象的模板类,在应用的时候,我们需要继承SwingWorker并实例化模板参数。那么,这两个模板类型究竟是什么意思呢,T参数代表的是你的耗时任务执行完成时返回的结果类型,V代表的是你的耗时任务部分完成时返回的结果类型。在我们的场景中,假设任务完成时我们需要一个List<BeanContact>(BeanContact是一个保存联系人信息的JavaBean),每当从文件中解析出一个联系人信息时,我们会新建一个BeanContact并需要更新到JTable中。那么我们的T就是List<BeanContact>,而V就是BeanContact,则应该定义如下的类:
public class LoadContactsTask extends SwingWorker<List<BeanContact>, BeanContact> {
@Override
protected List<BeanContact> doInBackground() throws Exception {
//To do the task and return the result
}
}
从上面可以看到,我们还必须覆盖SwingWorker的doInBackground方法,该方法执行我们的耗时操作,并且返回模板实例化时的T类型结果。下面是具体的代码实现:
@Override
protected List<BeanContact> doInBackground() throws Exception {
BufferedReader reader = new BufferedReader(new FileReader("c:/contacts.cff"));
String line = null;
while ((line = reader.readLine()) != null) {
String[] strContacts = line.split(",");
BeanContact contact = new BeanContact();
contact.setName(strContacts[0]);
contact.setSex(strContacts[1]);
contact.setPhone(strContacts[2]);
contact.setEmail(strContacts[3]);
lineCnt++;
publish(contact);/*********/
contacts.add(contact);
Thread.sleep(100);
}
return contacts;
}
@Override
protected void process(List<BeanContact> chunks) {
if (progressHandle != null) {
progressHandle.processInProgress(chunks, lineCnt * 100 / 10000);
}
}
我们的实现中,process中会调用IProgressHandle(自定义的一个接口,用来更新用户界面,详见后面代码)的processInProgress方法来更新用户界面,大家会注意到process方法的参数是一个List<BeanContact>,为什么不是一个BeanContact呢,答案就是我们在上面讲过的,有可能publish若干次后才调用process方法。
与此类似,在doInBackground完成后,SwingWorker会自动调用done方法,下面是我们的实现:
@Override
protected void done() {
if (progressHandle != null) {
progressHandle.processComplete(contacts);
}
}
客户端如何来使用用SwingWork呢,很简单,只需要新建一个实例并且调用它的execute方法即可,他会自动调用doInBackground方法来完成操作;以下是完整的代码实现:
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package swingworkertest;
/**
*
* @author Administrator
*/
public class BeanContact {
private String name=null;
private String sex=null;
private String phone=null;
private String email=null;
/**
* @return the name
*/
public String getName() {
return name;
}
/**
* @param name the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the sex
*/
public String getSex() {
return sex;
}
/**
* @param sex the sex to set
*/
public void setSex(String sex) {
this.sex = sex;
}
/**
* @return the phone
*/
public String getPhone() {
return phone;
}
/**
* @param phone the phone to set
*/
public void setPhone(String phone) {
this.phone = phone;
}
/**
* @return the email
*/
public String getEmail() {
return email;
}
/**
* @param email the email to set
*/
public void setEmail(String email) {
this.email = email;
}
}
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
/*
* Contacts.java
*
* Created on 2011-6-25, 10:40:13
*/
package swingworkertest;
import javax.swing.JFileChooser;
/**
*
* @author Administrator
*/
public class Contacts extends javax.swing.JFrame {
/** Creates new form Contacts */
public Contacts() {
initComponents();
handle = new DefaultProgressHandle();
handle.setTable(jTable1);
handle.setProgressBar(jProgressBar1);
}
/** This method is called from within the constructor to
* initialize the form.
* WARNING: Do NOT modify this code. The content of this method is
* always regenerated by the Form Editor.
*/
@SuppressWarnings("unchecked")
// <editor-fold defaultstate="collapsed" desc="Generated Code">
private void initComponents() {
jButton1 = new javax.swing.JButton();
jTextField1 = new javax.swing.JTextField();
jScrollPane1 = new javax.swing.JScrollPane();
jTable1 = new javax.swing.JTable();
jButton2 = new javax.swing.JButton();
jProgressBar1 = new javax.swing.JProgressBar();
setDefaultCloseOperation(javax.swing.WindowConstants.EXIT_ON_CLOSE);
jButton1.setText("浏览");
jButton1.addActionListener(new java.awt.event.ActionListener() {
public void actionPerformed(java.awt.event.ActionEvent evt) {
jButton1ActionPerformed(evt);
}
});
jTextField1.setEditable(false);
jTable1.setModel(new javax.swing.table.DefaultTableModel(
new Object [][] {
},
new String [] {
"姓名", "性别", "电话", "电子邮件"
}
) {
Class[] types = new Class [] {
java.lang.String.class, java.lang.String.class, java.lang.String.class, java.lang.String.class
};
public Class getColumnClass(int columnIndex) {
return types [columnIndex];
}
});
jScrollPane1.setViewportView(jTable1);
jButton2.setText("加载联系人");
jButton2.addActionListener(new java.awt.event.ActionListener() {
public void actionPerformed(java.awt.event.ActionEvent evt) {
jButton2ActionPerformed(evt);
}
});
javax.swing.GroupLayout layout = new javax.swing.GroupLayout(getContentPane());
getContentPane().setLayout(layout);
layout.setHorizontalGroup(
layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
.addGroup(javax.swing.GroupLayout.Alignment.TRAILING, layout.createSequentialGroup()
.addContainerGap()
.addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.TRAILING)
.addComponent(jScrollPane1, javax.swing.GroupLayout.Alignment.LEADING, javax.swing.GroupLayout.DEFAULT_SIZE, 557, Short.MAX_VALUE)
.addComponent(jProgressBar1, javax.swing.GroupLayout.Alignment.LEADING, javax.swing.GroupLayout.DEFAULT_SIZE, 557, Short.MAX_VALUE)
.addComponent(jButton2, javax.swing.GroupLayout.Alignment.LEADING, javax.swing.GroupLayout.DEFAULT_SIZE, 557, Short.MAX_VALUE)
.addGroup(layout.createSequentialGroup()
.addComponent(jButton1, javax.swing.GroupLayout.DEFAULT_SIZE, 97, Short.MAX_VALUE)
.addGap(18, 18, 18)
.addComponent(jTextField1, javax.swing.GroupLayout.PREFERRED_SIZE, 442, javax.swing.GroupLayout.PREFERRED_SIZE)))
.addContainerGap())
);
layout.setVerticalGroup(
layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
.addGroup(layout.createSequentialGroup()
.addContainerGap()
.addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.BASELINE)
.addComponent(jButton1)
.addComponent(jTextField1, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE))
.addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
.addComponent(jButton2)
.addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
.addComponent(jScrollPane1, javax.swing.GroupLayout.PREFERRED_SIZE, 120, javax.swing.GroupLayout.PREFERRED_SIZE)
.addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
.addComponent(jProgressBar1, javax.swing.GroupLayout.PREFERRED_SIZE, 22, javax.swing.GroupLayout.PREFERRED_SIZE)
.addContainerGap(javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE))
);
layout.linkSize(javax.swing.SwingConstants.VERTICAL, new java.awt.Component[] {jButton1, jButton2, jTextField1});
pack();
}// </editor-fold>
private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {
ContactsFileFilter filter = new ContactsFileFilter();
JFileChooser chooser = new JFileChooser();
chooser.setFileFilter(filter);
int returnVal = chooser.showOpenDialog(null);
if(returnVal == JFileChooser.APPROVE_OPTION){
jTextField1.setText(chooser.getSelectedFile().getAbsolutePath());
}
}
private void jButton2ActionPerformed(java.awt.event.ActionEvent evt) {
// TODO add your handling code here:
LoadContactsTask task = new LoadContactsTask(jTextField1.getText());
task.setProgressHandle(handle);
task.execute();
}
/**
* @param args the command line arguments
*/
public static void main(String args[]) {
java.awt.EventQueue.invokeLater(new Runnable() {
public void run() {
Contacts contacts = new Contacts();
contacts.setTitle("Contacts");;
contacts.setVisible(true);
}
});
}
DefaultProgressHandle handle = null;
// Variables declaration - do not modify
private javax.swing.JButton jButton1;
private javax.swing.JButton jButton2;
private javax.swing.JProgressBar jProgressBar1;
private javax.swing.JScrollPane jScrollPane1;
private javax.swing.JTable jTable1;
private javax.swing.JTextField jTextField1;
// End of variables declaration
}
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package swingworkertest;
import java.io.File;
import javax.swing.filechooser.FileFilter;
/**
*
* @author Administrator
*/
public class ContactsFileFilter extends FileFilter{
public boolean accept(File pathname) {
if(pathname.isDirectory()){
return true;
}else{
return pathname.getName().endsWith(".cff");
}
}
@Override
public String getDescription() {
return "Text Files";
}
}
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package swingworkertest;
import java.util.List;
import javax.swing.JProgressBar;
import javax.swing.JTable;
import javax.swing.table.DefaultTableModel;
/**
*
* @author Administrator
*/
public class DefaultProgressHandle implements IProgressHandle {
private JTable table = null;
private JProgressBar progressBar = null;
public void processInProgress(List<BeanContact> contacts, int progress) {
DefaultTableModel model = (DefaultTableModel) table.getModel();
for (BeanContact contact : contacts) {
String[] strArray = {contact.getName(), contact.getSex(), contact.getPhone(), contact.getEmail()};
model.addRow(strArray);
}
progressBar.setValue(progress);
}
public void processComplete(List<BeanContact> contacts) {
progressBar.setValue(progressBar.getMaximum());
}
/**
* @param table the table to set
*/
public void setTable(JTable table) {
this.table = table;
}
/**
* @param progressBar the progressBar to set
*/
public void setProgressBar(JProgressBar progressBar) {
this.progressBar = progressBar;
}
}
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package swingworkertest;
import java.util.List;
/**
*
* @author Administrator
*/
public interface IProgressHandle {
public abstract void processInProgress(List<BeanContact> contacts,int progress);
public abstract void processComplete(List<BeanContact> contacts);
}
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package swingworkertest;
import java.io.BufferedReader;
import java.io.FileReader;
import java.util.ArrayList;
import java.util.List;
import javax.swing.SwingWorker;
/**
*
* @author Administrator
*/
public class LoadContactsTask extends SwingWorker<List<BeanContact>, BeanContact> {
private String fileName = null;
private IProgressHandle progressHandle = null;
private List<BeanContact> contacts = null;
private int lineCnt = 0;
public LoadContactsTask(String fileName) {
this.fileName = fileName;
contacts = new ArrayList<BeanContact>();
}
@Override
protected List<BeanContact> doInBackground() throws Exception {
BufferedReader reader = new BufferedReader(new FileReader("c:/contacts.cff"));
String line = null;
while ((line = reader.readLine()) != null) {
String[] strContacts = line.split(",");
BeanContact contact = new BeanContact();
contact.setName(strContacts[0]);
contact.setSex(strContacts[1]);
contact.setPhone(strContacts[2]);
contact.setEmail(strContacts[3]);
lineCnt++;
publish(contact);
contacts.add(contact);
Thread.sleep(100);
}
return contacts;
}
/**
* @param progressHandle the progressHandle to set
*/
public void setProgressHandle(IProgressHandle progressHandle) {
this.progressHandle = progressHandle;
}
@Override
protected void process(List<BeanContact> chunks) {
if (progressHandle != null) {
progressHandle.processInProgress(chunks, lineCnt * 100 / 10000);
}
}
@Override
protected void done() {
if (progressHandle != null) {
progressHandle.processComplete(contacts);
}
}
}
- SwingWorker可以帮助我们在后台执行耗时的任务,而避免阻塞我们的应用程序,以让用户感觉不爽。
- SwingWorker有2个参数T , V
- T:为最终结果集 【<T> the result type returned by this SwingWorker's doInBackground and get methods】,由文档的介绍可以知道这个结果可以被doInBackground和get方法返回。
- V:为中间结果集【<V> the type used for carrying out intermediate results by this SwingWorker's publish and process methods】
- 还要了解的是SwingWorker的几个流程:
- doInBackground是工作线程,他可以明确调用publich方法(注意publish方法只在SwingWorker类中实现),以发送中间结果V,然后这个中间结果有被发送到在EDT(事件派发线程)中的
- process方法中进行处理。
- 当doInBackground处理完后,会自动调用done方法,由T类型的描述那里可以知道,在这个方法中可以调用get方法获取最终结果集,多好玩啊,哈哈。
- 现在拿一段代码来分析下吧:
- import java.awt.Image;
- import java.io.File;
- import java.util.ArrayList;
- import java.util.List;
- import javax.imageio.ImageIO;
- import javax.swing.ImageIcon;
- import javax.swing.JLabel;
- import javax.swing.JPanel;
- import javax.swing.JTextArea;
- import javax.swing.SwingWorker;
- public class ImageLoadingWorker extends SwingWorker<List<Image>, String>{
- //看到没有继承与SwingWorker类了。T为List<Image>,说明最终结果集为List<Image>.没错,这个类就是用来加载图像,然后显示的
- //V类型为String,拉到下面看下,publish的参数是String吧
- private JTextArea logArea;
- private JPanel viewerPanel;
- private String[] fileNames;
- public ImageLoadingWorker(JTextArea logArea , JPanel viewerPanel , String[] fileNames){
- this.logArea = logArea;
- this.viewerPanel = viewerPanel;
- this.fileNames = fileNames;
- }
- //通过执行了SwingWorker的execute方法,然后就调用了doInBackground这个方法,对fileNames对应的Image进行加载。并在每一个图像
- //加载的同时用publish方法发送相应信息,这个信息会发送到process方法中进行处理,当然前提是你要重写process这个函数,以保证能按
- //照你的要求来进行显示,对吧
- @Override
- protected List<Image> doInBackground() throws Exception {
- // TODO Auto-generated method stub
- List<Image> images = new ArrayList<Image>();
- for(String imgName : fileNames){
- try {
- images.add(ImageIO.read(new File(imgName)));
- publish("loading " + imgName);
- } catch (Exception e) {
- // TODO: handle exception
- publish("error"+imgName);
- }
- }
- return images;
- }
- //done方法是在doInBackground处理完成后,才执行的。于是乎,每个图像都是加载好的了。只要添加进去就可以了。
- //这样,一个耗时的任务,就被SwingWorker轻松解决了。还有一点就是,done是在EDT中的,所以没有破坏Swing的
- //单线程模式,而把一切与GUI相关的操作,都放在了EDT中执行。
- @Override
- protected void done() {
- // TODO Auto-generated method stub
- try {
- //get() : Waits if necessary for the computation to complete, and then retrieves its result.
- for (Image image:get()) {
- viewerPanel.add(new JLabel(new ImageIcon(image)));
- viewerPanel.revalidate();
- }
- } catch (Exception e) {
- // TODO: handle exception
- }
- }
- //看看这个函数,参数为List<String> chunks,这个参数名字你是可以改的,但是类型就别改了,否则的话,publish发给类本身的了,你重写
- //的就没意义了,如V类型所述,类型还是String。
- @Override
- protected void process(List<String> chunks) {
- // TODO Auto-generated method stub
- for(String message:chunks){
- logArea.append(message);
- logArea.append("/r/n");
- }
- }
- }