【Java】SocketChannelを利用したサーバと複数クライアント間のTCP通信

2018年6月9日

以前の記事で基本的なTCPソケット通信のサンプルを紹介しましたが、今回はノンブロッキングで処理できるSocketChannelによるTCP通信処理についてみていきます。

SocketChannelクラスはByteBuffer経由でデータのやり取りを行いますので、それに関してはこちらの記事を参考にしてください。ByteBufferはバイナリ操作が楽になるクラスなので覚えておいて損はないはずです。

内容



SocketChannel

SocketChannelクラスはノンブロッキングで通信処理を行うことができるクラスです。通常のSocket通信では受信処理でスレッドが待機しますが、configureBlockingメソッドにfalseを設定すると、受信待機を行いません。受信ブロックを回避するためのスレッドを生成する必要がないわけですね。

  1. SocketChannel channel = SocketChannel.open(new InetSocketAddress(ホスト名, ポート番号));

のようにプログラムを作ると指定したPCと通信ができるインスタンスを構築できます。

受信処理はread(ByteBuffer)メソッドを実行することで実装可能です。

送信処理はwrite(ByteBuffer)メソッドを実行することで実装可能です。

 

通信を切断する場合はcloseメソッドを呼び出しましょう。

ServerSocketChannel

ServerSocketChannelクラスはサーバ側実装に使用するSocketChannelクラスです。こちらも接続受付時のスレッド待機を無効化できます。接続待機をノンブロッキング化するにはconfigureBlockingメソッドでfalseに設定しましょう。

  1. ServerSocketChannel channel = ServerSocketChannel.open();
  2. channel.socket().bind(new InetSocketAddress(ポート番号));//受信ポートを指定

のように記述することで初期処理を行います。

acceptメソッドで接続を待ち受けます。

Socketクラスと同じ感じで、acceptメソッドの戻り値がSocketChannelとなり、このインスタンスでクライアントとデータをやり取りできます。

ServerSocketChannelを終了する場合はcloseメソッドを呼び出しましょう。

クライアントサーバー間をやり取りする簡単なサンプル

上記で説明したSocketChannelを使用し、クライアントサーバー通信をテストする簡単なプログラムを紹介します。とりあえず動作させたい場合は参考にしてみてください。

私の環境では同一PCでのテストも別のPC間でのテストも成功しました。

別のPCで接続テストを行いたい場合はまずIPアドレスを調べて、クライアントのホスト名指定で設定する必要があります。また、セキュリティの関係上ポート解放が必要なケースがあります。手っ取り早く試したい場合はファイアウォールを一時的に無効化し、試すのが簡単です。テストが終了した後は、必ずファイアウォールを有効化し直しておいてください。

IPアドレスを調べる方法

ファイアウォールの有効無効設定方法

クライアント側

Client.java
  1. import java.io.IOException;
  2. import java.net.InetSocketAddress;
  3. import java.nio.ByteBuffer;
  4. import java.nio.channels.SocketChannel;
  5. import java.util.Scanner;
  6.  
  7. public class Client {
  8.  
  9. 	public static void main(String[] args) {
  10. 		try{
  11. 			//送信アドレスとポートを指定
  12. 			SocketChannel channel = SocketChannel.open(new InetSocketAddress("localhost", 10007));
  13. 			//SocketChannel channel = SocketChannel.open(new InetSocketAddress("192.168.11.21", 10007));//別PC間で通信したい場合IPやドメイン指定
  14. 			
  15. 			//送信バッファデータを構築(今回はint型をテストするので最低4バイトを確保)
  16. 			ByteBuffer bb = ByteBuffer.allocate(4);
  17. 			
  18. 			//操作説明
  19. 			System.out.println("送信する数値を入力してEnterで送信します。");
  20. 			
  21. 			//数値を入力させる(オーバーフローなどは考慮していない)
  22. 			bb.putInt(new Scanner(System.in).nextInt());
  23. 			
  24. 			//送信準備を行う
  25. 			bb.flip();
  26. 			
  27. 			//送信処理
  28. 			channel.write(bb);
  29. 			
  30. 			//切断
  31. 			channel.close();
  32. 			
  33. 			//送信データを表示します
  34. 			System.out.println("送信:"+bb.getInt(0));
  35. 		}catch(IOException e){
  36. 			e.printStackTrace();
  37. 		}
  38. 	}
  39. }

