Visual C#建立简单消息传递系统

套接字和消息

目前，大多数Web服务和所有的远程应用程序都使用了远程过程调用（remote-procedure-call，RPC）方法。你所做工作好像是在调用一个函数，但是在其后台执行了大量的操作以确保它在服务器上发生。在较低的层次，系统是在两台计算机之间传递消息，但这是不可视的。

然而，当你转换到套接字操作的时候，你就在纯粹的基于消息的系统中编程了。这会改变你编写的代码的类型，因为读取返回的数据的唯一途径是通过消息。它与使用无返回值或输出参数的.NET类有点类似，在这些情况下所有的返回信息都需要通过事件传递。

由于我希望服务器程序告诉客户端什么时候应该改变曲目，使用消息就很有利，因为信息可以从服务器到达客户端，不需要客户端明确地请求该信息。但是，它要求你使用不同的方式达到目标。

在解释所有操作之前，我想先谈论一点点安全性方面的问题。如果你在自己的计算机上打开了某个端口，其它人可能利用这个端口做不利的事情。他们可能希望写入没有意义的信号，以确定自己是否能够控制你的计算机或者使它崩溃。当你编写这类应用程序的时候考虑一下这种可能性是必要的。我的例子将运行在防火墙后面的网络上，所以我感觉到相对安全。

简单的套接字

我从建立一个服务器程序开始，它能给一个整数加上1，下面是服务器端代码：

public static void Main() { IPAddress localAddr = IPAddress.Parse("127.0.0.1"); TcpListener listener = new TcpListener(localAddr, 9999); Console.WriteLine("Waiting for initial connection"); listener.Start(); Socket socket = listener.AcceptSocket(); Console.WriteLine("Connected"); NetworkStream stream = new NetworkStream(socket); BinaryReader reader = new BinaryReader(stream); BinaryWriter writer = new BinaryWriter(stream); int i = reader.ReadInt32(); i++; writer.Write(i); }

它首先在本机的9999端口上建立了一个TCP监听器，接着启动监听器并等待连接。一旦得到了连接，它就接收一个整数，给它加1，并把它发送回去。

需要指出的是我在此处使用的本地地址是127.0.0.1。在测试的时候这种情形可以很好地运行，这个时候客户端和服务器程序在相同的计算机上运行，但是当它们在不同的计算机上运行时，程序就不能运行了。在后面的部分中我将给出更复杂的代码。

传递消息 

通过套接字传递未经处理的数据毫无乐趣，而通过套接字传递对象可能更有趣一些。为了达到这个目标，我们需要一个得到对象并把它转换为字节流的途径。最明显的解决方案是使用运行时（runtime）提供的串行化（serialization）支持。不幸的是，使用这种方法会有少量的问题。 

第一个问题是串行化需要很大的开销，这意味着它使用的字节比传递数据必要的字节多一些。如果使用SOAP格式化，这个问题就更严重。这是否成为一个问题依赖于应用程序的性能需求。第二个问题是串行化在简洁框架组件中不能使用。由于没有简单的实现方法，我们需要自己做这个工作。在这个过程中，我们做的事情比串行化要少多了。

我们从建立一个枚举开始，它定义了可以传递什么类型的消息：

public enum MessageType { RequestEmployee = 1, Employee, }

对于每种消息类型，我们需要一个对象定义该对象：

public class RequestEmployee: ISocketObject { int id; public RequestEmployee(int id) { this.id = id; } } public RequestEmployee(BinaryReader reader) { id = reader.ReadInt32(); } public int ID { get { return id; } } public void Send(BinaryWriter writer) { writer.Write((int) MessageType.RequestEmployee); writer.Write(id); } }

我们使用的这种途径与ISerializable接口很相似。ISocketObject接口定义了一个Send()函数，它串行化通过通道的数据，接着还有一个并行化该数据的构造函数。

在这些对象中的某个串行化自身的时候，它发送的第一个信息是消息标识符。它让接收者知道将到达哪种类型的对象并建立该对象。下面是客户端的代码：

RequestEmployee requestEmployee = new RequestEmployee(15); requestEmployee.Send(writer); MessageType messageType = (MessageType) reader.ReadInt32(); switch (messageType) { case MessageType.Employee: Employee employee = new Employee(reader); Console.WriteLine(" = ", employee.Name, employee.Address); break; }

RequestEmployee这段代码建立了一个对象并把它发送给服务器程序，接着它找出返回的是哪种对象，并且并行化它。

尽管这个示例项目被标记为client和server，但是两者之间唯一真正的差别是连接建立的方式。当这个过程完成后，它们都使用相似的代码发送和接收消息，即使它们需要处理自己的消息集合。

面向对象设计vs.实用主义

