本文源代码下载
随着Web技术的发展,Socket通信逐渐被人们遗忘。然而最近Socket应用却又越来越多。尤其是中国移动,中国联通的短信网关就是基于Socket通迅,另外随着大家对MSN、QQ等IM工具通迅协议的研究。协议内容也随处都可以找到。想要制作自己的MSN、QQ客户端的用户也大有人在。但习惯了WEB开发和简单UI开发的程序员却在这些协议面前迷糊了。
.net的System.Net.Sockets命名空间封装了大量Socket类。使用此命名空间可以通过简单的方法进行复杂的Sockets连接、通迅。下面我就一步步教大家建立一个基于System.Net.Sockets的通用类库,并基于此举几个例子说明如何使用这个类库。
1、 首先建立一个类库项目。项目命名为 SocketLibrary,并删除自动生成的Class1.cs
![](/images/cnblogs_com/rainlake/image001.png)
2、 在SocketLibrary中添加类:SocketFactory.cs
3、 在默认解决方案中增加一个Windows项目SocketServerTest用于测试服务器端。
并添加对SocketLibrary的引用。将此项目设为启动项目
4、 在SocketLibrary项目中新建类Connection。表示一个连接,增加两个属性NetWorkStream和ConnectionName。分别表示一个连接的名字和它包含的NetWorkStream。源代码如下:
1
using System;
3
using System.Net;
5
using System.Net.Sockets;
6![](/Images/OutliningIndicators/None.gif)
7
8![](/Images/OutliningIndicators/None.gif)
9
namespace SocketLibrary
10![](/Images/OutliningIndicators/None.gif)
11![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ContractedBlock.gif)
{
12![](/Images/OutliningIndicators/InBlock.gif)
13
public class Connection
14![](/Images/OutliningIndicators/InBlock.gif)
15![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
16![](/Images/OutliningIndicators/InBlock.gif)
17![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public NetworkStream NetworkStream
{
18![](/Images/OutliningIndicators/InBlock.gif)
19![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
get
{return _networkStream;}
20![](/Images/OutliningIndicators/InBlock.gif)
21![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
set
{_networkStream = value;}
22![](/Images/OutliningIndicators/InBlock.gif)
23
}
24![](/Images/OutliningIndicators/InBlock.gif)
25
private NetworkStream _networkStream;
26![](/Images/OutliningIndicators/InBlock.gif)
27![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public string ConnectionName
{
28![](/Images/OutliningIndicators/InBlock.gif)
29![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
get
{return _connectionName;}
30![](/Images/OutliningIndicators/InBlock.gif)
31![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
set
{_connectionName = value;}
32![](/Images/OutliningIndicators/InBlock.gif)
33
}
34![](/Images/OutliningIndicators/InBlock.gif)
35
private string _connectionName;
36![](/Images/OutliningIndicators/InBlock.gif)
37
public Connection(NetworkStream networkStream,string connectionName)
38![](/Images/OutliningIndicators/InBlock.gif)
39![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
40![](/Images/OutliningIndicators/InBlock.gif)
41
this._networkStream = networkStream;
42![](/Images/OutliningIndicators/InBlock.gif)
43
this._connectionName = connectionName;
44![](/Images/OutliningIndicators/InBlock.gif)
45
}
46![](/Images/OutliningIndicators/InBlock.gif)
47![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public Connection(NetworkStream networkStream):this(networkStream,string.Empty)
{
48![](/Images/OutliningIndicators/InBlock.gif)
49
}
50![](/Images/OutliningIndicators/InBlock.gif)
51
}
52![](/Images/OutliningIndicators/InBlock.gif)
53
}
54![](/Images/OutliningIndicators/None.gif)
5、 新建一个继承自CollectionBase的类ConnectionCollection。用于保存Connection集合。
1
using System;
2![](/Images/OutliningIndicators/None.gif)
3
4![](/Images/OutliningIndicators/None.gif)
5![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
namespace SocketLibrary
{
6![](/Images/OutliningIndicators/InBlock.gif)
7![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public class ConnectionCollection:System.Collections.CollectionBase
{
8![](/Images/OutliningIndicators/InBlock.gif)
9![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public ConnectionCollection()
{
10![](/Images/OutliningIndicators/InBlock.gif)
11
12![](/Images/OutliningIndicators/InBlock.gif)
13
}
14![](/Images/OutliningIndicators/InBlock.gif)
15![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public void Add(Connection value)
{
16![](/Images/OutliningIndicators/InBlock.gif)
17
List.Add(value);
18![](/Images/OutliningIndicators/InBlock.gif)
19
}
20![](/Images/OutliningIndicators/InBlock.gif)
21![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public Connection this[int index]
{
22![](/Images/OutliningIndicators/InBlock.gif)
23![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
get
{
24![](/Images/OutliningIndicators/InBlock.gif)
25
return List[index] as Connection;
26![](/Images/OutliningIndicators/InBlock.gif)
27
}
28![](/Images/OutliningIndicators/InBlock.gif)
29![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
set
{
30![](/Images/OutliningIndicators/InBlock.gif)
31
List[index] = value;
32![](/Images/OutliningIndicators/InBlock.gif)
33
}
34![](/Images/OutliningIndicators/InBlock.gif)
35
}
36![](/Images/OutliningIndicators/InBlock.gif)
37![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public Connection this[string connectionName]
{
38![](/Images/OutliningIndicators/InBlock.gif)
39![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
get
{
40![](/Images/OutliningIndicators/InBlock.gif)
41![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
foreach(Connection connection in List)
{
42![](/Images/OutliningIndicators/InBlock.gif)
43
if(connection.ConnectionName == connectionName)
44![](/Images/OutliningIndicators/InBlock.gif)
45
return connection;
46![](/Images/OutliningIndicators/InBlock.gif)
47
}
48![](/Images/OutliningIndicators/InBlock.gif)
49
return null;
50![](/Images/OutliningIndicators/InBlock.gif)
51
}
52![](/Images/OutliningIndicators/InBlock.gif)
53
}
54![](/Images/OutliningIndicators/InBlock.gif)
55
}
56![](/Images/OutliningIndicators/InBlock.gif)
57
}
58![](/Images/OutliningIndicators/None.gif)
6、 新建一个类,名字为Server,用于侦听网络连接。
1
using System;
2![](/Images/OutliningIndicators/None.gif)
3
using System.Net;
4![](/Images/OutliningIndicators/None.gif)
5
using System.Net.Sockets;
6![](/Images/OutliningIndicators/None.gif)
7
8![](/Images/OutliningIndicators/None.gif)
9
namespace SocketLibrary
10![](/Images/OutliningIndicators/None.gif)
11![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ContractedBlock.gif)
{
12![](/Images/OutliningIndicators/InBlock.gif)
13
public class Server
14![](/Images/OutliningIndicators/InBlock.gif)
15![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
16![](/Images/OutliningIndicators/InBlock.gif)
17![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public ConnectionCollection Connections
{
18![](/Images/OutliningIndicators/InBlock.gif)
19![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
get
{return _connections;}
20![](/Images/OutliningIndicators/InBlock.gif)
21![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
set
{_connections = value;}
22![](/Images/OutliningIndicators/InBlock.gif)
23
}
24![](/Images/OutliningIndicators/InBlock.gif)
25
private ConnectionCollection _connections;
26![](/Images/OutliningIndicators/InBlock.gif)
27
28![](/Images/OutliningIndicators/InBlock.gif)
29
private TcpListener _listener;
30![](/Images/OutliningIndicators/InBlock.gif)
31
public Server(TcpListener listener)
32![](/Images/OutliningIndicators/InBlock.gif)
33![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
34![](/Images/OutliningIndicators/InBlock.gif)
35
this._connections = new ConnectionCollection();
36![](/Images/OutliningIndicators/InBlock.gif)
37
this._listener = listener;
38![](/Images/OutliningIndicators/InBlock.gif)
39
}
40![](/Images/OutliningIndicators/InBlock.gif)
41![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public void Start()
{
42![](/Images/OutliningIndicators/InBlock.gif)
43![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
while(true)
{
44![](/Images/OutliningIndicators/InBlock.gif)
45![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
if(_listener.Pending())
{
46![](/Images/OutliningIndicators/InBlock.gif)
47
TcpClient client = _listener.AcceptTcpClient();
48![](/Images/OutliningIndicators/InBlock.gif)
49
NetworkStream stream = client.GetStream();
50![](/Images/OutliningIndicators/InBlock.gif)
51
this._connections.Add(new Connection(stream));
52![](/Images/OutliningIndicators/InBlock.gif)
53
}
54![](/Images/OutliningIndicators/InBlock.gif)
55
}
56![](/Images/OutliningIndicators/InBlock.gif)
57
}
58![](/Images/OutliningIndicators/InBlock.gif)
59
}
60![](/Images/OutliningIndicators/InBlock.gif)
61
}
62![](/Images/OutliningIndicators/None.gif)
7、 在SocketFactory中声明一个私有变量
System.Threading.Thread _serverListenThread;
8、 在SocketFactory类中加入StartServer方法。当执行此方法时,初始化_ serverListenThread并在此线程中开始侦听网络连接
1![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
public void StartServer(int port)
{
2![](/Images/OutliningIndicators/InBlock.gif)
3
TcpListener listener = new TcpListener(IPAddress.Any, port);
4![](/Images/OutliningIndicators/InBlock.gif)
5
listener.Start();
6![](/Images/OutliningIndicators/InBlock.gif)
7
8![](/Images/OutliningIndicators/InBlock.gif)
9
Server server = new Server(listener);
10![](/Images/OutliningIndicators/InBlock.gif)
11
_serverListenThread = new System.Threading.Thread(new System.Threading.ThreadStart(server.Start));
12![](/Images/OutliningIndicators/InBlock.gif)
13
_serverListenThread.Start();
14![](/Images/OutliningIndicators/InBlock.gif)
15
}
16![](/Images/OutliningIndicators/None.gif)
9、 下面我们来测试此线程是否工作。
在SocketServerTest的Form1的Form1_Load事件中加入如下代码。
1
SocketLibrary.SocketFactory factory = new SocketLibrary.SocketFactory();
2![](/Images/OutliningIndicators/None.gif)
3
factory.StartServer(1979);
4![](/Images/OutliningIndicators/None.gif)
运行程序,可以看出Form1显示出来了。但我们并没有看到监听启动。这是由于我们的监听是在另外一个线程里运行的。我们可以在Server类的Start()函数中加入断点
![](/images/cnblogs_com/rainlake/image004.jpg)
再次执行程序。可以看到程序会运行到断点处。即开始监听网络连接了。
10、 下面我们另外启动一个VS.NET2003实例,建立一个项目SocketClientTest,并通过添加已存在的项目增加SocketLibrary,增加对此项目的引用。
11、 新建一个Client类。并写上以下源代码
1
using System;
2![](/Images/OutliningIndicators/None.gif)
3
using System.Net;
4![](/Images/OutliningIndicators/None.gif)
5
using System.Net.Sockets;
6![](/Images/OutliningIndicators/None.gif)
7
8![](/Images/OutliningIndicators/None.gif)
9
namespace SocketLibrary
10![](/Images/OutliningIndicators/None.gif)
11![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ContractedBlock.gif)
{
12![](/Images/OutliningIndicators/InBlock.gif)
13
14![](/Images/OutliningIndicators/InBlock.gif)
15
public class Client
16![](/Images/OutliningIndicators/InBlock.gif)
17![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
18![](/Images/OutliningIndicators/InBlock.gif)
19
public const int CONNECTTIMEOUT = 10;
20![](/Images/OutliningIndicators/InBlock.gif)
21
public Connection _connection;
22![](/Images/OutliningIndicators/InBlock.gif)
23
public Client()
24![](/Images/OutliningIndicators/InBlock.gif)
25![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
26![](/Images/OutliningIndicators/InBlock.gif)
27
28![](/Images/OutliningIndicators/InBlock.gif)
29
}
30![](/Images/OutliningIndicators/InBlock.gif)
31![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
public static Connection StartClient(IPAddress ipaddress,int port)
{
32![](/Images/OutliningIndicators/InBlock.gif)
33
TcpClient client = new TcpClient();
34![](/Images/OutliningIndicators/InBlock.gif)
35
client.SendTimeout = CONNECTTIMEOUT;
36![](/Images/OutliningIndicators/InBlock.gif)
37
client.ReceiveTimeout = CONNECTTIMEOUT;
38![](/Images/OutliningIndicators/InBlock.gif)
39
40![](/Images/OutliningIndicators/InBlock.gif)
41
client.Connect(ipaddress,port);
42![](/Images/OutliningIndicators/InBlock.gif)
43
}
44![](/Images/OutliningIndicators/InBlock.gif)
45
}
46![](/Images/OutliningIndicators/InBlock.gif)
47
}
48![](/Images/OutliningIndicators/None.gif)
在SocketFactory中加入StartClient函数
1
public Connection StartClient(IPAddress ip,int port)
2![](/Images/OutliningIndicators/None.gif)
3![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ContractedBlock.gif)
{
4![](/Images/OutliningIndicators/InBlock.gif)
5
return Client.StartClient(ip,port);
6![](/Images/OutliningIndicators/InBlock.gif)
7
}
8![](/Images/OutliningIndicators/None.gif)
在SocketClient的Form1的Form1_Load中加入以下代码
并
插入断点。开始调试执行。当执行取最后一句时。我们看到_connection已经连接成功。
好了,现在我们的客户端已经连接上服务器,并可以发送消息了。但现在我们还没有如何发送消息的方法。我们在SocketFactory中增加一个发消息的静态方法。并且声明一个编码类型的静态变量
public static System.Text.Encoding DefaultEncoding =
![](/Images/OutliningIndicators/None.gif)
System.Text.Encoding.GetEncoding("GB2312");
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
public static void SendMessage(string message,Connection connection)
{
![](/Images/OutliningIndicators/InBlock.gif)
byte[] buffer = DefaultEncoding.GetBytes(message);
![](/Images/OutliningIndicators/InBlock.gif)
connection.NetworkStream.Write(buffer,0,buffer.Length);
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/None.gif)
现在我们可以用这个函数发消息给服务器端了。
![](/images/cnblogs_com/rainlake/image009.png)
我们看到消息发送成功,但服务器端没有任何反应。这是因为我们还没有在服务器端侦听消息。在Server类中增加如下代码
加入开始侦听网络流的线程
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
public void Listenning()
{
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
while(true)
{
![](/Images/OutliningIndicators/InBlock.gif)
System.Threading.Thread.Sleep(200);
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
foreach(Connection connection in this._connections)
{
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
if(connection.NetworkStream.CanRead && connection.NetworkStream.DataAvailable)
{
![](/Images/OutliningIndicators/InBlock.gif)
byte[] buffer = new byte[1024];
![](/Images/OutliningIndicators/InBlock.gif)
int count = connection.NetworkStream.Read(buffer,0,buffer.Length);
![](/Images/OutliningIndicators/InBlock.gif)
Console.Write(SocketFactory.DefaultEncoding.GetString(buffer,0,count));
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/None.gif)
1![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
public void StartListen()
{
2![](/Images/OutliningIndicators/InBlock.gif)
3
_listenningthread = new System.Threading.Thread(new System.Threading.ThreadStart(Listenning));
4![](/Images/OutliningIndicators/InBlock.gif)
5
_listenningthread.Start();
6![](/Images/OutliningIndicators/InBlock.gif)
7
}
8![](/Images/OutliningIndicators/None.gif)
9
private System.Threading.Thread _listenningthread;
10![](/Images/OutliningIndicators/None.gif)
再在SocketFactory的StartServer中加入以下代码,以开始侦听网络流。
![](/images/cnblogs_com/rainlake/image009.png)
好。我们再启动SocketServerTest。并运行SocketClientTest。现在在SocketServerTest的控制台可以看到如下输出:
也即服务器收到了客户端发来的Hello Server的消息。
这一章我们就到这里。下一章我们继续讲如何重构这一章的代码,并继续深入的讲如何定义协议以及如何使用这些协议收发消息。