チャットアプリ

Size: px

Start display at page:

Download "チャットアプリ"

ほだかちゅうか
5 years ago
Views:

チャットアプリ Socket クラスに依る TCP 非同期通信の方法複数のクライアントが同時に接続出来る TCP を利用したクライアントサーバー型チャットアプリケーションを TcpClient と TcpListener クラスを使わずに Socket クラスを使って作る方法を紹介する初めに此処では複数のクライアントが同時に接続出来る TCP

1 チャットアプリ Socket クラスに依る TCP 非同期通信の方法複数のクライアントが同時に接続出来る TCP を利用したクライアントサーバー型チャットアプリケーションを TcpClient と TcpListener クラスを使わずに Socket クラスを使って作る方法を紹介する初めに此処では複数のクライアントが同時に接続出来る TCP を利用したクライアントサーバー型チャットアプリケーション (DOBON Chat) のサンプルを示し其の要点を解説する.NET Framework では TCP を利用したデータ通信を行う為のクラスとして TcpClient 及び TcpListener クラス ( 共に System.Net.Sockets 名前空間 ) が用意されて居る此等のクラスは内部で Socket クラス (System.Net.Sockets 名前空間 ) を使用して居り Socket クラスをより簡単に扱える様にする為のクラスで有ると謂える併し Socket クラスを直接扱う場合と比べて機能的に劣り而も取り扱いの難しさも然程変わらない其処で此処では TcpClient と TcpListener クラスを使わずに Socket クラスを使ってサーバーとクライアントを作成して居る (TcpClient と TcpListener を使用した簡単なサンプルは DOBON.NET.NET Tips - TCP クライアントサーバープログラムを作成するに有る ) 対象読者.NET でのネットワークプログラミング ( 特にソケットを使った TCP 非同期通信 ) に興味が有る方を対象として居る但し此処ではネットワークや.NET プログラミングの基本的な事柄に付いては説明しないので不明な点は MSDN ライブラリ等で調べて欲しい -1-

2 必要な環境サンプル (DobonChat) は Visual Studio.NET 2003 で作成され.NET Framework 1.1 で動作確認をして居るが.NET Framework 1.0 でも問題なく動作すると思うクライアントの作成クライアントはサーバーに接続しデータの送受信を行う Socket クラスの場合データの送信には Send 受信には Receive メソッドを使えば簡単で有る ( 巻末に一例が有る ) 併しチャットアプリケーションの場合少なくとも Receive メソッドを其の儘呼び出す訳には行かない Receive メソッドはデータを受信する迄スレッドをブロックする為 ( ブロッキングモードの場合 ) 其の間データの送信はおろか何も出来なく成る何時データが送られて来るか解らないチャットでは常にデータの受信を待機して居なければ成らない為此れは致命的で有るデータの受信を待機しつゝ送信も出来る様にするにはポーリングに依る方法 ( 参考資料 3) や Socket クラスの非同期メソッドに依る方法 ( 参考資料 1,2) が有るポーリングに依る方法では Socket.Poll メソッド ( 又は Available プロパティ ) でデータの読み取りが可能かループやタイマーで監視し読み取れると判断出来れば Receive メソッドで受信する様にするポーリングは此の様に無駄なループを繰り返す為 CPU に負担を懸けると謂う欠点が有る一方非同期メソッドに依る方法では Socket の BeginReceive と EndReceive メソッドを使用する此処では此の方法を採用して居る非同期受信では先ず BeginReceive メソッドを呼び出す事に依りデータの受信が開始される Receive メソッドではデータを受信しない限り処理が次へ進まないが BeginReceive メソッドは直ぐに終了しブロックしない BeginReceive を呼び出した後にデータを受信すると指定したコールバックメソッドが実行される此のコールバックメソッドで EndReceive メソッドを呼び出しデータを受信し再び BeginReceive メソッドを呼び出して非同期受信を再開する様にする以下に非同期メソッドを使ってデータを受信する簡単な例を示す Connect メソッドを使って既にサーバーと接続して居る Socket を此の StartReceive メソッドに渡す事に依りデータの非同期受信が開始されデータを受信すると UTF-8 でデコードしコンソールに出力して居る VB ' 非同期データ受信の為の状態オブジェクト Private Class AsyncStateObject Public Socket As System.Net.Sockets.Socket Public ReceiveBuffer() As Byte Public ReceivedData As System.IO.MemoryStream Public Sub New(ByVal soc As System.Net.Sockets.Socket) Me.Socket = soc Me.ReceiveBuffer = New Byte(1023) Me.ReceivedData = New System.IO.MemoryStream End Sub End Class ' データ受信スタート -2-

