9.25 AWT, Swing und die Threads

Swing nutzt für Zeichenoperationen und das Abarbeiten von Ereignis-Programmcode einen einen Thread. Die folgenden Abschnitte erklären, warum Swing einen eigenen Thread nutzt, und welche Konsequenzen das für den Entwickler hat.

9.25.1 Ereignisschlange (EventQueue) und AWT-Event-Thread

Der Benutzer erzeugt bei seiner Arbeit mit der Oberfläche Ereignisse. Diese werden entweder von den Peer-Objekten oder von Klassen der Applikation erzeugt. Bevor sie vom eigenen Programm bearbeitet werden, gelangen sie in eine Ereignisschlange (engl. event queue). Jedem Fenster ist eine eigene Event-Queue zugeordnet. Diese Event-Queue ist für Programmierer zugänglich und in einer plattformunabhängigen Klasse EventQueue implementiert. Elemente der Klasse sind Objekte vom Typ AWTEvent. Ein eigener Thread, der AWT-Event-Thread, läuft parallel zur Anwendung und arbeitet die angesammelten Ereignisse dieser Warteschlange ab.

Der AWT-Thread führt auch den Programmcode in den Listenern aus. Aus diesem Grund ist es ungünstig, in einen Event-Handler lang dauernden Programmcode zu legen, denn dann »steht« die grafische Applikation und lässt sich nicht fortsetzen, weil der AWT-Thread blockiert ist. Bei einer längeren Aktion in einem Event-Handler sollten wir einen separaten Thread starten, damit die grafische Oberfläche sofort wieder reaktionsfähig ist.

ActionListener al = new ActionListener() {
  public void actionPerformed( ActionEvent e ) {
    new Thread( new ReaderThread(e.getActionCommand()) ).start();
  }
};

class ReaderThread implements Runnable
{
  ReaderThread( String actionCommand )
  {
    // ...
  }
  public void run() {
    // ...
  }
}

Unter dem AWT ist es kein Problem, wenn zwei Threads auf ein und dasselbe Oberflächenelement zugreifen. Bei Swing ist dies jedoch etwas anders, wie wir im nächsten Abschnitt sehen werden.

9.25.2 Swing ist nicht thread-sicher

Die Tatsache, dass das Swing-Toolkit nicht thread-sicher ist, erstaunt vielleicht auf den ersten Blick. Das AWT ist thread-sicher, da AWT auf Plattform-Peer-Elemente vertraut. In einer List-Box unter dem AWT ist es problemlos möglich, ein Element einzufügen und parallel zu löschen. Doch auf die Synchronisation bei Swing wurde aus zwei Gründen verzichtet:

• Operationen können in Threads zu ärgerlichen Deadlock-Situationen führen.
• Der Verzicht auf Synchronisation kann die Ausführungsgeschwindigkeit erhöhen.

Swing weiß mit konkurrierenden Zugriffen nicht allzu viel anzufangen

In einem kleinen Beispiel wollen wir genau einen Fehler provozieren, in dem zwei Threads gleichzeitig eine Datenstruktur modifizieren und somit Swing aus dem Takt werfen. Es ist ein mahnendes Beispiel, Operationen an GUI-Komponenten nur über den AWT-Event-Thread vorzunehmen:

Listing 9.89: com/tutego/insel/ui/swing/SwingNoSyncDemo.java

package com.tutego.insel.ui.swing;

import javax.swing.*;

public class SwingNoSyncDemo
{
  public static void main( String[] args )
  {
    final DefaultListModel<String> model = new DefaultListModel<String>();

    JFrame frame = new JFrame();
    frame.add( new JList<String>( model ) );
    frame.setSize( 200, 100 );
    frame.setVisible( true );

    new Thread() {
      @Override public void run() {
        setPriority( Thread.MIN_PRIORITY );
        while ( true )
          model.addElement( "Dumm gelaufen" );
      }
    }.start();

    new Thread() {
      @Override public void run() {
        setPriority( Thread.MIN_PRIORITY );
        while ( true )
          model.removeElement( "Dumm gelaufen" );
      }
    }.start();
  }
}

Werfen wir einen Blick auf die Ausgabe, die erscheint, wenn das Programm nur kurz läuft:

Exception in thread "AWT-EventQueue-0" 
java.lang.ArrayIndexOutOfBoundsException: 5891 >= 5891
  at java.util.Vector.elementAt(Vector.java:427)
  at javax.swing.DefaultListModel.getElementAt(DefaultListModel.java:70)
  at javax.swing.plaf.basic.BasicListUI.updateLayoutState(BasicListUI.java:1348)
  ...
  at java.awt.EventDispatchThread.run(EventDispatchThread.java:122)

