devbox
凡人多烦事01
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Unity热更新方案C#Like(十七)-详解支持的长链接Socket和WebSocket_unity 实现长链接

作者：凡人多烦事01 | 2024-02-18 10:31:47

赞

踩

unity 实现长链接

C#Like是Unity的热更方案,使用纯C#语言写出可以热更新的代码,就像可以在所有平台使用DLL(动态链接库)文件一样.遵从KISS设计原则,让用户轻松构建或升级成Unity的热更新项目.

简介

本篇主要介绍C#Like支持的长链接Socket和WebSocket,免费版和完整版都支持,示范代码差别在于完整版的使用了自定义get/set和使用了switch语句.

  • Socket: 对应内置的类CSL_ClientSocket
  • WebSocket: 对应内置的类CSL_ClientWebSocket
  • 注意在WebGL平台下只支持WebSocket,如果你的应用包含WebGL平台,必须包含WebSocket,如示范代码一样使用.

这里仅示范客户端的主接口代码,更加详尽的用法详见 Unity热更新方案C#Like(廿一)-详解KissFrameworkServer:对应的示范例子和官网所用的服务器框架

C#Like免费版:

示范代码如下:

  1.  
  2. using System.Collections.Generic;  
  3. using UnityEngine;  
  4.   
  5. namespace CSharpLike  
  6. {  
  7.     /// <summary>  
  8.     /// 如何使用Socket和WebSocket的示范.  
  9.     /// 所有的函数均在主线程内运行.  
  10.     /// </summary>  
  11.     public class SampleSocket  
  12.     {  
  13.         /// <summary>  
  14.         /// 使用WebSocket还是Socket.  
  15.         /// WebGL将强制使用WebSocket!  
  16.         /// 你应该调用ampleSocket.Instance前设置它.  
  17.         /// </summary>  
  18.         public static bool usingWebSocket = false;  
  19.         /// <summary>  
  20.         /// WebSocket的URI(支持WSS).  
  21.         /// 你应该调用ampleSocket.Instance前设置它.  
  22.         /// </summary>  
  23.         public static string webSocketURI = "ws://127.0.0.1:9000";  
  24.         /// <summary>  
  25.         /// Socket的Host.  
  26.         /// 你应该调用ampleSocket.Instance前设置它.  
  27.         /// </summary>  
  28.         public static string socketHost = "127.0.0.1";  
  29.         /// <summary>  
  30.         /// Socket的端口.  
  31.         /// 你应该调用ampleSocket.Instance前设置它.  
  32.         /// </summary>  
  33.         public static int socketPort = 9001;  
  34.         /// <summary>  
  35.         /// RSA公钥,使用Socket的情况下.  
  36.         /// 你应该调用SampleSocket.Instance前设置它.  
  37.         /// 你在Unity编辑器里的C#Like设置面板点击'Generate RSA'按钮后,  
  38.         /// 你可以在Assets/C#Like/Editor/RSAPublicKey.txt找到.   
  39.         /// 如果你不想使用安全模式,你可以设置为空白.  
  40.         /// 安全模式:先通过RSA发送AES密码到服务器,然后客户端和服务器之间使用AES加密传输.  
  41.         /// </summary>  
  42.         public static string socketRSAPublicKey = "";  
  43.         /// <summary>  
  44.         /// WebSocket/Socket对象.  
  45.         /// 在使用它之前, 你应该先设置  
  46.         /// usingWebSocket/webSocketURI/socketHost/socketPort的值  
  47.         /// </summary>  
  48.         public static SampleSocket Instance  
  49.         {  
  50.             get;  
  51.             set;  
  52.         }  
  53.         /// <summary>  
  54.         /// 初始化SampleSocket对象,你必须先初始化它,因为免费版不支持自定义get/set  
  55.         /// </summary>  
  56.         public static void Init()  
  57.         {  
  58.             if (Instance == null)  
  59.                 Instance = new SampleSocket();  
  60.         }  
  61.         /// <summary>  
  62.         /// WebSocket/Socket是否已连接.  
  63.         /// </summary>  
  64.         public bool IsConnected()  
  65.         {  
  66.             if (clientWebSocket != null)  
  67.                 return clientWebSocket.IsConnected;  
  68.             else if (clientSocket != null)  
  69.                 return clientSocket.IsConnected;  
  70.             return false;  
  71.         }  
  72.   
  73.         /// <summary>  
  74.         /// 当WebSocket/Socket连接上后的事件  
  75.         /// </summary>  
  76.         void OnOpen()  
  77.         {  
  78.             Debug.Log("SampleSocket:OnOpen");  
  79.         }  
  80.         /// <summary>  
  81.         /// 当WebSocket/Socket关闭后的事件  
  82.         /// </summary>  
  83.         void OnClose(string msg)  
  84.         {  
  85.             Debug.Log("SampleSocket:OnClose:" + msg);  
  86.         }  
  87.         /// <summary>  
  88.         /// 当WebSocket/Socket发生错误的事件  
  89.         /// </summary>  
  90.         void OnError(string msg)  
  91.         {  
  92.             //just print the message  
  93.             Debug.LogError("SampleSocket:OnError:" + msg);  
  94.         }  
  95.   
  96.         public SampleSocket()  
  97.         {  
  98.             Debug.Log("Application.platform=" + Application.platform);  
  99.             //WebGL平台只支持WebSocket  
  100.             if (usingWebSocket || Application.platform == RuntimePlatform.WebGLPlayer)  
  101.             {  
  102.                 Debug.Log("usingWebSocket=true");  
  103.                 //初始化WebSocket  
  104.                 GameObject go = new GameObject("ClientWebSocket");  
  105.                 clientWebSocket = go.AddComponent<CSL_ClientWebSocket>();  
  106.                 //设置WebSocket的回调  
  107.                 clientWebSocket.onOpen += OnOpen;  
  108.                 clientWebSocket.onClose += OnClose;  
  109.                 clientWebSocket.onError += OnError;  
  110.                 clientWebSocket.onMessage += OnMessage;  
  111.                 //设置Uri  
  112.                 clientWebSocket.SetUri(webSocketURI);  
  113.                 开始连接到服务器  
  114.                 //clientWebSocket.Connect();  
  115.             }  
  116.             else  
  117.             {  
  118.                 Debug.Log("usingWebSocket=false");  
  119.                 //初始化Socket  
  120.                 GameObject go = new GameObject("ClientSocket");  
  121.                 clientSocket = go.AddComponent<CSL_ClientSocket>();  
  122.                 //设置Socket的回调  
  123.                 clientSocket.onOpen += OnOpen;  
  124.                 clientSocket.onClose += OnClose;  
  125.                 clientSocket.onError += OnError;  
  126.                 clientSocket.onMessage += OnMessage;  
  127.                 clientSocket.Host = socketHost;  
  128.                 clientSocket.Port = socketPort;  
  129.                 clientSocket.RSAPublicKey = socketRSAPublicKey;  
  130.                 开始连接到服务器  
  131.                 //clientSocket.Connect();  
  132.             }  
  133.         }  
  134.         /// <summary>  
  135.         /// 关闭当前WebSocket/Socket的连接  
  136.         /// </summary>  
  137.         public void Close()  
  138.         {  
  139.             if (clientWebSocket != null)  
  140.                 clientWebSocket.Close();  
  141.             else if (clientSocket != null)  
  142.                 clientSocket.Close();  
  143.             else  
  144.                 Debug.LogError("SampleSocket : Close : clientWebSocket and clientSocket are both null.");  
  145.         }  
  146.         /// <summary>  
  147.         /// 连接WebSocket/Socket  
  148.         /// </summary>  
  149.         public void Connect()  
  150.         {  
  151.             if (clientWebSocket != null)  
  152.                 clientWebSocket.Connect();  
  153.             else if (clientSocket != null)  
  154.                 clientSocket.Connect();  
  155.             else  
  156.                 Debug.LogError("SampleSocket : Connect : clientWebSocket and clientSocket are both null.");  
  157.         }  
  158.         /// <summary>  
  159.         /// 发送JSON对象到服务器  
  160.         /// </summary>  
  161.         /// <param name="jsonData">将要发到服务器的JSON对象</param>  
  162.         public void Send(JSONData jsonData)  
  163.         {  
  164.             if (clientWebSocket != null)  
  165.                 clientWebSocket.Send(jsonData);  
  166.             else if (clientSocket != null)  
  167.                 clientSocket.Send(jsonData);  
  168.             else  
  169.                 Debug.LogError("SampleSocket : Send : clientWebSocket and clientSocket are both null.");  
  170.         }  
  171.         /// <summary>  
  172.         /// 收到服务器的JSON对象  
  173.         /// </summary>  
  174.         /// <param name="jsonData">服务器发过来的JSON对象</param>  
  175.         void OnMessage(JSONData jsonData)  
  176.         {  
  177.             if (Application.isEditor)  
  178.                 Debug.Log("SampleSocket : OnMessage : " + jsonData.ToJson(true));  
  179.             //这里处理不同的命令  
  180.             //int packetType = jsonData["packetType"];//如果设置JSONData.packetIsInteger为true  
  181.             string packetType = jsonData["packetType"];  
  182.             //免费版不能使用枚举,我们采用字符串.  
  183.             //免费版不能使用switch语句,我们使用if-else代替,如果类型很多的话会有性能问题  
  184.             if (packetType == "CB_Error")  
  185.             {  
  186.                 Debug.LogError(jsonData["error"]);//我们这里打印一个错误信息  
  187.             }  
  188.             else if (packetType == "CB_Tips")  
  189.             {  
  190.                 Debug.Log(jsonData["tips"]);//我们这里打印一个提示信息  
  191.             }  
  192.             else  
  193.             {  
  194.                 Debug.LogError("SampleSocket : OnMessage : Unknown packetType : " + packetType);  
  195.             }  
  196.         }  
  197.         /// <summary>  
  198.         /// 销毁WebSocket/Socket对象  
  199.         /// </summary>  
  200.         public void Destroy()  
  201.         {  
  202.             if (clientWebSocket != null)  
  203.                 GameObject.Destroy(clientWebSocket.gameObject);  
  204.             else if (clientSocket != null)  
  205.                 GameObject.Destroy(clientSocket.gameObject);  
  206.             clientWebSocket = null;  
  207.             clientSocket = null;  
  208.             Instance = null;  
  209.         }  
  210.         CSL_ClientWebSocket clientWebSocket = null;  
  211.         CSL_ClientSocket clientSocket = null;  
  212.     }  
  213. }

 C#Like完整版:

