Unity网络开发 - C#开源网络通信库PESocket的使用

概述

在现代多人在线游戏中，稳定且高效的网络通信是确保游戏体验的关键。本文将探讨如何使用C#开源网络通信库PESocket来构建一个简单的Unity客户端与.NET控制台服务器之间的实时消息传递系统。通过本例，读者不仅能够了解PESocket的根本用法，还将学到一些关于计划跨平台网络应用程序的最佳实践。
1. PESocket简介

   PESocket开源项目GitHub地点：点击跳转
  博客地点：C#开源网络通信库PESocket的使用 - PlaneZhong - 博客园 (cnblogs.com)
  PESocket是一个轻量级、易于使用的网络通信框架，特别得当于快速原型制作和小规模项目。它基于Socket编程模型，并提供了简洁的API以简化异步数据传输过程。
  不用过多了解网络通信内部原理，只需几行简单的代码，便能简捷快速开发基于C#语言的服务器和客户端，实现网络通信。
  2. 序列化与反序列化

为了在网络间安全高效地传输复杂对象，PESocket采用了自定义的序列化机制。这使得任何实现了ISerializable接口或标志了[Serializable]属性的数据结构都可以被直接打包成二进制流发送出去，到达目标地后再恢复为原始情势。
3. 会话管理

每个连接到服务器的客户端都由一个独立的PESession实例代表，负责处理所有相关的输入输出操作。这种一对一的关系有助于实现更细粒度的安全控制及错误处理策略。
4. 日志记载

精良的日志记载习惯对于调试和维护网络应用至关重要。PESocket内置了一套强大的日志系统，可以根据差别级别（如信息、告诫、错误等）记载详细的运行时状态变革。
开发步骤

第一步：设置项目情况

• 创建一个新的Unity项目作为客户端。
  
• 新建一个标准的.NET控制台应用程序充当服务器角色。
  
• 在两个项目中分别导入PESocket引用       网络协议必须要去继承自PESocket里的PEMsg
  服务器里PESocket 放在网络模块
  将协议里原来的引用都删除-添加引用-找到之宿世成的PESocket.dll
  将原来服务器里的引用都删除-添加引用-直接引用协议项目
  

第二步：定义通信协议

服务器必要与客户端进行通信，必要一个网络协议（类库）

首先，我们必要定义一个共享的消息类，用于封装待交换的信息。此例中我们仅包罗了一个字符串字段text，但根据实际需求可以扩展更多属性。

1. // NetMsg.cs
2. using PENet;
3. using System;
5. namespace PEProtocal
6. {
7.     [Serializable]
8.     public class NetMsg : PEMsg
9.     {
10.         public string text;
11.     }
13.     public class IPCfg
14.     {
15.         public const string srvIP = "127.0.0.1";
16.         public const int srvPort = 17666;
17.     }
18. }

复制代码

第三步：编写服务器端代码

接下来创建服务器逻辑，包罗初始化监听器以及处理来自长途主机的各种事件。

有了ip端口信息就可以在服务器(ServerStart)里天生一个PESocket
但由于PESocket必要有一个进行网络通信的Session，并且这个Session必要继承自PESession
在服务器下创建一个session(类)：ServerSession
   ServerSession负责与客户端进行连接
连接后需做
1.建立连接时必要有一个反馈
2.收到数据时对数据进行处理
3.断开连接时打出一个反馈日志

1. using Protocal;
2. using PENet;
4. /// <summary>
5. /// ServerSession负责与客户端进行连接
6. /// </summary>
7. public class ServerSession:PESession<NetMsg>//PESession需要传入网络消息的类
8. {
9.     //建立连接
10.     protected override void OnConnected()
11.     {
12.         PETool.LogMsg("Client Connect");//PESocket里封装好的方法
13.         SendMsg(new NetMsg
14.         {
15.             text = "Welcome to connect."
16.         });
17.     }
18.     //收到数据
19.     protected override void OnReciveMsg(NetMsg msg)
20.     {
21.         PETool.LogMsg("Client Req:" + msg.text);
22.         SendMsg(new NetMsg
23.         {
24.             text = "SrvRsp:" + msg.text
25.         });
26.     }
27.     //断开连接
28.     protected override void OnDisConnected()
29.     {
30.         PETool.LogMsg("Client DisConnect");
31.     }
33. }

