C#网络编程示例(note)

2021-07-16 23:13:07

在.net下进行网络编程其实也相对比较简单，因为在.net类库已经提供了大量封装好的类。在.net下网络编程比较底层的类是System.Net.Sockets.Socket类，这个类提供了丰富的方法和属性，并且还提供了异步数据传输支持。
对Socket类做一个简单的介绍，它有如下常见方法：
public Socket Accept ()：为新建连接创建新的 Socket。    
public void Bind (EndPoint localEP)：使 Socket 与一个本地终结点相关联。  
public void Close ()：关闭 Socket 连接并释放所有关联的资源。注意这个方法有冲载方法。 
public void Connect (EndPoint remoteEP)：建立与远程主机的连接。注意这个方法有重载方法。
public void Disconnect (bool reuseSocket)：关闭套接字连接并是否允许重用套接字。  
public void Listen (int backlog)：将 Socket 置于侦听状态。  
public int Receive (byte[] buffer)：接收来自绑定的 Socket 的数据。注意这个方法有重载方法。 
public int ReceiveFrom (byte[] buffer,ref EndPoint remoteEP)：接收数据报并存储源终结点。注意这个方法有重载方法。
public int Send (byte[] buffer)：将数据发送到连接的 Socket。注意这个方法有重载方法。
public void SendFile (string fileName)：将文件和可选数据异步发送到连接的 Socket。注意这个方法有重载方法。
public int SendTo (byte[] buffer,EndPoint remoteEP)：将数据发送到特定终结点。注意这个方法有重载方法。
public void Shutdown (SocketShutdown how)：禁用某 Socket 上的发送和接收。
说明：
因为在网络传输时传输的数据都是二进制形式的（表现为字节数组），所以如果要传输类似于中文这样的双字节字符就需要在传输之前用合适的编码转换成字节数组，然后接收方按照发送方的编码将接收到字节数组转换成字符串。另外，注意接收数据的时候是先声明了一个字节数组，然后将接收到的数据保存到字节数组中，这个方法有个返回值表示实际接收了多少字节数据。这是因为数组是不可变的，假如声明了一个1024字节大小的数组，而发送方仅发送1字节数据，而接收方并不直到发送方发送的数据量把整个1024字节当作发送发送的数据的话，最终会发生错误。
要实现一个服务器端的面向连接的Socket用于接收客户端的请求的话，有如下步骤：
（1）首先根据IP地址和端口号实例化一个Socket，注意端口要要大于1024并且不要使用特殊端口号，要大于1024的原因是1024以下的端口号已经被指派了，而1433、3306这样的端口号已经被用作SQL Server和MySQL的默认端口号了，若指定为这些端口号容易发生冲突。
（3）接着调用Bind()方法进行绑定，然后再调用Listen()方法用于监听，Listen()方法的参数用于指定监听的队列大小，也就是最多可容纳的等待接受的传入连接数。
（4）再调用Accept()方法，调用这个方法之后会是程序处于阻塞状态，直至有客户端连接为止。当有客户端连接，这个方法将会返回一个新的Socket，使用这个Socket与客户端进行通讯。
（5）使用Accept()方法返回的新Socket的Send()方法就可以向客户端发送数据了，还可以使用这个新Socket的Receive()接收客户端的数据。
（6）最后终止与客户端会话时，注意使用ShutDown()方法关闭Socket连接，并且使用Close()方法释放所占用的资源。

