Mtk's Blog: [Java] SwingのUIを無限ループで更新するには

How to update the UI in an Infinite loop
SwingはJavaのGUIアプリケーションの開発及び実行環境です。
Javaでアプリ開発できるAndroidに比べるとUI(画面)更新にだいぶ違いがあるので悩んだところをまとめてみました。

開発環境

・32bit Windows7
・Eclipse 3.5
・その他Eclipse用日本語化プラグイン、Jstyleなど

Swing用プラグインのインストール

EclipseでSwingを利用するにあたりSwing Designerというプラグインをインストールしました。
ヘルプ - 新規ソフトウェアのインストール
を開き、作業対象に
http://download.eclipse.org/windowbuilder/WB/release/R201309271200/4.3/
と入力し
Swing Designer
WindowBuilder Engine
の2つをインストールしました。

Swing Designerの他にもVisual Swingというプラグインも公開されているようです。

Swing用プロジェクトの作成

簡単な例としてデジタル時計を作ってみます。
新規にJava プロジェクトを作成します。
JFlameのサブクラスを作成します。

JFlameにLabelを一つ追加しました。

約1秒間隔でLabelに現在時刻を表示することを目標にします。

悪い例

package jp.fujiu.swing_sample;

import java.awt.EventQueue;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.util.Calendar;

import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.border.EmptyBorder;
import javax.swing.SpringLayout;
import javax.swing.JLabel;

public class Main extends JFrame {
 //日付の書式 YYYY/MM/DD hh:mm:ss
 private static final String DATE_FORMAT = "%1$d/%2$02d/%3$02d %4$02d:%5$02d:%6$02d";

 private static final long serialVersionUID = 1L;
 private JPanel contentPane;
 private JLabel lblNewLabel;

 public static void main(String[] args) {
  EventQueue.invokeLater(new Runnable() {
   public void run() {
    try {
     Main frame = new Main();
     frame.setVisible(true);
    } catch (Exception e) {
     e.printStackTrace();
    }
   }
  });
 }

 public Main() {
  setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  setBounds(100, 100, 450, 300);
  contentPane = new JPanel();
  contentPane.setBorder(new EmptyBorder(5, 5, 5, 5));
  setContentPane(contentPane);
  SpringLayout sl_contentPane = new SpringLayout();
  contentPane.setLayout(sl_contentPane);
  
  lblNewLabel = new JLabel("New label");
  sl_contentPane.putConstraint(SpringLayout.NORTH, lblNewLabel, 0, SpringLayout.NORTH, contentPane);
  sl_contentPane.putConstraint(SpringLayout.WEST, lblNewLabel, 0, SpringLayout.WEST, contentPane);
  sl_contentPane.putConstraint(SpringLayout.SOUTH, lblNewLabel, 0, SpringLayout.SOUTH, contentPane);
  sl_contentPane.putConstraint(SpringLayout.EAST, lblNewLabel, 0, SpringLayout.EAST, contentPane);
  contentPane.add(lblNewLabel);
  
  //無限ループ
  while(true){
   Calendar calendar = Calendar.getInstance();
   ByteArrayOutputStream str = new ByteArrayOutputStream();
   PrintStream ps = new PrintStream(str);
   ps.printf(DATE_FORMAT, 
    calendar.get(Calendar.YEAR), 
    calendar.get(Calendar.MONTH) + 1, 
    calendar.get(Calendar.DATE), 
    calendar.get(Calendar.HOUR_OF_DAY), 
    calendar.get(Calendar.MINUTE), 
    calendar.get(Calendar.SECOND)
   );
   final String strDate = str.toString();
   ps.close();
   try {
    str.close();
   } catch (IOException e1) {
   }

   //無限ループの中でUIを更新
   lblNewLabel.setText(strDate);

   try {
    Thread.sleep(1000);
   } catch (InterruptedException e) {
   }
  }
 }
}

コンパイルエラーはありません。
ですが実行しても何も変化しないか、実行時エラーが出たりすると思います。
コンストラクターで無限ループしてるのでコンストラクターが終わりません。
停止させるにはデバッグウィンドウの終了ボタンをクリックしてください。

もし正常に動作するように見えてもこのまま使ってはいけません。

Swingでの約束事

・ループ処理は新しいスレッドで処理する
・UI更新はSwingUtilities.invokeLater(Runnable doRun)で処理する