复制代码

  在服务器端，ServerStart 类是整个应用的入口点。它负责初始化网络通佩服务，并保持服务器运行状态以便一连监听来自客户端的连接哀求。 

1. using PENet;
2. using Protocal;
4. /// <summary>
5. /// 服务器
6. /// </summary>
7. namespace Server
8. {
9.     class ServerStart
10.     {
11.         static void Main(string[] args)
12.         {
13.             //需要一个进行网络通信的Session,并且这个Session需要继承自PESession，还有一个网络消息的类（协议）
14.             PESocket<ServerSession, NetMsg> server = new PESocket<ServerSession, NetMsg>();
15.             server.StartAsServer(IPCfg.srvIP, IPCfg.srvPort);
16.             //需要传递的ip和端口
17.             while (true)
18.             {
19.                 /* Keep the application running */
20.             }
21.         }
22.     }
23. }

复制代码

第四步：设置Unity客户端

现在转向Unity工程，在MonoBehaviour脚本中添加必要的逻辑以便建立与远端服务的链接并发送/接收文本消息。
将协议工程导出(给客户端使用)
属性-天生 更改路径 天生-重新天生解决方案
unity里直接导入PESocket与协议dll
客户端也必要一个Session
   Session 用来和客户端进行连接，每个客户端对应一个session（只用关联自己），服务器对应多个客户端（有多个session）  

1. using PENet;
2. using Protocal;
3. using UnityEngine;
5. public class ClientSession:PESession<NetMsg>
6. {
7.     //建立连接
8.     protected override void OnConnected()
9.     {
10.         //PETool.LogMsg("Server Connect");//PESocket里封装好的方法,在控制台输出
11.         Debug.Log("Server Connect");
12.     }
13.     //收到数据
14.     protected override void OnReciveMsg(NetMsg msg)
15.     {
16.         //PETool.LogMsg("Server Rsp:" + msg.text);
17.         Debug.Log("Server Rsp:" + msg.text);
18.     }
19.     //断开连接
20.     protected override void OnDisConnected()
21.     {
22.         //PETool.LogMsg("Server DisConnect");
23.         Debug.Log("Server DisConnect");
24.     }
25. }

复制代码

  GameStart 类，用于管理游戏对象的举动逻辑。这个脚本重要关注于建立与服务器的连接、设置日志记载以及处理用户输入以发送消息给服务器。

1. using UnityEngine;
2. using Protocal;
4. public class GameStart : MonoBehaviour
5. {
6.     PENet.PESocket<ClientSession, NetMsg> client = null;
8.     private void Start()
9.     {
10.         client = new PENet.PESocket<ClientSession, NetMsg>();
11.         client.StartAsClient(IPCfg.srvIP, IPCfg.srvPort);
12.         //启动客户端
14.         //指定一个日志的接口，可以把PESocket里的日志通过unity控制台打印；
15.         //(日志是否开启,日志的回调函数(内容，日志的级别(?)))
16.         client.SetLog(true, (string msg, int lv) =>
17.          {
18.              switch (lv)//对不同的日志级别显示不同的提示
19.             {
20.                  case 0:
21.                      msg = "Log:" + msg;
22.                      Debug.Log(msg);
23.                      break;
24.                  case 1://警告
25.                      msg = "Warn:" + msg;
26.                      Debug.Log(msg);
27.                      break;
28.                  case 2://错误
29.                      msg = "Error:" + msg;
30.                      Debug.Log(msg);
31.                      break;
32.                  case 3://普通信息
33.                      msg = "Info:" + msg;
34.                      Debug.Log(msg);
35.                      break;
37.              }
38.          });
39.     }
41.     private void Update()
42.     {
43.         if (Input.GetKeyDown(KeyCode.Space))
44.         {
45.             client.session.SendMsg(new NetMsg { text = "Hello Unity" });
46.         }
47.     }
48. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。