Swing API的設計目标是強大、靈活和易用。特别地,我們希望能讓程式員們友善地建立新的Swing元件,不論是從頭開始還是通過擴充我們所提供的一些元件。
出于這個目的,我們不要求Swing元件支援多線程通路。相反,我們向元件發送請求并在單一線程中執行請求。
本文讨論線程和Swing元件。目的不僅是為了幫助你以線程安全的方式使用Swing API,而且解釋了我們為什麼會選擇現在這樣的線程方案。
本文包括以下内容:
單線程規則:Swing線程在同一時刻僅能被一個線程所通路。一般來說,這個線程是事件派發線程(event-dispatching thread)。
規則的例外:有些操作保證是線程安全的。
事件分發:如果你需要從事件處理(event-handling)或繪制代碼以外的地方通路UI,那麼你可以使用SwingUtilities類的invokeLater()或invokeAndWait()方法。
建立線程:如果你需要建立一個線程??比如用來處理一些耗費大量計算能力或受I/O能力限制的工作??你可以使用一個線程工具類如SwingWorker或Timer。
為什麼我們這樣實作Swing:我們将用一些關于Swing的線程安全的背景資料來結束這篇文章。
Swing的規則是:
一旦Swing元件被具現化(realized),所有可能影響或依賴于元件狀态的代碼都應該在事件派發線程中執行。
這個規則可能聽起來有點吓人,但對許多簡單的程式來說,你用不着為線程問題操心。在我們深入如何撰寫Swing代碼之前,讓我們先來定義兩個術語:具現化(realized)和事件派發線程(event-dispatching thread)。
具現化的意思是組建的paint()方法已經或可能會被調用。一個作為頂級視窗的Swing元件當調用以下方法時将被具現化:setVisible(true)、show()或(可能令你驚奇)pack()。當一個視窗被具現化,它包含的所有元件都被具現化。另一個具現化一個元件的方法是将它放入到一個已經具現化的容器中。稍後你會看到一些對元件具現化的例子。
事件派發線程是執行繪制和事件處理的線程。例如,paint()和actionPerformed()方法會自動在事件派發線程中執行。另一個将代碼放到事件派發線程中執行的方法是使用SwingUtilities類的invokeLater()方法。
所有可能影響一個已具現化的Swing元件的代碼都必須在事件派發線程中執行。但這個規則有一些例外:
有些方法是線程安全的:在Swing API的文檔中,線程安全的方法用以下文字标記:
This method is thread safe, although most Swing methods are not.
(這個方法是線程安全的,盡管大多數Swing方法都不是。)
一個應用程式的GUI常常可以在主線程中建構和顯示:下面的典型代碼是安全的,隻要沒有(Swing或其他)元件被具現化:
public class MyApplication
{
public static void main(String[] args)
{
JFrame f = new JFrame("Labels"); // 在這裡将各元件
// 加入到主架構……
f.pack();
f.show();
// 不要再做任何GUI工作……
}
}
上面所示的代碼全部在“main”線程中運作。對f.pack()的調用使得JFrame以下的元件都被具現化。這意味着,f.show()調用是不安全的且應該在事件派發線程中執行。盡管如此,隻要程式還沒有一個看得到的GUI,JFrame或它的裡面的元件就幾乎不可能在f.show()傳回前收到一個paint()調用。因為在f.show()調用之後不再有任何GUI代碼,于是所有GUI工作都從主線程轉到了事件派發線程,是以前面所讨論的代碼實際上是線程安全的。
一個applet的GUI可以在init()方法中構造和顯示:現有的浏覽器都不會在一個applet的init()和start()方法被調用前繪制它。因而,在一個applet的init()方法中構造GUI是安全的,隻要你不對applet中的對象調用show()或setVisible(true)方法。
要順便一提的是,如果applet中使用了Swing元件,就必須實作為JApplet的子類。并且,元件應該添加到的JApplet内容窗格(content pane)中,而不要直接添加到JApplet。對任何applet,你都不應該在init()或start()方法中執行費時的初始化操作;而應該啟動一個線程來執行費時的任務。
下述JComponent方法是安全的,可以從任何線程調用:repaint()、revalidate()、和invalidate()。repaint()和revalidate()方法為事件派發線程對請求排隊,并分别調用paint()和validate()方法。invalidate()方法隻在需要确認時标記一個元件和它的所有直接祖先。
監聽者清單可以由任何線程修改:調用addListenerTypeListener()和removeListenerTypeListener()方法總是安全的。對監聽者清單的添加/删除操作不會對進行中的事件派發有任何影響。
注意:revalidate()和舊的validate()方法之間的重要差別是,revalidate()會緩存請求并組合成一次validate()調用。這和repaint()緩存并組合繪制請求類似。
大多數初始化後的GUI工作自然地發生在事件派發線程。一旦GUI成為可見,大多數程式都是由事件驅動的,如按鈕動作或滑鼠點選,這些總是在事件派發線程中處理的。
不過,總有些程式需要在GUI成為可見後執行一些非事件驅動的GUI工作。比如:
在成為可用前需要進行長時間初始化操作的程式:這類程式通常應該在初始化期間就顯示出GUI,然後更新或改變GUI。初始化過程不應該在事件派發線程中進行;否則,重繪元件和事件派發會停止。盡管如此,在初始化之後,GUI的更新/改變還是應該在事件派發線程中進行,理由是線程安全。
必須響應非AWT事件來更新GUI的程式:例如,想象一個伺服器程式從可能運作在其他機器上的程式得到請求。這些請求可能在任何時刻到達,并且會引起在一些可能未知的線程中對伺服器的方法調用。這個方法調用怎樣更新GUI呢?在事件派發線程中執行GUI更新代碼。
SwingUtilities類提供了兩個方法來幫助你在事件派發線程中執行代碼:
invokeLater():要求在事件派發線程中執行某些代碼。這個方法會立即傳回,不會等待代碼執行完畢。
invokeAndWait():行為與invokeLater()類似,除了這個方法會等待代碼執行完畢。一般地,你可以用invokeLater()來代替這個方法。
下面是一些使用這幾個API的例子。請同時參閱《The Java Tutorial》中的“BINGO example”,尤其是以下幾個類:CardWindow、ControlPane、Player和OverallStatusPane。
使用invokeLater()方法
你可以從任何線程調用invokeLater()方法以請求事件派發線程運作特定代碼。你必須把要運作的代碼放到一個Runnable對象的run()方法中,并将此Runnable對象設為invokeLater()的參數。invokeLater()方法會立即傳回,不等待事件派發線程執行指定代碼。這是一個使用invokeLater()方法的例子:
Runnable doWorkRunnable = new Runnable()
{
public void run()
{
doWork();
}
};
SwingUtilities.invokeLater(doWorkRunnable);
使用invokeAndWait()方法
invokeAndWait()方法和invokeLater()方法很相似,除了invokeAndWait()方法會等事件派發線程執行了指定代碼才傳回。在可能的情況下,你應該盡量用invokeLater()來代替invokeAndWait()。如果你真的要使用invokeAndWait(),請確定調用invokeAndWait()的線程不會在調用期間持有任何其他線程可能需要的鎖。
這是一個使用invokeAndWait()的例子:
void showHelloThereDialog() throws Exception
{
Runnable showModalDialog = new Runnable()
{
public void run()
{
JOptionPane.showMessageDialog( myMainFrame, "Hello There");
}
};
SwingUtilities.invokeAndWait (showModalDialog);
}
類似地,假設一個線程需要對GUI的狀态進行存取,比如文本域的内容,它的代碼可能類似這樣:
void printTextField()
throws Exception {
final String[] myStrings = new String[2];
Runnable getTextFieldText = new Runnable() {
public void run() {
myStrings[0] = textField0.getText();
myStrings[1] = textField1.getText();
}
};
SwingUtilities.invokeAndWait (getTextFieldText);
System.out.println(myStrings[0] + " " + myStrings[1]);}
如果你能避免使用線程,最好這樣做。線程可能難于使用,并使得程式的debug更困難。一般來說,對于嚴格意義下的GUI工作,線程是不必要的,比如對元件屬性的更新。
不管怎麼說,有時候線程是必要的。下列情況是使用線程的一些典型情況:
執行一項費時的任務而不必将事件派發線程鎖定。例子包括執行大量計算的情況,會導緻大量類被裝載的情況(如初始化),和為網絡或磁盤I/O而阻塞的情況。
重複地執行一項操作,通常在兩次操作間間隔一個預定的時間周期。
要等待來自客戶的消息。
你可以使用兩個類來幫助你實作線程:
SwingWorker:建立一個背景線程來執行費時的操作。
Timer:建立一個線程來執行或多次執行某些代碼,在兩次執行間間隔使用者定義的延遲。
使用SwingWorker類
SwingWorker類在SwingWorker.java中實作,這個類并不包含在Java的任何發行版中,是以你必須單獨下載下傳它。
SwingWorker類做了所有實作一個背景線程所需的肮髒工作。雖然許多程式都不需要背景線程,背景線程在執行費時的操作時仍然是很有用的,它能提高程式的性能觀感。
SwingWorker´s get() method. Here´s an example of using SwingWorker:
要使用SwingWorker類,你首先要實作它的一個子類。在子類中,你必須實作construct()方法還包含你的長時間操作。當你執行個體化SwingWorker的子類時,SwingWorker建立一個線程但并不啟動它。你要調用你的SwingWorker對象的start()方法來啟動線程,然後start()方法會調用你的construct()方法。當你需要construct()方法傳回的對象時,可以調用SwingWorker類的get()方法。這是一個使用SwingWorker類的例子:
...// 在main方法中:
final SwingWorker worker = new SwingWorker() {
public Object construct() {
return new expensiveDialogComponent();
}
};
worker.start();
...
// 在動作事件處理方法中:
JOptionPane.showMessageDialog (f, worker.get());
當程式的main()方法調用start()方法,SwingWorker啟動一個新的線程來執行個體化ExpensiveDialogComponent。main()方法還構造了由一個視窗和一個按鈕組成的GUI。
當使用者點選按鈕,程式将阻塞,如果必要,阻塞到ExpensiveDialogComponent建立完成。然後程式顯示一個包含ExpensiveDialogComponent的模式對話框。你可以在MyApplication.java找到整個程式。
使用Timer類
Timer類通過一個ActionListener來執行或多次執行一項操作。你建立定時器的時候可以指定操作執行的頻率,并且你可以指定定時器的動作事件的監聽者(action listener)。啟動定時器後,動作監聽者的actionPerformed()方法會被(多次)調用來執行操作。
定時器動作監聽者(action listener)定義的actionPerformed()方法将在事件派發線程中調用。這意味着你不必在其中使用invokeLater()方法。
這是一個使用Timer類來實作動畫循環的例子:
public class AnimatorApplicationTimer
extends JFrame implements ActionListener {
...//在這裡定義執行個體變量
Timer timer;
public AnimatorApplicationTimer(...) {
... // 建立一個定時器來
// 來調用此對象action handler。
timer = new Timer(delay, this);
timer.setInitialDelay(0);
timer.setCoalesce(true);
...
}
public void startAnimation() {
if (frozen) {
// 什麼都不做。應使用者要求
// 停止變換圖像。
} else {
// 啟動(或重新開機動)動畫!
timer.start();
}
}
public void stopAnimation() {
// 停止動畫線程。
timer.stop();
}
public void actionPerformed (ActionEvent e)
{
// 進到下一幀動畫。
frameNumber++;
// 顯示。
repaint();
}
...
}
在一個線程中執行所有的使用者界面代碼有這樣一些優點:
元件開發者不必對線程程式設計有深入的了解:像ViewPoint和Trestle這類工具包中的所有元件都必須完全支援多線程通路,使得擴充非常困難,尤其對不精通線程程式設計的開發者來說。最近的一些工具包如SubArctic和IFC,都采用和Swing類似的設計。
事件以可預知的次序派發:invokeLater()排隊的runnable對象從滑鼠和鍵盤事件、定時器事件、繪制請求的同一個隊列派發。在一些元件完全支援多線程通路的工具包中,元件的改變被變化無常的線程排程程式穿插到事件處理過程中。這使得全面測試變得困難甚至不可能。
更低的代價:嘗試小心鎖住臨界區的工具包要花費實足的時間和空間在鎖的管理上。每當工具包中調用某個可能在客戶代碼中實作的方法時(如public類中的任何public和protected方法),工具包都要儲存它的狀态并釋放所有鎖,以便客戶代碼能在必要時獲得鎖。當控制權交回到工具包,工具包又必須重新抓住它的鎖并恢複狀态。所有應用程式都不得不負擔這一代價,即使大多數應用程式并不需要對GUI的并發通路。
這是的SubArctic Java Toolkit的作者對在工具包中支援多線程通路的問題的描述:
我們的基本信條是,當設計和建造多線程應用程式,尤其是那些包括GUI元件的應用程式時,必須保證極端小心。線程的使用可能會很有欺騙性。在許多情況下,它們表現得能夠極好的簡化編成,使得設計“專注于單一任務的簡單自治實體”成為可能。在一些情況下它們的确簡化了設計和編碼。然而,在幾乎所有的情況下,它們都使得調試、測試和維護的困難大大增加甚至成為不可能。無論大多數程式員所受的訓練、他們的經驗和實踐,還是我們用來幫助自己的工具,都不是能夠用來對付非決定論的。例如,全面測試(這總是困難的)在bug依賴于時間時是幾乎不可能的。尤其對于Java來說,一個程式要運作在許多不同類型的機器的作業系統平台上,并且每個程式都必須在搶先和非搶先式排程下都能正常工作。
由于這些固有的困難,我們力勸你三思是否絕對有使用線程的必要。盡管如此,有些情況下使用線程是必要的(或者是被其他軟體包強加的),是以subArctic提供了一個線程安全的通路機制。本章讨論了這一機制和怎樣在一個獨立線程中安全地操作互動樹。
他們所說的線程安全機制非常類似于SwingUtilities類提供的invokeLater()和invokeAndWait()方法。