サーバー側

Server.java
  1. import java.io.IOException;
  2. import java.net.InetSocketAddress;
  3. import java.nio.ByteBuffer;
  4. import java.nio.channels.SocketChannel;
  5. import java.nio.channels.ServerSocketChannel;
  6.  
  7. public class Server {
  8.  
  9. 	public static void main(String[] args) {
  10. 		try{
  11. 			//サーバーソケットの開始
  12. 			ServerSocketChannel channel = ServerSocketChannel.open();
  13. 			
  14. 			//受信ポートを指定
  15. 			channel.socket().bind(new InetSocketAddress(10007));
  16. 			
  17. 			//接続待機
  18. 			SocketChannel sc = channel.accept();
  19. 			
  20. 			//バッファデータ(バイト配列)を作成（今回は4バイトのint型のみをテスト）
  21. 			ByteBuffer bb = ByteBuffer.allocate(4);
  22. 			
  23. 			//バッファ(バイト配列)に受信データを読み込み
  24. 			sc.read(bb);
  25. 			
  26. 			//ソケットチャンネルクローズ
  27. 			sc.close();
  28. 			
  29. 			//サーバーチャンネルクローズ
  30. 			channel.close();
  31. 			
  32. 			//intデータを受信データの0バイト目から読み込み
  33. 			System.out.println("受信:"+bb.getInt(0));
  34. 		}catch(IOException e){
  35. 			e.printStackTrace();
  36. 		}
  37. 	}
  38. }
クライアント実行結果

送信する数値を入力してEnterで送信します。
345
送信:345

サーバー実行結果

受信:345

サンプルはサーバーを実行してからクライアントを実行してください。

セレクタの利用

ノンブロッキングでの通信処理を実装するための手助けをしてくれるクラス群が存在します。これらは接続要求が来たかどうかや、メッセージが送信されたかどうかなどを、複数のSocketChannelの監視をすることにより、検出します。

何らかの通信イベントが発生するまで、スレッドをブロックしたり、スレッドブロックなしで、要求があるかを判断できる機能などがあり、用途によって使い分けられます。

この機能はSelectableChannelが実装されたクラスはすべて利用できます。SocketChannelやServerSocketChannelもSelectableChannelを実装しています。

SelectableChannelにはregisterメソッドがあり、コレで接続要求監視を登録したり、受信データ監視を登録できます。

registerにはSelectorと監視タイプを指定します。

登録後に要求を受けた場合、SelectorのselectメソッドやselectNowメソッドがイベント数を返します。

selectメソッドは要求があるまでスレッド待機を行い、selectNowメソッドは要求があろうがなかろうが待機しません。

  1. ServerSocketChannel channel = ServerSocketChannel.open();
  2. channel.socket().bind(new InetSocketAddress(10009));//受信ポートを指定
  3. channel.configureBlocking(false);//ノンブロックの有効化
  4. Selector sel = Selector.open();
  5.  
  6. //接続要求監視を登録
  7. channel.register(sel, SelectionKey.OP_ACCEPT);
  8.  
  9. //接続要求があるまでスレッド待機
  10. while(sel.select()>0){
  11.  
  12. 	//発生したイベントを取得
  13. 	Iterator it = sel.selectedKeys().iterator();
  14. 	while(it.hasNext()) {
  15. 		SelectionKey key = it.next();
  16. 		it.remove();
  17. 		if ( key.isAcceptable() ) {
  18. 			//接続処理
  19. 		}
  20. 	}
  21. }

次のサンプルで実際に使用する場合のテストプログラムを用意しておりますので、そちらも参考にしていただければと思います。



 