3 Private Shared Sub StartReceive _ (ByVal soc As System.Net.Sockets.Socket) Dim so As New AsyncStateObject(soc) ' 非同期受信を開始 soc.beginreceive(so.receivebuffer, 0, so.receivebuffer.length, _ System.Net.Sockets.SocketFlags.None, _ New System.AsyncCallback(AddressOf ReceiveDataCallback), so) End Sub ' BeginReceive のコールバック Private Shared Sub ReceiveDataCallback(ByVal ar As System.IAsyncResult) ' 状態オブジェクトの取得 Dim so As AsyncStateObject = CType(ar.AsyncState, AsyncStateObject) ' 読み込んだ長さを取得 Dim len As Integer = 0 Try len = so.socket.endreceive(ar) Catch ex As System.ObjectDisposedException ' 閉じた時 System.Console.WriteLine(" 閉じました ") Return End Try ' 切断されたか調べる If len <= 0 Then System.Console.WriteLine(" 切断されました ") so.socket.close() Return End If ' 受信したデータを蓄積する so.receiveddata.write(so.receivebuffer, 0, len) If so.socket.available = 0 Then ' 最後迄受信した時受信したデータを文字列に変換 Dim str As String = _ System.Text.Encoding.UTF8.GetString(so.ReceivedData.ToArray()) ' 受信した文字列を表示 System.Console.WriteLine(str) so.receiveddata.close() so.receiveddata = New System.IO.MemoryStream End If ' 再び受信開始 so.socket.beginreceive(so.receivebuffer, 0, _ so.receivebuffer.length, _ System.Net.Sockets.SocketFlags.None, _ New System.AsyncCallback(AddressOf ReceiveDataCallback), so) -3-

4 End Sub C# // 非同期データ受信の為の状態オブジェクト private class AsyncStateObject public System.Net.Sockets.Socket Socket; public byte[] ReceiveBuffer; public System.IO.MemoryStream ReceivedData; public AsyncStateObject(System.Net.Sockets.Socket soc) this.socket = soc; this.receivebuffer = new byte[1024]; this.receiveddata = new System.IO.MemoryStream(); // データ受信スタート private static void StartReceive(System.Net.Sockets.Socket soc) AsyncStateObject so = new AsyncStateObject(soc); // 非同期受信を開始 soc.beginreceive(so.receivebuffer, 0, so.receivebuffer.length, System.Net.Sockets.SocketFlags.None, new System.AsyncCallback(ReceiveDataCallback), so); // BeginReceive のコールバック private static void ReceiveDataCallback(System.IAsyncResult ar) // 状態オブジェクトの取得 AsyncStateObject so = (AsyncStateObject) ar.asyncstate; // 読み込んだ長さを取得 int len = 0; try len = so.socket.endreceive(ar); catch (System.ObjectDisposedException) // 閉じた時 System.Console.WriteLine(" 閉じました "); return; -4-

