LAN内通信アプリを作ろう その３ JavaFXのイベントハンドラを作成する/ソケット通信によるメッセージ送受信機能を作成する

昨日はJavaのライブラリを利用しSocketの受信機能を作りました。
（今のところ、指定ポートのソケットでデータを受信したかどうか見てるだけですが）

今日は送受信機能を完成させたい所存。


# JavaFXのコントロールにイベントハンドラを紐付ける

イベントハンドラの紐付けに必要な処理は以下のステップで行います。

1. FXMLに紐付けるコントローラクラスを作成する。
1. FXMLとコントローラクラスを紐付ける。
1. FXMLのコントロールのイベントとコントローラクラスのメソッドを紐付ける。

参考：[Oracle - JavaFX: JavaFXスタート・ガイド 6 FXMLを使用したユーザー・インタフェースの作成
 (日本語)](https://docs.oracle.com/javase/jp/8/javafx/api/javafx/event/Event.htmll
)

## FXMLに紐付けるコントローラクラスを作成する。

これ、特に制限ないっぽいです。
どんなクラスでも設定できるようなので、とりあえず
[送信側ウィンドウを[LAN内通信アプリを作ろう　その２](https://qiita.com/Shiratori/items/6b101f49bd1c0e7a27d3)で作成したMainStage.javaを対象クラスにしてみます。

正直この実装微妙っぽい。
画面を出す処理と、画面の動作を規定する処理は分けるべきかも。

## FXMLとコントローラクラスを紐付ける。

Formと異なり、JavaFXでは画面レイアウト/コントロールの情報はXMLという形で保存されているため、このままでは動作と紐付けることが出来ません。
解決方法はシンプルで、FXMLに動作を紐付けるクラスを記述してやればOK。
ってことで早速。

* SceneBuilderを利用する方法
* FXMLファイルを直接変更する方法

の二通りのやり方があるようなのでそれぞれ記載。

### SceneBuilderを利用する方法

これ、ものすごく簡単。

1. SceneBuilderを起動して、紐付けを行いたいFXMLファイルを開く。
1. 画面左下の[Document]アコーディオンの下部にある[Controller]タブをクリックし、表示させる。
![03_01_ScrnrBuilder_01.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/4368611e-9434-6ea3-886e-923f6e929b6a.jpeg)
1. [Controller class]テキストボックスに紐付けたいクラスを入力する。
([▼]ボタンを押下すると、候補のクラスを表示してくれる)
![03_01_ScrnrBuilder_02.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/e98495e5-4a7d-29da-1eb1-a0ca9ff992a8.jpeg)

### FXMLファイルを直接変更する方法

こっちも簡単。

1. rootとなるコンテナ(今回はGridPane)にコントロールクラスを示すパラメータfx:controllerを追記するだけ。具体的には
fx:controller = "紐付けたいコントロールクラスのクラス名（パッケージ名込み）"

具体的にはこんな感じ

```MainStage.fxml
<GridPane minHeight="-Infinity" minWidth="-Infinity" prefHeight="200.0" prefWidth="400.0" xmlns="http://javafx.com/javafx/8.0.111" xmlns:fx="http://javafx.com/fxml/1" fx:controller="kugui.owd.privateMessenger.stage.MainStage">
```

## FXMLのコントロールのイベントとコントローラクラスのメソッドを紐付ける。

クラスを紐づけたら今度はコントロールの各種イベントと、コントローラクラスのメソッドを紐付け。
こちらはメソッドに以下の制限がある模様。

* メソッド宣言時、アクセスレベルがpublicで無い場合は"@FXML"アノテーションを記述する必要がある。
* 紐付けるイベント毎に適切な型である必要がある。
  [Oracle - Javafxドキュメンテーション パッケージ Event (日本語)]https://docs.oracle.com/javase/jp/8/javafx/api/javafx/event/package-summary.html
)
[Oracle - Javafxドキュメンテーション クラスEvent (日本語)](https://docs.oracle.com/javase/jp/8/javafx/api/javafx/event/Event.htmll
)

今回はこんなメソッドを準備してみました。

```MainStage.java
	@FXML
	private void btnSend_Click(ActionEvent event) {
		
		System.out.println( "btnSend is clicked!");
		
		return;
	}

```

こちらも設定方法を二通り記載。

* SceneBuilderを利用する方法
* FXMLファイルを直接変更する方法

### SceneBuilderを利用する方法

これもシンプル。

1. SceneBuilderを起動して、紐付けを行いたいFXMLファイルを開く。
1. イベントを紐付けたいコントローラを選択状態にする、(今回は[Send]ボタン)
![03_01_ScrnrBuilder_03.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/8f7eb2f8-fc1f-4223-98c6-96bd44328af4.jpeg)

1. 画面右側のInspectorアコーディオンから[Code]タブをクリック。
![03_01_ScrnrBuilder_04.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/55383e81-2f2f-262b-d1c7-11589b48d4e6.jpeg)

1. 紐付けたいメソッドを関連するイベントのテキストボックスに入力(今回はOnActionイベント。Clickイベントに相当する)
([▼]ボタンを押下すると、候補のメソッドを表示してくれる)

![03_01_ScrnrBuilder_05.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/1ae7b36a-ce30-2324-2b9c-49676bb6c92c.jpeg)


### FXMLファイルを直接変更する方法

これもシンｐ(ry

1. 該当するコントロールに<<該当するイベント名(今回はonAction)>> = "#<<紐付けたいメソッド名(クラス、括弧不要。頭の#は必要)>>"と追記する。

具体的にはこんな感じ

```MainStage.fxml

      <Button mnemonicParsing="false" onAction="#btnSend_Click" text="Send" GridPane.halignment="CENTER" GridPane.rowIndex="2" GridPane.valignment="CENTER" />
```

## イベントハンドラ　実装結果確認

ここまで出来たら紐付けが出来たか確認。

![2018y06m15d_065842800.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/c3808847-174a-d9b5-da84-d768569aa93e.jpeg)


## テキストボックスの中身を取得する

後はメッセージの内容と送信先の情報をとってソケットを送信すれば送信機能はＯＫ。
ってことで、JavaFXで作ったGUIのテキストボックスから内容を取得しましょ。

手順は以下のとおり

1. 触りたいJavaFxのコントロールにidを設定する。
1. IDを設定したコントロールと同一の型、名前を持つオブジェクトをクラス内で宣言する。
(publicにしない場合。@FXMLアノテーションをつける)

### 触りたいJavaFxのコントロールにidを設定する。

FXMLとjavaソースの間で整合性を取るためにidを設定しなきゃならない。

idの設定方法も２通り記述。

* SceneBuilderからIDを設定する場合
* FXMLファイルを直接書き換える場合

#### SceneBuilderからIDを設定する場合

シン(ry

1. SceneBuilderを起動して、紐付けを行いたいFXMLファイルを開く。
1. イベントを紐付けたいコントローラを選択状態にする、(今回はSendToテキストフィールド)
1. [Inspector アコーディオン]-[Codeタブ]をクリック
1. [Identity]の項目のfx:idテキストボックスの中身にid(オブジェクト名)を入力
![2018y06m15d_092733431.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/b89a56d6-6758-65cd-7b1e-7f82255ce3b8.jpeg)

ほとんど上のイベントハンドラの部分と同じなので写真はちょっと省略。

#### FXMLファイルを直接書き換える場合

1. 該当のコントロールにfx:id属性の記述を、値を変数名として追記する。

具体的にはこんな感じ

```MainStage.fxml
      <TextArea fx:id="txaMessage" prefHeight="200.0" prefWidth="200.0" promptText="Input send message..." GridPane.rowIndex="1" />
```

### IDを設定したコントロールと同一の型、名前を持つオブジェクトをクラス内で宣言する。

クラスの中で宣言するだけなんだけど、具体的にはこんな感じ。

```MainStage.java

追加したインポート：import javafx.scene.control.*;

public class MainStage extends Application {
	
	@FXML private TextArea txaMessage;
	@FXML private TextField txfSendTo;

（後略）

```


## 取得結果の確認

あて先となるIPアドレスを入力するTextField:txfSendTo(javafx.control.TextField)と、メッセージを入力するTextArea:txaMessage(javafx.control.TextArea)の取得結果をprintlnで出してみる。

ボタン押下時のイベントハンドラをこんな感じに改変

```MainStage.java

	@FXML
	private void btnSend_Click(ActionEvent event) {
		
		System.out.println( "btnSend is clicked!");
		System.out.println( String.format("SendTo : %s ", txfSendTo.getText() ));
		System.out.println( String.format("Message : %s ", txaMessage.getText() ));
		
		return;
	}

```


以下結果。

![2018y06m15d_094621205.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/e94d927e-6949-3ebf-e432-33ea456b10a1.jpeg)

これでGUIからの情報はOK。

次行きましょ。

# ソケット通信によるメッセージ送受信機能を作成する

前の記事と同じ感じでやっていきましょ。
今回送信側のポートは特に指定しないことにします。
特にこだわりないしね。

ってことでサクッと新規に送信用クラスを作りましょ。

## 送信用クラスを実装。


処理の流れはこんな感じ

1. ソケット作る
2. 送信先とTCPコネクションを確立する (clientSocket.connect()のところ)
3. DataOutputStreamを介して送信ポートにメッセージを送る（今回は文字列"TestMessage"）
4. ソケットを閉じる。

targetIPについてはsetTargetIPメソッドで設定するように設定。



```TxThread.java

package kugui.owd.privateMessenger;

import java.io.*;
import java.net.*;

public class TxThread extends Thread {
	
	private String targetIP;
	
	
	public void run() {
		
		int port = 80;
		int timeout = 10000;
		
		Socket clientSocket = new Socket();
		
		try {
			
			clientSocket.connect(new InetSocketAddress(targetIP, port), timeout);
			
			DataOutputStream dos = new DataOutputStream(clientSocket.getOutputStream());
			dos.writeUTF("TestMessage");
			dos.close();
			
		}catch(IOException ie) {
			
			ie.printStackTrace();
			
		}
		
		try {
			
			clientSocket.close();
			
		}catch(IOException ie) {
			
			ie.printStackTrace();
			
		}
		
		return;
	}
	
	public void setTargetIP(String pIP) {
		targetIP = pIP;
		return;
	}
	
}
```

バレてるかもしれませんが、前の記事で作ったRxThread.javaの流用だったりします。

## 動作確認

では実際に指定したIPアドレスにデータが遅れるか見てみましょ。
前回の状態だと「指定したポートにアクセスがあったか？」くらいしか見てなかったので
受信処理を少し書き足してみました。

以下の機能が追加されてます。

+ 一定時間ごとにポートの監視をタイムアウトし、他のスレッドからinterrupt()されていた場合、本スレッドを終了させる。
+ 受信したデータをコンソールに出力する。


```RxThread.java
package kugui.owd.privateMessenger;

import java.io.*;
import java.net.*;

public class RxThread extends Thread {

	public void run() {

		int port = 80; // test用。
		int timeout = 1000;
		ServerSocket sSocket;

		try {

			sSocket = new ServerSocket(port);
			sSocket.setSoTimeout(timeout);
			
			System.out.println(String.format("start listening port　%d", port));

			while (true) {

				try {
					int length = 0;
					
					DataInputStream dis = new DataInputStream(sSocket.accept().getInputStream());
					
					System.out.println(String.format("IP %d port %d : socket accept", sSocket.getInetAddress().toString() ,port));

					
					while(true) {
						
						byte[] buffer = new byte[1024];
						length = dis.read(buffer);
						if( length > 0 ) {
							
							System.out.print(new String(buffer));
							
						}else {
							break;
						}
						
					}
					
					
					dis.close();

				} catch (SocketTimeoutException se) {

					if (interrupted() == true) {

						break;

					} else {

						/* no operation */

					}
				}
			}

		} catch (IOException ioE) {

			ioE.printStackTrace();

		}

		System.out.println("finished");

		return;
	}

}
```

この状態でブラウザからlocalhostに接続するとこんな風になります。

![03_01_HTTP_REQUEST.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/50057159-d401-7dfc-f813-c0f0e14b3785.jpeg)

ちゃんとHTTPリクエストの中身が表示されてるのが確認できました。

次はSendToテキストフィールドにlocalhostを入力し、送信ボタンを押下するとこんな結果に。
![2018y06m15d_115147834.jpg](https://qiita-image-store.s3.amazonaws.com/0/259679/a7c673ec-3955-3e5b-9af6-9114cb33888a.jpeg)

メッセージの受け取りまでは出来ている様子です。

__ただし、たまにメッセージが途切れる問題が発生しています。__
~~まあ、現行だと受信ソケットから情報引き出せない場合問答無用で読み取り終わらせてますからね。~~



ってことで、少し休んだら残りの作業

* メッセージ部分の受信
* 受信したメッセージの表示（受信ウィンドウの作成）
* 受信処理の改修

をやっていくことにします。
一回区切りましょうかね。今回の作業時間は05:20:20でした。