这种方法的缺点之一是你必须使用一个大的switch语句结束，但是前辈一直教导我们大的switch语句是较差的设计的表现。通常的面向对象（Object Oriented，OO）的途径是使用多态性（polymorphism）的。为了达到这个目的，我们先建立一个抽象的基类（base class），接着从该类衍生出所有的消息对象。每个类需要执行串行化、并行化和处理消息等多个方法，主要的代码是：

　　 · 读取消息类型

　　 · 建立实例（使用反射）

　　 · 调用虚HandleMessage()函数

这样做是可以实现的，但是效果很差，我并不喜欢。首先，编写建立实例的代码很难，并且由于它使用了反射，它的速度更慢。更重要的是，消息的处理过程并不在HandleMessage()函数之内，这意味着它必须是共享库的一部分。这是不宜使用的，因为消息的处理过程与消息如何传递没有什么关系。由于这些问题的存在，我依然决定使用较少面向对象但是更加容易编写的途径。

前面的示例只处理了单个消息。在现实世界中，我们需要同时处理多个消息。

#p#服务器端的多线程

我的最终的目标是把该服务器程序的功能添加到一个已有的应用程序中。因为不希望修改已有的应用程序的代码，我就必须在某个线程上运行服务器程序。同样，我希望可以同时接受多个连接。

上面的例子在端口9999上监听，但是由于一个客户端只能与一个端口对话，我需要为每个连接使用不同端口的途径。SocketListener类将在9999端口上监视，当新的连接请求到达的时候，它将查找一个未使用的端口并把它发送回给客户端。下面是这个类的大致情形：

public class SocketListener { int port; Thread thread; public SocketListener(int port) { this.port = port; ThreadStart ts = new ThreadStart(WaitForConnection); thread = new Thread(ts); thread.IsBackground = true; thread.Start(); } public void WaitForConnection() { // 主要的代码 } }

WaitForConnection()是执行所有这些操作的方法。这个类的构造函数执行建立新线程的任务，这个线程将运行WaitForConnection()。打开套接字并接受连接与前面的例子相似。下面是该线程的主循环：

while (true) { Console.WriteLine("Waiting for initial connection"); listener.Start(); Socket socket = listener.AcceptSocket(); NetworkStream stream = new NetworkStream(socket); BinaryReader reader = new BinaryReader(stream); BinaryWriter writer = new BinaryWriter(stream); Console.WriteLine("Connection Requested"); int userPort = port + 1; TcpListener specificListener; while (true) { try { specificListener = new TcpListener(localAddr, userPort); specificListener.Start(); break; } catch (SocketException) { userPort++; } } //远程用户应该使用specificListener。 //把该端口发送回给远程用户，并为我们在该端口上建立服务器应用程序。 SocketServer socketServer = new SocketServer(specificListener); writer.Write(userPort); writer.Close(); reader.Close(); stream.Close(); socket.Close(); }

我希望能够支持多个连接，因此使用一个端口以便于客户端表明它们希望建立一个连接，接着服务器程序找到一个空的端口并把该端口发送回给客户端，该端口用于特定客户端的连接。 

我没有找到查找未使用端口的方法，因此该While循环用于找出未使用的端口。接着它把该端口号发送回客户端并清除对象。

此处还有需要指出的一点点微妙之处。SocketServer的原始版本把端口号作为一个参数。不幸的是，这意味着在该端口上建立监听器之前客户端不能作出请求，这是很不好的。为了防止出现这种情况，我在给客户端发送端口号之前建立了TcpListener，它确保不会出现这种紧急情况。

SocketServer类建立了额外的线程，并使用了下面的主循环：

try { while (true) { MessageType messageType = (MessageType) reader.ReadInt32(); switch (messageType) { case MessageType.RequestEmployee: Employee employee = new Employee("Eric Gunnerson", "One Microsoft Way"); employee.Send(writer); break; } } } catch (IOException) { } finally { socket.Close(); }

这个主循环是一个简单的获取请求/处理请求的循环。try-catch-finally在此处用于当客户端断开连接的时候从异常中恢复过来。

客户端的事件

在客户端，我编写了一个Windows传统客户端程序，可以供PC使用也可以供Pocket PC使用。该Windows窗体环境是基于事件的，而且使用事件处理套接字消息也是理想的。这是通过SocketClient类实现的。第一步是为每个消息定义一个委托和事件：

public delegate void EmployeeHandler(Employee employee); public event EmployeeHandler EmployeeReceived;

第二步是编写发送事件的代码：

case MessageType.Employee: Employee employee = new Employee(reader); if (EmployeeReceived != null) form.Invoke(EmployeeReceived, new object[] ); break;

当事件发生的时候就应该更新窗体了。为了更可靠，这个操作需要在主UI线程上发生。这是通过调用窗体的Invoke()实现的，它将安排在主UI线程上调用的委托。

因为这种基于消息的体系结构，服务器程序要有对于异步事件的内建的支持。示例有一个CurrentCount消息，它是由服务器程序每秒钟发送的。