5 // 切断されたか調べる if (len <= 0) System.Console.WriteLine(" 切断されました "); so.socket.close(); return; // 受信したデータを蓄積する so.receiveddata.write(so.receivebuffer, 0, len); if (so.socket.available == 0) // 最後迄受信した時受信したデータを文字列に変換 string str = System.Text.Encoding.UTF8.GetString( so.receiveddata.toarray()); // 受信した文字列を表示 System.Console.WriteLine(str); so.receiveddata.close(); so.receiveddata = new System.IO.MemoryStream(); // 再び受信開始 so.socket.beginreceive(so.receivebuffer, 0, so.receivebuffer.length, System.Net.Sockets.SocketFlags.None, new System.AsyncCallback(ReceiveDataCallback), so); 此処で注意しなければ成らないのがコールバックメソッドは初めに BeginReceive を呼び出したスレッドとは別のスレッドで実行されると謂う事で有る詰りスレッドの同期が必要に成るケースが充分有り得る例えば Socket クラスはスレッドセーフではないので上記の様な非同期受信を行い乍 Send メソッド等を呼び出す場合には lock(vb.net では SyncLock) 等を使用してスレッドの同期を行う必要が有ると謂う事に成る ( 実際に此の様にして居るサンプルは殆ど見ないが ) 亦受信したデータをテキストボックスに表示する場合等コールバックメソッドからコントロールのメソッドを呼び出す時は Invoke メソッド ( 又は BeginInvoke メソッド ) を使用してコントロールのスレッドにマーシャリングする Socket クラスにはデータの受信以外にリモートホストへの接続 (BeginConnect EndConnect メソッド ) データの送信 (BeginSend EndSend メソッド ) の為の非同期メソッドも用意されて居るサーバーの作成サーバーでは Socket.Bind メソッドでバインドし Listen メソッドでクライアントの接続を待機し Accept メソッドで接続を受け入れると謂うのが基本的な流れで有る併し Accept メソッドは接続要 -5-

6 求がない限りブロックし続けて了う此の対処法としては先程と同様にポーリング ( 参照資料 3) 非同期メソッド ( 参照資料 2) 更にスレッド化 ( 参照資料 1) と謂った方法が考えられるポーリングでは先と同じく Poll メソッドで接続の要求がないかループで監視し有れば Accept メソッドで受け入れる様にするスレッド化に依る方法では Accept メソッドの呼び出しを別のスレッドで行う様にする ( 此の方法では接続の待機を中止する為にスレッドセーフでない Socket クラスの Close メソッドを別のスレッドから呼び出す事に成る ) DOBON Chat では非同期メソッドの BeginAccept EndAccept メソッドを使用して居る以下に BeginAccept メソッドを使った簡単な例を示す Listen メソッドが既に呼び出されて居る Socket を此の StartAccept メソッドに渡す事に依りクライアントからの接続を非同期で待機する VB ' クライアントの接続待ちスタート Private Shared Sub StartAccept(ByVal server As System.Net.Sockets.Socket) ' 接続要求待機を開始する server.beginaccept(new System.AsyncCallback(AddressOf AcceptCallback), server) End Sub ' BeginAccept のコールバック Private Shared Sub AcceptCallback(ByVal ar As System.IAsyncResult) ' サーバー Socket の取得 Dim server As System.Net.Sockets.Socket = CType(ar.AsyncState, System.Net.Sockets.Socket) ' 接続要求を受け入れる Dim client As System.Net.Sockets.Socket = Nothing Try ' クライアント Socket の取得 client = server.endaccept(ar) Catch System.Console.WriteLine(" 閉じました ") Return End Try ' クライアントが接続した時の処理を此処に書く ' 此処では文字列を送信して直ぐに閉じて居る client.send(system.text.encoding.utf8.getbytes(" こんにちは ")) client.shutdown(system.net.sockets.socketshutdown.both) client.close() ' 接続要求待機を再開する server.beginaccept(new System.AsyncCallback(AddressOf AcceptCallback), server) End Sub C# // クライアントの接続待ちスタート private static void StartAccept(System.Net.Sockets.Socket server) -6-

7 // 接続要求待機を開始する server.beginaccept(new System.AsyncCallback(AcceptCallback), server); // BeginAccept のコールバック private static void AcceptCallback(System.IAsyncResult ar) // サーバー Socket の取得 System.Net.Sockets.Socket server = (System.Net.Sockets.Socket) ar.asyncstate; // 接続要求を受け入れる System.Net.Sockets.Socket client = null; try // クライアント Socket の取得 client = server.endaccept(ar); catch System.Console.WriteLine(" 閉じました "); return; // クライアントが接続した時の処理を此処に書く // 此処では文字列を送信して直ぐに閉じて居る client.send(system.text.encoding.utf8.getbytes(" こんにちは ")); client.shutdown(system.net.sockets.socketshutdown.both); client.close(); // 接続要求待機を再開する server.beginaccept( new System.AsyncCallback(AcceptCallback), server); EndAccept メソッドに依り接続したクライアントとの通信に使用する Socket オブジェクトが返される上記のコードでは接続したクライアントに文字列を UTF-8 でエンコードしたデータを送信し直ぐに接続を閉じて居るチャットアプリケーションのサーバーでは或るクライアントから受信したメッセージを接続中の総てのクライアントに送信する必要が有る此れは単純にクライアントからデータを受信したら接続中の一つ一つのクライアントの Socket.Send( 又は BeginSend) メソッドを呼び出してデータを送信する様にすれば良い独自のアプリケーションプロトコルの定義以上でチャットアプリケーションを作成する為の知識が揃いました此れで当初の目的には達したと謂って良い -7-