サーバと複数クライアントを接続して送信メッセージをアニメーションで表示させてみる

せっかくノンブロッキングでの通信処理の実装を勉強したので、今回紹介した内容を有効活用した通信プログラムを簡単に作成してみました。

クライアント側からメッセージを入力してEnterを押下してもらうと、JFrameで実装したサーバー側プログラムに受信したメッセージが流れ始めるというプログラムになります。

複数のクライアント端末と同時に接続できるようにしています。試すのが面倒な方は実行結果の動画も用意しているので、そちらをご覧ください。

クライアント側

Client.java
  1. import java.io.IOException;
  2. import java.net.InetSocketAddress;
  3. import java.nio.ByteBuffer;
  4. import java.nio.channels.SocketChannel;
  5. import java.util.Scanner;
  6. import java.nio.charset.StandardCharsets;
  7.  
  8. public class Client {
  9.  
  10. 	public static void main(String[] args) {
  11. 		try(
  12. 			SocketChannel channel = SocketChannel.open(new InetSocketAddress("localhost", 10009));//ローカルで試す場合こっち
  13. 			//SocketChannel channel = SocketChannel.open(new InetSocketAddress("192.168.111.26", 10009));//接続先指定
  14. 			Scanner sc = new Scanner(System.in);//標準入力
  15. 		){
  16.  
  17. 			System.out.println("送信する文字列を入力してEnterで送信します。ENDで終了します。");
  18. 			String text = null;
  19. 			
  20. 			//ENDが入力されるまで入力文字をサーバーに送信する
  21. 			while(!"END".equalsIgnoreCase(text = sc.next())) {
  22. 				ByteBuffer bb = StandardCharsets.UTF_8.encode(text);
  23. 				channel.write(bb);//送信
  24. 				System.out.println("送信:"+text);
  25. 			}
  26. 		} catch (IOException e) {
  27. 			System.out.println("切断されました。");
  28. 			e.printStackTrace();
  29. 		}
  30. 	}
  31. }

サーバー側