示范代码如下:

  1. using UnityEngine;  
  2.   
  3. namespace CSharpLike  
  4. {  
  5.     /// <summary>  
  6.     /// 如何使用Socket和WebSocket的示范.  
  7.     /// 所有的函数均在主线程内运行.  
  8.     /// </summary>  
  9.     public class SampleSocket  
  10.     {  
  11.         /// <summary>  
  12.         /// 使用WebSocket还是Socket.  
  13.         /// WebGL将强制使用WebSocket!  
  14.         /// 你应该调用ampleSocket.Instance前设置它.  
  15.         /// </summary>  
  16.         public static bool usingWebSocket = false;  
  17.         /// <summary>  
  18.         /// WebSocket的URI(支持WSS).  
  19.         /// 你应该调用ampleSocket.Instance前设置它.  
  20.         /// </summary>  
  21.         public static string webSocketURI = "ws://127.0.0.1:9000";  
  22.         /// <summary>  
  23.         /// Socket的Host.  
  24.         /// 你应该调用ampleSocket.Instance前设置它.  
  25.         /// </summary>  
  26.         public static string socketHost = "127.0.0.1";  
  27.         /// <summary>  
  28.         /// Socket的端口.  
  29.         /// 你应该调用ampleSocket.Instance前设置它.  
  30.         /// </summary>  
  31.         public static int socketPort = 9001;  
  32.         /// <summary>  
  33.         /// RSA公钥,使用Socket的情况下.  
  34.         /// 你应该调用SampleSocket.Instance前设置它.  
  35.         /// 你在Unity编辑器里的C#Like设置面板点击'Generate RSA'按钮后,  
  36.         /// 你可以在Assets/C#Like/Editor/RSAPublicKey.txt找到.   
  37.         /// 如果你不想使用安全模式,你可以设置为空白.  
  38.         /// 安全模式:先通过RSA发送AES密码到服务器,然后客户端和服务器之间使用AES加密传输.  
  39.         /// </summary>  
  40.         public static string socketRSAPublicKey = "";  
  41.         /// <summary>  
  42.         /// WebSocket/Socket对象.  
  43.         /// 在使用它之前, 你应该先设置  
  44.         /// usingWebSocket/webSocketURI/socketHost/socketPort的值  
  45.         /// </summary>  
  46.         public static SampleSocket Instance  
  47.         {  
  48.             get  
  49.             {  
  50.                 if (mInstance == null)  
  51.                     mInstance = new SampleSocket();  
  52.                 return mInstance;  
  53.             }  
  54.         }  
  55.         /// <summary>  
  56.         /// WebSocket/Socket是否已连接.  
  57.         /// </summary>  
  58.         public bool IsConnected  
  59.         {  
  60.             get  
  61.             {  
  62.                 if (clientWebSocket != null)  
  63.                     return clientWebSocket.IsConnected;  
  64.                 else if (clientSocket != null)  
  65.                     return clientSocket.IsConnected;  
  66.                 return false;  
  67.             }  
  68.         }  
  69.   
  70.         /// <summary>  
  71.         /// 当WebSocket/Socket连接上后的事件  
  72.         /// </summary>  
  73.         void OnOpen()  
  74.         {  
  75.             Debug.Log("SampleSocket:OnOpen");  
  76.         }  
  77.         /// <summary>  
  78.         /// 当WebSocket/Socket关闭后的事件  
  79.         /// </summary>  
  80.         void OnClose(string msg)  
  81.         {  
  82.             Debug.Log("SampleSocket:OnClose:" + msg);  
  83.         }  
  84.         /// <summary>  
  85.         /// 当WebSocket/Socket发生错误的事件  
  86.         /// </summary>  
  87.         void OnError(string msg)  
  88.         {  
  89.             //just print the message  
  90.             Debug.LogError("SampleSocket:OnError:" + msg);  
  91.         }  
  92.   
  93.         public SampleSocket()  
  94.         {  
  95.             Debug.Log("Application.platform=" + Application.platform);  
  96.             //WebGL平台只支持WebSocket  
  97.             if (usingWebSocket || Application.platform == RuntimePlatform.WebGLPlayer)  
  98.             {  
  99.                 Debug.Log("usingWebSocket=true");  
  100.                 //初始化WebSocket  
  101.                 GameObject go = new GameObject("ClientWebSocket");  
  102.                 clientWebSocket = go.AddComponent<CSL_ClientWebSocket>();  
  103.                 //设置WebSocket的回调  
  104.                 clientWebSocket.onOpen += OnOpen;  
  105.                 clientWebSocket.onClose += OnClose;  
  106.                 clientWebSocket.onError += OnError;  
  107.                 clientWebSocket.onMessage += OnMessage;  
  108.                 //设置Uri  
  109.                 clientWebSocket.SetUri(webSocketURI);  
  110.                 开始连接到服务器  
  111.                 //clientWebSocket.Connect();  
  112.             }  
  113.             else  
  114.             {  
  115.                 Debug.Log("usingWebSocket=false");  
  116.                 //初始化Socket  
  117.                 GameObject go = new GameObject("ClientSocket");  
  118.                 clientSocket = go.AddComponent<CSL_ClientSocket>();  
  119.                 //设置Socket的回调  
  120.                 clientSocket.onOpen += OnOpen;  
  121.                 clientSocket.onClose += OnClose;  
  122.                 clientSocket.onError += OnError;  
  123.                 clientSocket.onMessage += OnMessage;  
  124.                 clientSocket.Host = socketHost;  
  125.                 clientSocket.Port = socketPort;  
  126.                 clientSocket.RSAPublicKey = socketRSAPublicKey;  
  127.                 开始连接到服务器  
  128.                 //clientSocket.Connect();  
  129.             }  
  130.         }  
  131.         /// <summary>  
  132.         /// 关闭当前WebSocket/Socket的连接  
  133.         /// </summary>  
  134.         public void Close()  
  135.         {  
  136.             if (clientWebSocket != null)  
  137.                 clientWebSocket.Close();  
  138.             else if (clientSocket != null)  
  139.                 clientSocket.Close();  
  140.             else  
  141.                 Debug.LogError("SampleSocket : Close : clientWebSocket and clientSocket are both null.");  
  142.         }  
  143.         /// <summary>  
  144.         /// 连接WebSocket/Socket  
  145.         /// </summary>  
  146.         public void Connect()  
  147.         {  
  148.             if (clientWebSocket != null)  
  149.                 clientWebSocket.Connect();  
  150.             else if (clientSocket != null)  
  151.                 clientSocket.Connect();  
  152.             else  
  153.                 Debug.LogError("SampleSocket : Connect : clientWebSocket and clientSocket are both null.");  
  154.         }  
  155.         /// <summary>  
  156.         /// 发送JSON对象到服务器  
  157.         /// </summary>  
  158.         /// <param name="jsonData">将要发到服务器的JSON对象</param>  
  159.         public void Send(JSONData jsonData)  
  160.         {  
  161.             if (clientWebSocket != null)  
  162.                 clientWebSocket.Send(jsonData);  
  163.             else if (clientSocket != null)  
  164.                 clientSocket.Send(jsonData);  
  165.             else  
  166.                 Debug.LogError("SampleSocket : Send : clientWebSocket and clientSocket are both null.");  
  167.         }  
  168.         /// <summary>  
  169.         /// 收到服务器的JSON对象  
  170.         /// </summary>  
  171.         /// <param name="jsonData">服务器发过来的JSON对象</param>  
  172.         void OnMessage(JSONData jsonData)  
  173.         {  
  174.             if (Application.isEditor)  
  175.                 Debug.Log("SampleSocket : OnMessage : " + jsonData.ToJson(true));  
  176.             //这里处理不同的命令  
  177.             switch ((PacketType)jsonData.GetPacketType(typeof(PacketType)))  
  178.             {  
  179.                 case PacketType.CB_Error:  
  180.                     Debug.LogError(jsonData["error"]);//我们这里打印一个错误信息  
  181.                     break;  
  182.                 case PacketType.CB_Tips:  
  183.                     Debug.Log(jsonData["tips"]);//我们这里打印一个提示信息  
  184.                     break;  
  185.                 default:  
  186.                     Debug.LogError("SampleSocket : OnMessage : Unknown packetType : " + jsonData["packetType"]);  
  187.                     break;  
  188.             }  
  189.         }  
  190.         /// <summary>  
  191.         /// 销毁WebSocket/Socket对象  
  192.         /// </summary>  
  193.         public void Destroy()  
  194.         {  
  195.             if (clientWebSocket != null)  
  196.                 GameObject.Destroy(clientWebSocket.gameObject);  
  197.             else if (clientSocket != null)  
  198.                 GameObject.Destroy(clientSocket.gameObject);  
  199.             clientWebSocket = null;  
  200.             clientSocket = null;  
  201.             mInstance = null;  
  202.         }  
  203.         static SampleSocket mInstance;  
  204.         CSL_ClientWebSocket clientWebSocket = null;  
  205.         CSL_ClientSocket clientSocket = null;  
  206.     }  
  207. }

 本系列文章导读:

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/凡人多烦事01/article/detail/107317
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号