XML-RPC してみる Part 3 - bluepapa32’s Java Blog

今回もまだまだ引き続き XML-RPC について。

前回 NetBeans 6.9 を使って簡単なアプリケーションを作成してみたものの...
実はそのアプリケーションには

XML-RPC の実行が終了するまで何も操作できなくなる

という誰にも言えない問題があったのです。
もし、運悪く XML-RPC がレスポンスを返してくれなかったら完全にフリーズしてしまいます。

この原因は XML-RPC の実行の仕方にあります。
JavaFX は基本的に全ての処理を EDT と呼ばれるたった一つのスレッドで実行しています。
もちろん全ての処理には描画処理やイベント処理等も含まれています。
前回のサンプルのように何も考えずにコーディングしてしまったら...
比較的処理時間の長い XML-RPC が EDT で実行されてしまい、暫くの間それ以外の処理は全てブロックされアプリケーションはフリーズしてしまいます。
EDT は XML-RPC の返事をただ待っているだけなのに...
これは XML-RPC に限った話ではありません。
ファイルシステム、データベース、その他の WEBサービス等も同様です。

この問題を解決するのはとっても簡単...

XML-RPC は EDT 以外のスレッドで処理すれば良い

だけです。方法は

XmlRpcClient#execAsync(String, Object[], AsyncCallBack) を使う。
javafx.async を使う。

の２つが考えられます。
javafx.async は過去の日記にも書きましたが ActionTask を使ってとっても簡単に実装できます。
しかし折角ライブラリで非同期処理をサポートしているのに使わない手はありません。
と言うことで今回は XmlRpCClient#execAsync(String, Object, AsyncCallBack) を使って実装してみることに...

こちらも使い方はとっても簡単です。
前回との違いは buttonAction 関数だけです。
非同期で処理をするために executeAsync(String, Object, AsyncCallback) に変更しています。
後は XML-RPC の処理が完了した際に呼び出されるコールバック関数として AsyncCallback インターフェースを実装するだけです。
JavaFX の場合インターフェースの実装は関数に override を付けるだけです。
更に JavaFX のいいところは引数や戻り値の型を指定しなくても勝手にコンパイラが推測してくれるところです。

    function buttonAction(): Void {
        client.executeAsync("bookmark.getTotalCount", [ textBox.text ], AsyncCallback {
            override function handleResult(request, result) {
                label.text = "{result} users";
            }
            override function handleError(request, e) {
                e.printStackTrace();    // 今回は何も考えず スタックトレース出力
            }
        });
    }

実はこのコードにもまだ問題があります。
JavaFX には忘れてはならないお約束が一つだけあるのですが
それは...

Node の属性は必ず EDT で変更しよう

です。
このお約束を守らずに作られたアプリケーションはデッドロックを起こしてフリーズしてしまいます。
この辺りの話も既に過去の日記に書いてるので、そちらも参考になるかもしれません。

で、結局 buttonAction 関数はこんな感じになりました。
上記との違いは FX.deferAction(function():Void) で label.text の内容を変更しているところです。
この FX.deferAction(...) の引数に渡した関数は EDT で実行されるのです。

    function buttonAction(): Void {
        client.executeAsync("bookmark.getTotalCount", [ textBox.text ], AsyncCallback {
            override function handleResult(request, result) {
                FX.deferAction(function(): Void {
                    label.text = "(result} users";
                });
            }
            override function handleError(request, e) {
                e.printStackTrace();    // 今回は何も考えず スタックトレース出力
            }
        });
    }

上記のようにちょっとだけ注意すれば XML-RPC を利用するのはとっても簡単です。
ライブラリさえあれば何も知らなくても誰でも利用できそうですね。
Apache XML-RPC にはプロキシの仕組みも実装されているようなので、それを使えば完全に XML-RPC を意識することなくメソッドを実行できるようになるみたい...
いつかまた時間があるときにまとめてみようかな...
最近は完全に REST に押されている XML-RPC ですがまだまだ利用できる仕組みだと思います。

実は REST よりも XML-RPC を先に試したのには理由があります。
それは Trac との連携がしたかったから...
自分は仕事でもプライベートでも毎日のように Trac を利用しているのですが、 WEB のインターフェースはお世辞にも使い易いとは言えません。
それなら Trac と JavaFX を連携させちゃえばいいじゃんという安易なことを考えていたりして...