「实战项目」.待办事项之WebSocket 服务器

本项目实现一个WebSocket应用服务器，其功能是完成待办事项的基本操作，实现了增删改查四类常用功能，服务器启动后会监听本地地址ws://localhost:3002端口，路由为/todo，即所有的客户端请求只要是发送至这个地址ws://localhost:3002/todo，这个服务器就会对所接收到的数据进行处理。

整个项目使用了.NET Core 3.1作为目标框架，构建一个普通的Console程序，项目所采用的服务端库为WebSocketSharp，为一个第三方WebSocket库，这个库即包含客户端功能又含有服务端功能，本项目只使用服务端功能，在开发WebSocket客户端项目时同样会使用这个库作为客户端来使用。服务端库确定之后，我们还需要一个JSON序列化与反序列化功能的JSON库，我们使用了Newtonsoft.Json库，这两个库都是可以通过Nuget包管理器进行安装，但在安装WebSocketSharp库时需要选中“包括预发行版”选项。安装完成之后，包管理器中会出现两项对应的记录，如图1所示

消息请求类型。消息是客户端与服务器通信的一种数据，客户端向服务器发送不同类型的消息，服务器根据消息的类型可以进行不同的处理逻辑，比如：客户端向服务器可以发送一条查询的消息，那么服务器对这条消息的响应为获取当前数据库中对应的数据。本项目中的消息请求类型定义了四个，分别表示：

1. 创建一个待办事项
2. 删除一个待办事项
3. 更新一个待办事项
4. 删除一个待办事项

每一个消息的格式类似，但是所携带的数据内容有所不同，为了代码统一管理，我们定义了一个泛型的请求类，统一表示客户端至服务器的请求内容，如下：

请求的Id字段值根据不同的操作其值不同，但类型为一个整型数值，payload字段值是可以根据不同的类型消息做出调整，比如，当Id值为AddTodo(0)值时，表示添加一个Todo数据至payload字段，如果Id值为DeleteTodo(1)值时，表示需要删除一个Todo数据，这时的payload只是一个字符串，表示这个待删除Todo项的Id值。Id值对应的payload数据类型为

表1

消息响应类型。服务端接收到来自客户端的请求之后，会检查数据的合法性，如果数据非法，服务器给出对应的错误码和错误内容提示，如果接收到的数据全部正确，那么服务器就会对其进行相应的逻辑处理，或是保存数据，或是删除数据等操作，完成这些服务端的逻辑处理之后，服务器同样会向客户端发送它对数据的处理结果，比如，对于新增的数据，服务器端会生成一个唯一的Id，用以表示当前处理的条目项标识，并给出对应的正确码值；对于无法处理的错误数据，服务器同样需要给出响应，通过给出错误的码值，告诉客户端可能发生了什么情况。与请求的数据类似，响应数据所携带的信息类型也是不确定的，我们也是用了一个泛型类表示：

图3中Code字段用以表示服务器端处理数据正确与否的数值，通常采用200作为正确的码值，Message字段用以对这个Code值的补充描述，payload字段根据不同的响应类型也会有不同的类型。服务器提供的响应主要为：

表2

数据处理逻辑也分为4个功能模块，首先是添加事项功能，添加事项模块接收到数据后生成一个唯一Id，我们使用了Guid来生成这个字符串，之后将这个值赋值给当前的Todo对象的Id值，并更新至Todo的内存存储中。

图4第14行代码会判断用户传递的payload字段数据是否合法，如果为null值，视为一个非法的创建操作，服务端给出码值为400的响应；否则，通过第34行代码构建一个Guid数值并赋值给这个Todo实例的Id值，之后便将这个实例加入至内存Dictionary对象中，最后将正确的响应发送给客户端。

第二个功能是删除事项操作。这个请求消息携带的信息只有一个待删除的Todo的Id值，如果客户端传递过来的Id值不存在，那么服务端会给出400码值的错误响应；否则，会使用这个Id值作为内存Dictionary的键值进行删除对应的Value值，完成操作之后将这个已删除的Id值作为payload返回给客户端，见下图5所示

第三项操作是更新待办事项。本项目的更新操作限制为使用Todo事项的Id值进行查找，更新的内容为Todo的标题，对于这个更新操作，客户端所传递的payload参数为两个字符串，第一个为Todo的Id值，第二个为更新后的标题值，因此，通过传递的参数Id所获取到Todo之后，便更新这个对象的Title字段，即完成了更新服务端数据操作，之后便将这个新的Todo作为响应的payload数据返回给客户端。同样，如果在更新操作时，发现这个Todo对象不存在，那么服务端给出的错误码也是400，payload的值与Code值相同。

最后一项操作便是显示所有事项。这个操作客户端只需要发送一个这样的消息Id值就可以，payload数据不重要，我们目前只需要知道是获取列表的命令即可进行查询操作。这个操作只需要获取Dictionary中Values的值，并将这个值返回给客户端即可，代码比较简单，如下图7所示：

采用基于WebSocketSharp库进行开发WebSocket应用之后，整个服务器端代码比较简单，如图8所示：首先创建一个WebSocketServer，之后添加需要处理业务的Service，这是通过编写一个WebSocketBehavior实现的，最后是通过调用Start方法启动这个服务器。

处理业务逻辑的代码全部在这个自定义的WebSocketBehavior类中实现，我们通过重写OnMessage方法，使用Newton.JsonConvert反序列化得出JObject对象，之后获取表示请求Id的RequestId值，根据不同的RequestId进入不同的Todo处理功能函数，这样，就实现了一个待办事项WebSocket服务端程序。