Obwohl das DefaultListModel als unterliegende Datenstruktur den Vector nimmt und dieser nur synchronisierte Methoden besitzt, die beim nebenläufigen Zugriff den Vector nicht irritieren, ist er nicht der Übeltäter. Es liegt an Swing, wie mit den Daten umgegangen wird. Wenn der erste Thread Daten in das Model einfügt, muss die Visualisierung aktualisiert werden. Wir wissen von DefaultListModel, dass es über ListDataEvent das Darstellungsobjekt informiert, wenn es den Inhalt neu zeichnen muss. Merken wir uns die Stelle. Das Darstellungsobjekt wird sich nun vom Model die Daten besorgen. Bis dahin läuft alles ganz gut. Doch der zweite Thread löscht parallel die Daten aus dem Model. Springen wir jetzt zur Markierung zurück. Irgendwann passiert es, dass zwischen der Benachrichtigung der Darstellungskomponente und dem wirklichen Zeichnen sowie der Anfrage an das Model etwas gelöscht wird. Die Visualisierung weiß davon aber nichts und versucht, alle Werte zu zeichnen; es fehlt jedoch mindestens ein Wert. Daher folgt eine ArrayIndexOutOfBoundsException in der Methode elementAt() vom Vector. Die Visualisierung fragt mit einem Index im Vector nach, doch der Vector hat vom Lösch-Thread schon ein Element abgeben müssen. Daher ist die interne Größe des Vektors kleiner als der von Swing erfragte Index.

Erlaubte Methoden

Einige der Methoden sind thread-sicher und dürfen von beliebigen anderen Threads aufgerufen werden:

• der Aufruf zum Neuzeichnen mit repaint() oder revalidate() für die Größenänderung einer Komponente im Container
• alle Aufrufe auf neuen Komponenten, die noch nicht etwa mit setVisible() (früher show()) bzw. pack() veröffentlicht wurden
• Die Eintragung von Listenern, etwa bei JComponent mit den Methoden addPropertyChangeListener(), removePropertyChangeListener() und addVetoableChangeListener(), removeVetoableChangeListener() ist sicher.
• Bei JCheckBoxMenuItem ist es dann die einsame Methode setState(boolean), die synchronisiert ist. Es findet sich intern mal hier, mal da ein synchronisierter Block.

Ansonsten ist jedoch nicht viel dabei, und wir müssen unsere Teile synchronisiert ausführen. Um Programmstücke konform ausführen zu lassen, definiert Swing einige Methoden und Klassen. Dazu gehören:

• invokeLater(Runnable)
• invokeAndWait(Runnable)
• JProgressBar
• ProgressMonitor
• ProgressMonitorInputStream
• SwingWorker

9.25.3 invokeLater() und invokeAndWait()

Da Swing nicht thread-sicher ist, bietet der AWT-Thread die einzige Möglichkeit zur Manipulation von Oberflächenelementen. Wenn wir es schaffen, dort die Aufträge einzureihen, dann wird nichts schiefgehen. Genau für diese Aufgabe gibt es in der Klasse EventQueue zwei statische Methoden: invokeLater() und invokeAndWait(). Damit lassen sich beliebige Programmstücke in die Warteschlange einführen. In der Warteschlange für das AWT liegen Aufträge und Ereignisse, die an die Oberflächenelemente verteilt werden. Alles spielt sich dabei neben dem Haupt-Thread ab, sodass Parallelität herrscht. Hat die Warteschlange alle Ereignisbehandler aufgerufen, kann der Programmcode von invokeLater() und invokeAndWait() durchlaufen werden.

Die beiden Methoden erfüllen unterschiedliche Bedürfnisse:

• invokeLater() legt einen Runnable in die Warteschlange und kehrt sofort zurück. Die Funktion ist somit asynchron. Der Aufrufer weiß nicht, wann der Programmcode abgearbeitet wird.
• invokeAndWait() legt ebenfalls einen Runnable in die Warteschlange, verharrt aber so lange in der Funktion, bis der Programmcode in run() aufgerufen wurde. Die Funktion ist also synchron.

Mit diesen statischen Methoden lassen sich jetzt alle Manipulationen an der Oberfläche durchführen. Den statischen Methoden wird ein Runnable-Objekt übergeben, was den Programmcode repräsentiert, der im AWT-Event-Thread auszuführen ist.

EventQueue.invokeLater( new Runnable()
{
  public void run() {
    bar.setValue( i );
  }
} );