8 併し文字列の遣り取りが出来る様に成ったとは謂え此れ丈では実用的なチャットアプリケーションには程遠い現状ではクライアント側で現在チャットに参加して居るメンバーを表示する事も送られて来たメッセージを表示する時に其の送信者を併記する事も出来ないので有る更にプライベートメッセージ ( 指定した人にしかメッセージを送信しない ) 等の機能は何の様に実装すれば良いのか此の様に様々な機能を持つチャットアプリケーションを作成する為には予めサーバーとクライアントの間で機能に応じた決まりを用意して置く必要が有る此れはアプリケーション層プロトコルと呼ばれる物で有る此の決まりは極簡単な物で構わない ( ちゃんとした物を作るならば RFC 特にチャットアプリケーションでは IRC が参考に成るだろう ) 良く有る決まりの形式は文字列のコマンドと一つ以上のパラメータから成り夫々をスペース文字で区切り CR-LF( キャリッジリターン + ラインフィード ) で終わると謂う物で有る例えばクライアントがプライベートメッセージを送信する時は PRIVMSG " メッセージの送信先 " " メッセージの内容 "CR-LF と謂う内容の文字列を UTF-8 でエンコードしたデータを送信すると決めて置く此の様にして置く事に依りサーバーは PRIVMSG で始まり CR-LF で終わる文字列を受信した時に其れがクライアントがプライベートメッセージの送信を要求して居る合図で有ると解りメッセージの内容と送信先を正しく理解する事が出来る同様にサーバーからクライアントへのプライベートメッセージの送信でも PRIVMSG " メッセージの送信者 " " メッセージの内容 "CR-LF と謂う決まりにして置けばクライアントが PRIVMSG で始めるデータを受信した時其のデータが自分丈に送られて来たプライベートメッセージで有り誰が何の様なメッセージを送って来たのかが解る此の様なコマンド ( 上記の例では PRIVMSG ) を増やして行く事に依り機能を拡張する事が出来る纏め此の記事では TCP を利用した複数クライアントが接続可能なチャットアプリケーションの作り方を説明したポイントを纏めると次の様に成るチャットアプリケーションでは長時間ブロックするメソッドの使用は厳禁で有る為 ( 例外有り ) 非同期メソッドの活用が有効で有る非同期メソッドに依り呼び出されるコールバックメソッドは個別のスレッドで実行される為スレッドの同期等の対策が必要と成る既存のアプリケーション層プロトコルを利用しないならば独自のアプリケーション層プロトコルを定義しなければ成らない -8-

9 参考資料 1.MSDN ライブラリ Creating a Multi-User TCP Chat Application 2.CodeGuru Asynchronous Socket Programming in C# 3.CSharpFriends.com Non-blocking Sockets (A Chat Program) 4.MSDN ライブラリ非同期クライアントソケットの使用 5.MSDN ライブラリ非同期サーバーソケットの使用 6.MSDN ライブラリ非同期クライアントソケットの例 7.MSDN ライブラリ非同期サーバーソケットの例