Server.java
  1. import java.awt.Graphics;
  2. import java.io.IOException;
  3. import java.net.InetSocketAddress;
  4. import java.nio.ByteBuffer;
  5. import java.nio.channels.SelectionKey;
  6. import java.nio.channels.Selector;
  7. import java.nio.channels.ServerSocketChannel;
  8. import java.nio.channels.SocketChannel;
  9. import java.nio.charset.StandardCharsets;
  10. import java.util.Iterator;
  11. import java.util.LinkedList;
  12. import java.util.Random;
  13.  
  14. import javax.swing.JFrame;
  15. import javax.swing.JPanel;
  16.  
  17. public class Server {
  18.  
  19. 	public static void main(String[] args) throws IOException {
  20. 		new Thread(new TestWindow()).start();
  21. 	}
  22.  
  23. 	static class TestWindow extends JFrame implements Runnable{
  24. 		LinkedList comments = new LinkedList<>();
  25. 		ServerSocketChannel channel;
  26. 		Selector sel;
  27. 		ByteBuffer bb = ByteBuffer.allocate(1024);
  28. 		Random rand = new Random();
  29. 		public TestWindow() {
  30. 			setSize(640,480);
  31. 			add(new DrawCanvas());
  32. 			setVisible(true);
  33. 			initServer();
  34. 		}
  36. 		//サーバーソケットの開始
  37. 		void initServer(){
  38. 			try{
  39. 				channel = ServerSocketChannel.open();
  40. 				channel.socket().bind(new InetSocketAddress(10009));//受信ポートを指定
  41. 				channel.configureBlocking(false);
  42. 				sel = Selector.open();
  44. 				//接続要求を監視
  45. 				channel.register(sel, SelectionKey.OP_ACCEPT);
  46. 			} catch (IOException e) {
  47. 				System.out.println("サーバー開始エラー");
  48. 				e.printStackTrace();
  49. 			}
  50. 		}
  52. 		//接続受け付けメソッド
  53. 		void accept() {
  54. 			try {
  55. 				SocketChannel sc = channel.accept();
  56. 				if ( sc == null ) return;
  58. 				//非ブロックモードで接続リストに追加
  59. 				sc.configureBlocking(false);
  61. 				//受信を監視
  62. 				sc.register(sel, SelectionKey.OP_READ);
  63. 			} catch (IOException e) {
  64. 				e.printStackTrace();
  65. 			}
  66. 		}
  68. 		//データ受信メソッド
  69. 		void recv(SocketChannel sc) {
  70. 			try {
  71. 				//接続していないなら閉じる
  72. 				if ( !sc.isConnected() ) {
  73. 					System.out.println("接続終了");
  74. 					sc.close();
  75. 				}
  76. 				//バイナリ受信領域初期化
  77. 				bb.clear();
  78. 				
  79. 				//受信
  80. 				sc.read(bb);
  81. 				
  82. 				//ロード準備
  83. 				bb.flip();
  84. 				
  85. 				//文字列に変換
  86. 				String result = StandardCharsets.UTF_8.decode(bb).toString();
  87. 				if ( result.length() > 0 ) {
  88. 					System.out.println("受信:"+result);
  90. 					//ランダムな位置でメッセージを出現させる
  91. 					comments.add(new Comment(640, rand.nextInt(380)+50, result));
  92. 				}
  93. 			}catch(IOException e) {
  94. 				try {
  95. 					System.out.println("接続終了");
  96. 					sc.close();
  97. 				} catch (IOException e1) {}
  98. 			}
  99. 		}
  101. 		//通信処理
  102. 		void networkLogic() {
  103. 			try {
  104. 				//イベントが発生している場合は処理させます
  105. 				while(sel.selectNow()>0){
  106. 					Iterator it = sel.selectedKeys().iterator();
  107. 					while(it.hasNext()) {
  108. 						SelectionKey key = it.next();
  109. 						it.remove();
  110. 						if ( key.isAcceptable() ) {
  111. 							accept();
  112. 						} else if ( key.isReadable() ) {
  113. 							recv((SocketChannel) key.channel());
  114. 						}
  115. 					}
  116. 				}
  117. 			} catch (IOException e) {
  118. 				e.printStackTrace();
  119. 			}
  120. 		}
  122. 		//アニメーションループ
  123. 		@Override
  124. 		public void run() {
  125. 			while(true) {
  126. 				try {
  127. 					Thread.sleep(40);
  128. 					networkLogic();
  129. 					repaint();
  130. 				} catch (InterruptedException e) {
  131. 					e.printStackTrace();
  132. 				}
  133. 			}
  134. 		}
  136. 		//描画キャンバス
  137. 		class DrawCanvas extends JPanel{
  139. 			//描画
  140. 			public void paintComponent(Graphics g) {
  141. 				super.paintComponent(g);
  142. 				Iterator it = comments.iterator();
  143. 				while(it.hasNext()) {
  144. 					Comment comment = it.next();
  145. 					g.drawString(comment.comment, comment.x, comment.y);
  146. 					if ( comment.x + g.getFontMetrics().stringWidth(comment.comment) < 0 ) {
  147. 						it.remove();
  148. 					} else {
  149. 						comment.x--;
  150. 					}
  151. 				}
  152. 			}
  153. 		}
  155. 		//メッセージ情報
  156. 		class Comment{
  157. 			int x;
  158. 			int y;
  159. 			String comment;
  160. 			Comment(int x, int y, String comment){
  161. 				this.x = x;
  162. 				this.y = y;
  163. 				this.comment = comment;
  164. 			}
  165. 		}
  166. 	}
  167. }
実行結果

実行結果の動画では右上、右下、左下のウィンドウがクライアントで左上がサーバープログラムです。3台のクライアントと1台のサーバーを想定したテスト動画となっております。

画質悪いのはごめんなさいm(_ _)m

Java

Posted by nompor