使用Socket类编写客户端的Socket程序步骤如下：
（1）首先指定远程主机和端口号实例化Socket类，注意连接的端口号一定要与服务器监听的端口号一致。
（2）接着调用Connect()方法连接远程主机。
（3）连接到远程主机之后就可以调用Send()方法向服务器发送请求了，然后可以调用Receive()方法接收服务器响应数据，注意如果是发送的类似于中文这样的双字节字符串的话，还需要按照服务器响应的字符串编码将字节数组转换成字符串。
最后终止与客户端会话时，注意使用ShutDown()方法关闭Socket连接，并且使用Close()方法释放所占用的资源。
需要特别说明的是上面是建立连接式Socket（如建立TCP协议Socket）的一般步骤，如果是建立非连接式Socket（如UDP协议Socket）就不需要进行监听端口了，直接使用ReceiveFrom()方法就能接收来自指定主机端口的数据，用SendTo()方法就能向直接主机端口发送数据。
下面一个例子来演示Socket的编程，在这个例子里服务器端可以处理多个客户端请求并响应，具体的做法是每接收到一个客户端请求就新建一个线程来与客户端通讯，主程序依然继续监听，在例子中新建的与客户端通讯的Socket类仅处理客户端的日期时间请求（为了演示，这里做了简化），根据客户端的请求的不同发送日期时间中响应信息到客户端，客户端接收到数据之后在控制台显示。
服务器端主要由两个类组成：ServerSocket类和SocketThread类，ServerSocket类用于监听客户端连接请求，SocketThread类用于接收日期时间显示请求并做出应答。
ServerSocket类代码如下（ServerSocket类和SocketThread类位于同一个类库项目中）：

  1. using System;  
  2. using System.Net;  
  3. using System.Net.Sockets;  
  4. using System.Text;  
  5.   
  6. namespace ServerSocket  
  7. {  
  8.     /// <summary>  
  9.     /// Socket监听服务器，用于监听客户端连接请求  
  10.     /// 作者：周公  
  11.     /// 编写时间：2009-03-18      
  12.     /// </summary>  
  13.     public class ServerSocket:IDisposable  
  14.     {  
  15.         Socket listener = null;  
  16.         /// <summary>  
  17.         /// 开始监听指定端口  
  18.         /// </summary>  
  19.         public void StartListening(int port)  
  20.         {  
  21.             // Data buffer for incoming data.  
  22.             byte[] bytes = new Byte[1024];  
  23.   
  24.             //以运行服务器端程序所在的机器为服务器监听客户端连接  
  25.             IPHostEntry ipHostInfo = Dns.Resolve(Dns.GetHostName());  
  26.             IPAddress ipAddress = ipHostInfo.AddressList[0];  
  27.             IPEndPoint localEndPoint = new IPEndPoint(ipAddress, port);  
  28.   
  29.             //创建一个TCP/IP Socket用于监听客户端连接  
  30.             Socket listener = new Socket(AddressFamily.InterNetwork,  
  31.                 SocketType.Stream, ProtocolType.Tcp);  
  32.   
  33.             try  
  34.             {  
  35.                 //先绑定要监听的主机和端口  
  36.                 listener.Bind(localEndPoint);  
  37.                 //再开始监听，并且指定监听队列的最大长度  
  38.                 listener.Listen(10);  
  39.   
  40.                 //开始监听连接  
  41.                 while (true)  
  42.                 {  
  43.                     Console.WriteLine("等待客户端连接...");  
  44.                     //线程将一直阻塞直到有新的客户端连接  
  45.                     Socket handler = listener.Accept();  
  46.                     //启用一个新的线程用于处理客户端连接  
  47.                     //这样主线程还可以继续接受客户端连接  
  48.                     SocketThread socketThread = new SocketThread(handler);  
  49.                 }  
  50.   
  51.             }  
  52.             catch (Exception e)  
  53.             {  
  54.                 Console.WriteLine(e.ToString());  
  55.             }  
  56.   
  57.         }  
  58.   
  59.         public static int Main(String[] args)  
  60.         {  
  61.             ServerSocket server = new ServerSocket();  
  62.             server.StartListening(11000);  
  63.             return 0;  
  64.         }  
  65.   
  66.         #region IDisposable 成员  
  67.   
  68.         public void Dispose()  
  69.         {  
  70.             if (listener != null)  
  71.             {  
  72.                 listener.Shutdown(SocketShutdown.Both);  
  73.                 listener.Close();  
  74.             }  
  75.         }  
  76.   
  77.         #endregion  
  78.     }  
  79. }   