10 Socket を使って HTTP でファイルをダウンロードし表示する Socket クラスを使って HTTP サーバーに GET 要求し応答を受信する方法を具体例而巳示す通常は WebRequest WebResponse クラスを使ってファイルをダウンロードし表示するの様な方法で充分で有る説明は一切しないので興味のある方而巳参考にして欲しい VB ' GET リクエストを送信するサーバー名とパス Dim server As String = " Dim path As String = "/" ' リクエストメッセージを作成する Dim reqmsg As String = "GET " + path + " HTTP/1.1" + vbcrlf + _ "Host: " + server + vbcrlf + "Connection: Close" + vbcrlf + vbcrlf ' 文字列を byte 配列に変換 Dim enc As System.Text.Encoding = System.Text.Encoding.GetEncoding("shift_jis") Dim reqbytes As Byte() = enc.getbytes(reqmsg) ' ホスト名から IP アドレスを取得 Dim hostadd As System.Net.IPAddress = System.Net.Dns.Resolve(server).AddressList(0) ' 又は ' System.Net.IPAddress hostadd = System.Net.Dns.GetHostByName(server).AddressList(0) ' IPEndPoint を取得 Dim ephost As New System.Net.IPEndPoint(hostadd, 80) ' Socket の作成 Dim sock As New System.Net.Sockets.Socket( _ System.Net.Sockets.AddressFamily.InterNetwork, _ System.Net.Sockets.SocketType.Stream, _ System.Net.Sockets.ProtocolType.Tcp) ' 接続 sock.connect(ephost) ' リクエストメッセージを送信 sock.send(reqbytes, reqbytes.length, System.Net.Sockets.SocketFlags.None) ' 受信する Dim resbytes(1023) As Byte Dim mem As New System.IO.MemoryStream While True Dim ressize As Integer = _ sock.receive(resbytes, resbytes.length, System.Net.Sockets.SocketFlags.None) If ressize = 0 Then Exit While End If -10-

11 mem.write(resbytes, 0, ressize) End While Dim resmsg As String = enc.getstring(mem.getbuffer(), 0, CInt(mem.Length)) mem.close() ' 閉じる sock.shutdown(system.net.sockets.socketshutdown.both) sock.close() ' 受信したメッセージを表示する Console.WriteLine(resMsg) C# // GET リクエストを送信するサーバー名とパス string server = " string path = "/"; // リクエストメッセージを作成する string reqmsg = "GET " + path + " HTTP/1.1 r n" + "Host: " + server + " r n" + "Connection: Close r n r n"; // 文字列を byte 配列に変換 System.Text.Encoding enc System.Text.Encoding.GetEncoding("shift_jis"); byte [] reqbytes = enc.getbytes(reqmsg); // ホスト名から IP アドレスを取得 System.Net.IPAddress hostadd = System.Net.Dns.Resolve(server).AddressList[0]; // 又は // System.Net.IPAddress hostadd = System.Net.Dns.GetHostByName(server).AddressList[0]; // IPEndPoint を取得 System.Net.IPEndPoint ephost = new System.Net.IPEndPoint(hostadd, 80); // Socket の作成 System.Net.Sockets.Socket sock = new System.Net.Sockets.Socket( System.Net.Sockets.AddressFamily.InterNetwork, System.Net.Sockets.SocketType.Stream, System.Net.Sockets.ProtocolType.Tcp); // 接続 sock.connect(ephost); // リクエストメッセージを送信 sock.send(reqbytes, reqbytes.length, System.Net.Sockets.SocketFlags.None); // 受信する -11-

12 byte [] resbytes = new byte[1024]; System.IO.MemoryStream mem = new System.IO.MemoryStream(); while (true) int ressize = sock.receive(resbytes, resbytes.length, System.Net.Sockets.SocketFlags.None); if (ressize == 0) break; mem.write(resbytes, 0, ressize); string resmsg = enc.getstring(mem.getbuffer(), 0, (int) mem.length); mem.close(); // 閉じる sock.shutdown(system.net.sockets.socketshutdown.both); sock.close(); // 受信したメッセージを表示する Console.WriteLine(resMsg); -12-

プラグイン

プラグインプラグイン詳細 2 ~ プラグイン機能を持つテキストエディタの作成 ~ はじめに Adobe Photoshop や Becky! Internet Mail 等のアプリケーションではプラグイン ( 又はアドインエクステンション等 ) と呼ばれるプログラムをインストールする事に依り機能を拡張する事が出来る此の記事では此の様なプラグイン機能を持ったアプリケーションの作り方をプラグイン対応のテキストエディタを作成する事に依り