上の例ではループ処理とUI更新処理を同じスレッドで実行しています。
約束事を守ってないのでUI更新が保証されません。
ちなみに今回のループ処理のようなスレッドをワーカースレッド、UI更新処理のためのスレッドをイベントディスパッチスレッドと呼ぶようです。
イベントディスパッチスレッドで処理したい内容を SwingUtilities.invokeLaterの中に書きます。
UI更新はSwingUtilities.invokeLaterで処理する必要があります。

修正した結果

package jp.fujiu.swing_sample;

import java.awt.EventQueue;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.util.Calendar;

import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.SwingUtilities;
import javax.swing.border.EmptyBorder;
import javax.swing.SpringLayout;
import javax.swing.JLabel;

public class Main extends JFrame {
 //日付の書式 YYYY/MM/DD hh:mm:ss
 private static final String DATE_FORMAT = "%1$d/%2$02d/%3$02d %4$02d:%5$02d:%6$02d";

 private static final long serialVersionUID = 1L;
 private JPanel contentPane;
 private JLabel lblNewLabel;

 public static void main(String[] args) {
  EventQueue.invokeLater(new Runnable() {
   public void run() {
    try {
     Main frame = new Main();
     frame.setVisible(true);
    } catch (Exception e) {
     e.printStackTrace();
    }
   }
  });
 }

 public Main() {
  setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  setBounds(100, 100, 450, 300);
  contentPane = new JPanel();
  contentPane.setBorder(new EmptyBorder(5, 5, 5, 5));
  setContentPane(contentPane);
  SpringLayout sl_contentPane = new SpringLayout();
  contentPane.setLayout(sl_contentPane);
  
  lblNewLabel = new JLabel("New label");
  sl_contentPane.putConstraint(SpringLayout.NORTH, lblNewLabel, 0, SpringLayout.NORTH, contentPane);
  sl_contentPane.putConstraint(SpringLayout.WEST, lblNewLabel, 0, SpringLayout.WEST, contentPane);
  sl_contentPane.putConstraint(SpringLayout.SOUTH, lblNewLabel, 0, SpringLayout.SOUTH, contentPane);
  sl_contentPane.putConstraint(SpringLayout.EAST, lblNewLabel, 0, SpringLayout.EAST, contentPane);
  contentPane.add(lblNewLabel);
  
  //新しいスレッドの中で無限ループ
  Thread thread = new Thread(){
   @Override
   public void run() {
    //無限ループ
    while(true){
     Calendar calendar = Calendar.getInstance();
     final ByteArrayOutputStream str = new ByteArrayOutputStream();
     PrintStream ps = new PrintStream(str);
     ps.printf(DATE_FORMAT, 
      calendar.get(Calendar.YEAR), 
      calendar.get(Calendar.MONTH) + 1, 
      calendar.get(Calendar.DATE), 
      calendar.get(Calendar.HOUR_OF_DAY), 
      calendar.get(Calendar.MINUTE), 
      calendar.get(Calendar.SECOND)
     );
     final String strDate = str.toString();
     ps.close();
     try {
      str.close();
     } catch (IOException e1) {
     }
     
     //イベントディスパッチスレッドでUIを更新
     SwingUtilities.invokeLater(new Runnable() {
      public void run() {
       lblNewLabel.setText(strDate);
      }
     });

     try {
      sleep(1000);
     } catch (InterruptedException e) {
     }
    }
   }
  };
  thread.start();
 }
}

これで正常に動作しました。

今回は使いませんでしたが、UI更新をイベントディスパッチスレッドの最後に処理する SwingUtilities.invokeAndWait(Runnable doRun) というメソッドもあります。

まとめ

実際に無限ループを処理することはあまりないと思います。
なので今回のサンプルは実用性がありません。

ですが、Webサーバーやデータベースサーバーにアクセスしてユーザーを待たせるようなSwingアプリケーションを作るときは
・サーバーへのアクセスは新しいスレッドで処理する
・UI更新は SwingUtilities.invokeLater で処理する
・SwingUtilities.invokeLater の中でUI更新以外の処理をさせない
という設計にするといいと思います。

Mtk's Blog

2014年6月7日土曜日

[Java] SwingのUIを無限ループで更新するには

開発環境

Swing用プラグインのインストール

Swing用プロジェクトの作成

悪い例

Swingでの約束事

修正した結果

まとめ

関連ブログ

0 件のコメント:

コメントを投稿