SocketThread类代码如下：

  1. using System;  
  2. using System.Collections.Generic;  
  3. using System.Text;  
  4. using System.Threading;  
  5. using System.Net.Sockets;  
  6.   
  7. namespace ServerSocket  
  8. {  
  9.     /// <summary>  
  10.     /// 用于处理客户端请求的Socket  
  11.     /// 作者：周公  
  12.     /// 编写时间：2009-03-18  
  13.     /// </summary>  
  14.     public class SocketThread:IDisposable  
  15.     {  
  16.         private Socket socket;  
  17.         private Thread thread;  
  18.         private bool isListening = false;  
  19.         private string text;  
  20.         /// <summary>  
  21.         /// 构造方法  
  22.         /// </summary>  
  23.         /// <param name="socket">用于处理客户端应答的Socket</param>  
  24.         public SocketThread(Socket socket)  
  25.         {  
  26.             this.socket = socket;  
  27.             isListening = true;  
  28.             thread = new Thread(new ThreadStart(Work));  
  29.             thread.Start();  
  30.         }  
  31.   
  32.   
  33.         public void Work()  
  34.         {  
  35.             byte[] buffer=new byte[1024];  
  36.             while (isListening)  
  37.             {  
  38.                 int receivedLength = socket.Receive(buffer);  
  39.                 text=System.Text.Encoding.UTF8.GetString(buffer,0,receivedLength);  
  40.                 //<EOF>是自定义的协议，表示中止消息交流  
  41.                 if (text.IndexOf("<EOF>") > -1)  
  42.                 {  
  43.                     isListening=false;  
  44.                     socket.Send(new byte[] { 0 });  
  45.                 }  
  46.                 else  
  47.                 {  
  48.                     //Console.WriteLine("接收到的数据：" + text);  
  49.                     //根据客户端的请求获取相应的响应信息  
  50.                     string message = GetMessage(text);  
  51.                     //将响应信息以字节的方式发送到客户端  
  52.                     socket.Send(Encoding.UTF8.GetBytes(message));  
  53.                 }  
  54.             }  
  55.         }  
  56.         private string GetMessage(string request)  
  57.         {  
  58.             string message = string.Empty;  
  59.             //Console.WriteLine("Message=" + request);  
  60.             switch (request)  
  61.             {  
  62.                 case "date": message = "服务器日期："+DateTime.Now.ToString("yyyy-MM-dd"); break;  
  63.                 case "time": message ="服务器时间："+ DateTime.Now.ToString("HH:mm:ss"); break;  
  64.                 case "datetime": message = "服务器日期时间：" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"); break;  
  65.                 case "year": message = "服务器年份：" + DateTime.Now.Year.ToString(); break;  
  66.                 case "month": message = "服务器月份：" + DateTime.Now.Month.ToString(); break;  
  67.                 case "day": message = "这是本月第" + DateTime.Now.Day.ToString()+"天"; break;  
  68.                 default: message = "不正确的参数"; break;  
  69.             }  
  70.             return message;  
  71.         }  
  72.   
  73.         #region IDisposable 成员  
  74.   
  75.         public void Dispose()  
  76.         {  
  77.             isListening = false;  
  78.             if (thread != null)  
  79.             {  
  80.                 if (thread.ThreadState != ThreadState.Aborted)  
  81.                 {  
  82.                     thread.Abort();  
  83.                 }  
  84.                 thread = null;  
  85.             }  
  86.             if (socket != null)  
  87.             {  
  88.                 socket.Shutdown(SocketShutdown.Both);  
  89.                 socket.Close();  
  90.             }  
  91.         }  
  92.   
  93.         #endregion  
  94.   
  95.           
  96.     }  
  97. }  