Bei der Auswahl der beiden Methoden haben wir uns für den Fortschrittsbalken für invokeLater() entschieden. Es ist in der Regel wenig sinnvoll, die Methode so lange stehen zu lassen, bis die Anzeige auch wirklich gezeichnet wurde.

Ein Problem stellt für sehr viele Applikationen leider die Tatsache dar, dass das Objekt zur Manipulation immer irgendwie sichtbar sein muss. Hier soll bar einfach direkt für die innere Klasse sichtbar sein.

Die Methoden invokeLater() und invokeAndWait() befinden sich nicht nur in der Klasse EventQueue, sondern sind noch einmal in der Klasse SwingUtilities untergebracht. Daher ist es gleichgültig, ob wir EventQueue.invokeXXX() oder SwingUtilities.invokeXXX() schreiben. SwingUtilities hat vielleicht den Vorteil, dass das Paket java.awt für die EventQueue nicht importiert werden muss, sonst gibt es aber keinen Unterschied.

SwingUtilities.invokeLater( new Runnable() {
  public void run() {
    JFrame f = new JFrame( "Uhrzeit" );
    f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
    f.add( new JLabel( String.format( "%tT", new Date() ) ) );
    f.setSize( 250, 100 );
    f.setVisible( true );
  }
} );

Implementierung

Genehmigen wir uns abschließend noch einen kurzen Blick auf die Implementierung. Es lässt sich schon erahnen, dass invokeLater() einfacher ist:

public static void invokeLater( Runnable runnable )
{
  Toolkit.getEventQueue().postEvent(
    new InvocationEvent(Toolkit.getDefaultToolkit(), runnable) );
}

Das Ereignis, das in die Event-Queue kommt, ist vom Typ InvocationEvent und damit ein AWTEvent. Wir übergeben unser Runnable-Objekt, damit der AWT-Thread später die run()-Methode aufrufen kann.

Die statische Methode invokeAndWait() ist etwas komplizierter; wir wollen von der Implementierung nur wenige Zeilen betrachten. Im Prinzip leistet die Methode das Gleiche wie invokeLater(); auch sie muss das InvocationEvent in die Warteschlange legen. Hinzu kommt jedoch, dass invokeAndWait() auf das Ende des Threads warten muss:

InvocationEvent event = new InvocationEvent(
    Toolkit.getDefaultToolkit(), runnable, lock, true);
  synchronized (lock) {
    Toolkit.getEventQueue().postEvent(event);
    lock.wait();
}

Das konstruierte InvocationEvent bekommt als Argument wieder das runnable. Jetzt erhält es aber zusätzlich ein Lock-Objekt. Wenn der AWT-Thread durch die Ereignis-Warteschlange geht und das InvocationEvent sieht, führt er wieder die run()-Methode aus. Anschließend informiert er über notify() das wartende Objekt. Dann steigt invokeAndWait() aus dem synchronized-Block aus, und es geht weiter.

9.25.4 SwingWorker

Mit er Klasse SwingWorker ist es einfach möglich, längere Programmteile im Hintergrund von einem Nicht-AWT-Thread abarbeiten zu lassen und dann später die Ergebnisse über den AWT-Thread wieder in die GUI einfließen zu lassen. Die Klasse ist ab Java 6 Teil der Java SE, für frühere Java-Versionen liegt eine Version mit Dokumentation unter https://swingworker.dev.java.net/ vor.

Für einen eigenen SwingWorker ist zunächst eine Unterklasse von javax.swing.SwingWorker zu bilden. Wir wollen eine Klasse ClockPrecision angeben, die zwei Sekunden wartet und dabei die Zeit misst – das Ergebnis ist durch Ungenauigkeit nicht wirklich zwei Sekunden. Wir interessieren uns hier für die Ungenauigkeit. Nach Ablauf der Zeit soll der SwingWorker das Ergebnis auf die Schaltfläche schreiben, die auch der Auslöser für die Warterei ist:

Listing 9.90: com/tutego/insel/ui/event/SwingWorkerDemo.java

package com.tutego.insel.ui.event;

import java.awt.event.*;
import javax.swing.*;

public class SwingWorkerDemo extends JFrame
{
  JButton button = new JButton( "Change my mind!" );

  SwingWorkerDemo()
  {
    setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
    add( button );

    ActionListener al = new ActionListener() {
      @Override public void actionPerformed( ActionEvent e )
      {
        new ClockPrecision().execute();
      }
    };

    button.addActionListener( al );

    pack();
  }