客户端请求的Socket代码如下（与前面两个类位于不同的控制台项目中）：

  1. using System;  
  2. using System.Net;  
  3. using System.Net.Sockets;  
  4. using System.Text;  
  5.   
  6. namespace ServerSocket  
  7. {  
  8.     /// <summary>  
  9.     /// 客户端请求的Socket包装类  
  10.     /// 作者：周公  
  11.     /// 编写时间：2009-03-18  
  12.     /// </summary>  
  13.     public class ClientSocket:IDisposable  
  14.     {  
  15.         private Socket sender = null;  
  16.         private bool isListening = false;  
  17.         //定义用于接收服务器响应的存储区.  
  18.         private byte[] bytes = new byte[1024];  
  19.         //用于终止Soket的消息  
  20.         private string shutDownMessage = "<EOF>";  
  21.   
  22.         public ClientSocket()  
  23.         {  
  24.             try  
  25.             {  
  26.                 //设置要连接的主机信息并使用11000作为监听端口.  
  27.                 IPHostEntry ipHostInfo = Dns.GetHostEntry(Dns.GetHostName());  
  28.                 IPAddress ipAddress = ipHostInfo.AddressList[0];  
  29.                 IPEndPoint remoteEP = new IPEndPoint(ipAddress, 11000);  
  30.   
  31.                 // 创建一个TCP/IP协议的socket连接  
  32.                 sender = new Socket(AddressFamily.InterNetwork,  
  33.                     SocketType.Stream, ProtocolType.Tcp);  
  34.                 sender.Connect(remoteEP);  
  35.                 isListening = true;  
  36.             }  
  37.             catch (Exception ex)  
  38.             {  
  39.                   
  40.                 Console.WriteLine(ex.ToString());  
  41.             }  
  42.         }  
  43.   
  44.         public void StartClient()  
  45.         {  
  46.             // 连接到远程主机，并捕获所有信息  
  47.             try  
  48.             {  
  49.                   
  50.                 Console.WriteLine("连接到主机{0}",  
  51.                     sender.RemoteEndPoint.ToString());  
  52.                 OutParameters();  
  53.                 string consoleMessage = Console.ReadLine();  
  54.                 while (isListening&&!string.IsNullOrEmpty(consoleMessage))  
  55.                 {  
  56.                     consoleMessage = consoleMessage.ToLower();  
  57.                     if (consoleMessage == "bye")  
  58.                     {  
  59.                         SendShutDownMessage();  
  60.                     }  
  61.                     else  
  62.                     {  
  63.                         string resultMessage=SendMessage(consoleMessage);  
  64.                         Console.WriteLine(resultMessage);  
  65.                         OutParameters();  
  66.                         consoleMessage = Console.ReadLine();  
  67.                         //Console.WriteLine("consoleMessage=" + consoleMessage);  
  68.                     }  
  69.                 }  
  70.   
  71.             }  
  72.             catch (ArgumentNullException ane)  
  73.             {  
  74.                 Console.WriteLine("参数异常 : {0}", ane.ToString());  
  75.             }  
  76.             catch (SocketException se)  
  77.             {  
  78.                 Console.WriteLine("出现Socket异常: {0}", se.ToString());  
  79.             }  
  80.             catch (Exception e)  
  81.             {  
  82.                 Console.WriteLine("出现了异常 : {0}", e.ToString());  
  83.             }  
  84.   
  85.         }  
  86.         /// <summary>  
  87.         /// 向远程主机发送信息  
  88.         /// </summary>  
  89.         /// <param name="message">要发送的信息</param>  
  90.         public string SendMessage(string message)  
  91.         {  
  92.             byte[] buffer = Encoding.UTF8.GetBytes(message);  
  93.             sender.Send(buffer);  
  94.             int count=sender.Receive(bytes);  
  95.             return Encoding.UTF8.GetString(bytes, 0, count);  
  96.         }  
  97.         /// <summary>  
  98.         /// 向服务器发送关闭Socket信息，并中止与服务器的连接  
  99.         /// </summary>  
  100.         public void SendShutDownMessage()  
  101.         {  
  102.             SendMessage(shutDownMessage);  
  103.             Console.WriteLine("已经关闭与服务器的连接");  
  104.             isListening = false;  
  105.             Environment.Exit(0);  
  106.         }  
  107.   
  108.         private void OutParameters()  
  109.         {  
  110.             Console.WriteLine("参数说明：");  
  111.             Console.WriteLine("获取服务器日期：date");  
  112.             Console.WriteLine("获取服务器时间：time");  
  113.             Console.WriteLine("获取服务器日期时间：datetime");  
  114.             Console.WriteLine("获取服务器年份：year");  
  115.             Console.WriteLine("获取服务器月份：month");  
  116.             Console.WriteLine("获取服务器天数：day");  
  117.             Console.WriteLine("关闭连接：bye");  
  118.             Console.WriteLine("请输入你要进行的操作：");  
  119.         }  
  120.   
  121.         public static int Main(String[] args)  
  122.         {  
  123.             ClientSocket client = new ClientSocket();  
  124.             client.StartClient();  
  125.             return 0;  
  126.         }  
  127.   
  128.         #region IDisposable 成员  
  129.   
  130.         public void Dispose()  
  131.         {  
  132.             isListening = false;  
  133.             if (sender != null)  
  134.             {  
  135.                 sender.Shutdown(SocketShutdown.Both);  
  136.                 sender.Close();  
  137.             }  
  138.         }  
  139.   
  140.         #endregion  
  141.     }  
  142. }  

上面的三个类位于两个控制台项目中ServerSocket类和SocketThread类位于同一个类库项目中，其中ClientSocket类位于另一个控制台项目中，编译之后会生成两个exe文件，运行的时候首先运行服务器端exe程序以便监听，再运行客户端exe程序。这个程序运行的效果如下：

C#网络编程示例(note)

注意，在终止程序的时候首先在客户端向服务器发送一个自定义的字符串“<EOF>”，在客户端使用命令行参数“bye”就是发送这个字符串的，这样就会正确终止服务器端响应Socket及正确关闭客户端请求的Socket，否则有可能抛出异常。
以上仅仅是演示了如何使用Socket进行编程，如果要传输文件的话，可能需要更多类似于关闭Socket的自定义字符串用以控制了。另外使用Socket来传输数据是比较高效的，但是传输控制相对来说要麻烦一点，针对网络中一些特殊场合的数据传输，可以使用特定的传输协议，在这个系列的后续文章中会继续介绍网络编程的有关知识。程序代码稍后整理之后提供下载。

目前有关在.net下进行网络编程的文章较少，而偶尔有需要进行网络编程的项目需求，所以打算研究一下.net下的网络编程，抱着交流技术的态度，整理成文章与大家分享。不过在网络编程方面，本人经验几乎没有经验，如果大家发现有不当之处，望不吝赐教。

此文中的源代码可以到：http://download.csdn.net/source/1117938下载。

转自：http://blog.csdn.net/zhoufoxcn/archive/2009/03/18/4000301.aspx

上一篇：为什么不使用基于存储过程编程的框架


下一篇：T-SQL中的递归查询