  class ClockPrecision extends SwingWorker<Long, Object>
  {
    @Override public Long doInBackground()
    {
      long startNano = System.nanoTime();
      try { Thread.sleep( 2000 ); } catch ( InterruptedException e ) { }
      return (System.nanoTime() – startNano ) / (1000*1000);
    }

    @Override protected void done()
    {
      try
      {
        button.setText( "" + get() );
      }
      catch ( /* InterruptedException, ExecutionException */ Exception e ) { }
    }
  }

  public static void main( String[] args )
  {
    new SwingWorkerDemo().setVisible( true );
  }
}

Die Methode done() bekommt die Rückgabe von doInBackground() über die get()-Methode. Unser SwingWorker durchläuft mehrere Phasen, an denen wir uns durch Überschreiben einiger Methoden aktiv beteiligen:

• Es beginnt mit execute(), was den SwingWorker dazu bewegt, einen sogenannten Worker-Thread aufzubauen.
• Der Worker-Thread ruft doInBackground() auf, in den wir unseren im Hintergrund auszuführenden Programmteil setzen. Der Rückgabetyp ist durch die generische Verwendung frei wählbar. Da SwingWorker auch vom Typ Future ist, kann das Ergebnis einer Berechnung get() liefern. Sind mit addPropertyChangeListener() neue PropertyChangeListeners angemeldet, können wir sie mit firePropertyChange() aufrufen und während der Verarbeitung Status-Ereignisse schicken. publish() erlaubt das Absenden von Zwischenergebnissen, die sich unter dem AWT-Event in process() verarbeiten lassen. Dieser Typ kann ein anderer als der von get() sein, und so bestimmt die zweite Typvariable der generischen Klasse diesen Typ.
• Am Ende des Worker-Threads kommt es im AWT-Event-Thread zu einem Aufruf von done(), wo wir unsere Swing-Operationen vornehmen können.

Weiteres ist der API-Dokumentation zu entnehmen.

9.25.5 Eigene Ereignisse in die Queue setzen *

Es ist ohne großen Umweg möglich, eigene Ereignisse zu erzeugen und in der EventQueue zu platzieren. Damit lassen sich beispielsweise Eingaben des Benutzers emulieren. Da alle Ereignisse von Komponenten von AWTEvent erben, lässt sich ein ActionEvent erzeugen, das dann wiederum von einem interessierten Listener entgegengenommen wird. Jetzt fehlt uns nur noch eine Methode, die Ereignisse in die Schlange setzt. Dazu bietet die Klasse EventQueue die Methode postEvent() an. Im Beispiel sehen wir die notwendigen Aufrufe, um beginnend vom Toolkit an die SystemEventQueue zu kommen:

Toolkit.getDefaultToolkit().getSystemEventQueue().
  postEvent(
   new ActionEvent( /* Object source, int id, String command */ )
  );

class java.awt.Toolkit

• final EventQueue getSystemEventQueue()
  Liefert ein Exemplar der EventQueue für eine Applikation oder ein Applet. Eine SecurityException wird ausgelöst, falls der Security-Manager den Zugriff auf EventQueue verbietet.

class java.awt.EventQueue

• void postEvent(AWTEvent theEvent)
  Legt ein Ereignis in die EventQueue. Danach werden vorhandene EventQueueListener und notifyEventQueueListener aufgerufen.

Einer Komponente ein Ereignis schicken

Ist die Komponente bekannt, der ein Ereignis geschickt werden soll, lässt sich die Component-Methode dispatchEvent(AWTEvent e) verwenden. Sie sendet ein AWTEvent – die Basisklasse aller AWT-Ereignisse – an die Komponente, womit alle Listener aufgerufen werden. Für die Aktivierung einer Schaltfläche b lautet es dann:

b.dispatchEvent( new ActionEvent(b,ActionEvent.ACTION_PERFORMED, "text") );

9.25.6 Auf alle Ereignisse hören *

Um keine Ereignisse zu versäumen, lässt sich über das Toolkit ein Super-Listener anmelden. Dieser Listener ist vom Typ AWTEventListener, der über addAWTEventListener() mit dem Toolkit verbunden wird:

AWTEventListener ael = new AWTEventListener() {
  public void eventDispatched( AWTEvent event ) {
  }
};
Toolkit.getDefaultToolkit().addAWTEventListener( ael, mask );

Die mask bestimmt den Typ eines jeden gemeldeten AWTEvent. Hier kann für Mausbewegungen etwa AWTEvent.MOUSE_MOTION_EVENT_MASK stehen.

Ihr Kommentar

Wie hat Ihnen das <openbook> gefallen? Wir freuen uns immer über Ihre freundlichen und kritischen Rückmeldungen.