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

已于 2023-11-17 17:28:22 修改
阅读量265 收藏
点赞数
分类专栏： C#Like 文章标签： unity c# websocket 游戏引擎 lua 网络 游戏程序
于 2023-10-27 14:01:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/noodle009/article/details/134073666
版权
本文介绍了C#Like，Unity的热更方案，重点讲解了如何使用C#Like的长链接Socket和WebSocket功能，以及免费版和完整版之间的区别。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

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免费版:

示范代码如下:


using System.Collections.Generic;  
using UnityEngine;  
  
namespace CSharpLike  
{  
    /// <summary>  
    /// 如何使用Socket和WebSocket的示范.  
    /// 所有的函数均在主线程内运行.  
    /// </summary>  
    public class SampleSocket  
    {  
        /// <summary>  
        /// 使用WebSocket还是Socket.  
        /// WebGL将强制使用WebSocket!  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static bool usingWebSocket = false;  
        /// <summary>  
        /// WebSocket的URI(支持WSS).  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static string webSocketURI = "ws://127.0.0.1:9000";  
        /// <summary>  
        /// Socket的Host.  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static string socketHost = "127.0.0.1";  
        /// <summary>  
        /// Socket的端口.  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static int socketPort = 9001;  
        /// <summary>  
        /// RSA公钥,使用Socket的情况下.  
        /// 你应该调用SampleSocket.Instance前设置它.  
        /// 你在Unity编辑器里的C#Like设置面板点击'Generate RSA'按钮后,  
        /// 你可以在Assets/C#Like/Editor/RSAPublicKey.txt找到.   
        /// 如果你不想使用安全模式,你可以设置为空白.  
        /// 安全模式:先通过RSA发送AES密码到服务器,然后客户端和服务器之间使用AES加密传输.  
        /// </summary>  
        public static string socketRSAPublicKey = "";  
        /// <summary>  
        /// WebSocket/Socket对象.  
        /// 在使用它之前, 你应该先设置  
        /// usingWebSocket/webSocketURI/socketHost/socketPort的值  
        /// </summary>  
        public static SampleSocket Instance  
        {  
            get;  
            set;  
        }  
        /// <summary>  
        /// 初始化SampleSocket对象,你必须先初始化它,因为免费版不支持自定义get/set  
        /// </summary>  
        public static void Init()  
        {  
            if (Instance == null)  
                Instance = new SampleSocket();  
        }  
        /// <summary>  
        /// WebSocket/Socket是否已连接.  
        /// </summary>  
        public bool IsConnected()  
        {  
            if (clientWebSocket != null)  
                return clientWebSocket.IsConnected;  
            else if (clientSocket != null)  
                return clientSocket.IsConnected;  
            return false;  
        }  
  
        /// <summary>  
        /// 当WebSocket/Socket连接上后的事件  
        /// </summary>  
        void OnOpen()  
        {  
            Debug.Log("SampleSocket:OnOpen");  
        }  
        /// <summary>  
        /// 当WebSocket/Socket关闭后的事件  
        /// </summary>  
        void OnClose(string msg)  
        {  
            Debug.Log("SampleSocket:OnClose:" + msg);  
        }  
        /// <summary>  
        /// 当WebSocket/Socket发生错误的事件  
        /// </summary>  
        void OnError(string msg)  
        {  
            //just print the message  
            Debug.LogError("SampleSocket:OnError:" + msg);  
        }  
  
        public SampleSocket()  
        {  
            Debug.Log("Application.platform=" + Application.platform);  
            //WebGL平台只支持WebSocket  
            if (usingWebSocket || Application.platform == RuntimePlatform.WebGLPlayer)  
            {  
                Debug.Log("usingWebSocket=true");  
                //初始化WebSocket  
                GameObject go = new GameObject("ClientWebSocket");  
                clientWebSocket = go.AddComponent<CSL_ClientWebSocket>();  
                //设置WebSocket的回调  
                clientWebSocket.onOpen += OnOpen;  
                clientWebSocket.onClose += OnClose;  
                clientWebSocket.onError += OnError;  
                clientWebSocket.onMessage += OnMessage;  
                //设置Uri  
                clientWebSocket.SetUri(webSocketURI);  
                开始连接到服务器  
                //clientWebSocket.Connect();  
            }  
            else  
            {  
                Debug.Log("usingWebSocket=false");  
                //初始化Socket  
                GameObject go = new GameObject("ClientSocket");  
                clientSocket = go.AddComponent<CSL_ClientSocket>();  
                //设置Socket的回调  
                clientSocket.onOpen += OnOpen;  
                clientSocket.onClose += OnClose;  
                clientSocket.onError += OnError;  
                clientSocket.onMessage += OnMessage;  
                clientSocket.Host = socketHost;  
                clientSocket.Port = socketPort;  
                clientSocket.RSAPublicKey = socketRSAPublicKey;  
                开始连接到服务器  
                //clientSocket.Connect();  
            }  
        }  
        /// <summary>  
        /// 关闭当前WebSocket/Socket的连接  
        /// </summary>  
        public void Close()  
        {  
            if (clientWebSocket != null)  
                clientWebSocket.Close();  
            else if (clientSocket != null)  
                clientSocket.Close();  
            else  
                Debug.LogError("SampleSocket : Close : clientWebSocket and clientSocket are both null.");  
        }  
        /// <summary>  
        /// 连接WebSocket/Socket  
        /// </summary>  
        public void Connect()  
        {  
            if (clientWebSocket != null)  
                clientWebSocket.Connect();  
            else if (clientSocket != null)  
                clientSocket.Connect();  
            else  
                Debug.LogError("SampleSocket : Connect : clientWebSocket and clientSocket are both null.");  
        }  
        /// <summary>  
        /// 发送JSON对象到服务器  
        /// </summary>  
        /// <param name="jsonData">将要发到服务器的JSON对象</param>  
        public void Send(JSONData jsonData)  
        {  
            if (clientWebSocket != null)  
                clientWebSocket.Send(jsonData);  
            else if (clientSocket != null)  
                clientSocket.Send(jsonData);  
            else  
                Debug.LogError("SampleSocket : Send : clientWebSocket and clientSocket are both null.");  
        }  
        /// <summary>  
        /// 收到服务器的JSON对象  
        /// </summary>  
        /// <param name="jsonData">服务器发过来的JSON对象</param>  
        void OnMessage(JSONData jsonData)  
        {  
            if (Application.isEditor)  
                Debug.Log("SampleSocket : OnMessage : " + jsonData.ToJson(true));  
            //这里处理不同的命令  
            //int packetType = jsonData["packetType"];//如果设置JSONData.packetIsInteger为true  
            string packetType = jsonData["packetType"];  
            //免费版不能使用枚举,我们采用字符串.  
            //免费版不能使用switch语句,我们使用if-else代替,如果类型很多的话会有性能问题  
            if (packetType == "CB_Error")  
            {  
                Debug.LogError(jsonData["error"]);//我们这里打印一个错误信息  
            }  
            else if (packetType == "CB_Tips")  
            {  
                Debug.Log(jsonData["tips"]);//我们这里打印一个提示信息  
            }  
            else  
            {  
                Debug.LogError("SampleSocket : OnMessage : Unknown packetType : " + packetType);  
            }  
        }  
        /// <summary>  
        /// 销毁WebSocket/Socket对象  
        /// </summary>  
        public void Destroy()  
        {  
            if (clientWebSocket != null)  
                GameObject.Destroy(clientWebSocket.gameObject);  
            else if (clientSocket != null)  
                GameObject.Destroy(clientSocket.gameObject);  
            clientWebSocket = null;  
            clientSocket = null;  
            Instance = null;  
        }  
        CSL_ClientWebSocket clientWebSocket = null;  
        CSL_ClientSocket clientSocket = null;  
    }  
}

 C#Like完整版:

示范代码如下:

using UnityEngine;  
  
namespace CSharpLike  
{  
    /// <summary>  
    /// 如何使用Socket和WebSocket的示范.  
    /// 所有的函数均在主线程内运行.  
    /// </summary>  
    public class SampleSocket  
    {  
        /// <summary>  
        /// 使用WebSocket还是Socket.  
        /// WebGL将强制使用WebSocket!  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static bool usingWebSocket = false;  
        /// <summary>  
        /// WebSocket的URI(支持WSS).  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static string webSocketURI = "ws://127.0.0.1:9000";  
        /// <summary>  
        /// Socket的Host.  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static string socketHost = "127.0.0.1";  
        /// <summary>  
        /// Socket的端口.  
        /// 你应该调用ampleSocket.Instance前设置它.  
        /// </summary>  
        public static int socketPort = 9001;  
        /// <summary>  
        /// RSA公钥,使用Socket的情况下.  
        /// 你应该调用SampleSocket.Instance前设置它.  
        /// 你在Unity编辑器里的C#Like设置面板点击'Generate RSA'按钮后,  
        /// 你可以在Assets/C#Like/Editor/RSAPublicKey.txt找到.   
        /// 如果你不想使用安全模式,你可以设置为空白.  
        /// 安全模式:先通过RSA发送AES密码到服务器,然后客户端和服务器之间使用AES加密传输.  
        /// </summary>  
        public static string socketRSAPublicKey = "";  
        /// <summary>  
        /// WebSocket/Socket对象.  
        /// 在使用它之前, 你应该先设置  
        /// usingWebSocket/webSocketURI/socketHost/socketPort的值  
        /// </summary>  
        public static SampleSocket Instance  
        {  
            get  
            {  
                if (mInstance == null)  
                    mInstance = new SampleSocket();  
                return mInstance;  
            }  
        }  
        /// <summary>  
        /// WebSocket/Socket是否已连接.  
        /// </summary>  
        public bool IsConnected  
        {  
            get  
            {  
                if (clientWebSocket != null)  
                    return clientWebSocket.IsConnected;  
                else if (clientSocket != null)  
                    return clientSocket.IsConnected;  
                return false;  
            }  
        }  
  
        /// <summary>  
        /// 当WebSocket/Socket连接上后的事件  
        /// </summary>  
        void OnOpen()  
        {  
            Debug.Log("SampleSocket:OnOpen");  
        }  
        /// <summary>  
        /// 当WebSocket/Socket关闭后的事件  
        /// </summary>  
        void OnClose(string msg)  
        {  
            Debug.Log("SampleSocket:OnClose:" + msg);  
        }  
        /// <summary>  
        /// 当WebSocket/Socket发生错误的事件  
        /// </summary>  
        void OnError(string msg)  
        {  
            //just print the message  
            Debug.LogError("SampleSocket:OnError:" + msg);  
        }  
  
        public SampleSocket()  
        {  
            Debug.Log("Application.platform=" + Application.platform);  
            //WebGL平台只支持WebSocket  
            if (usingWebSocket || Application.platform == RuntimePlatform.WebGLPlayer)  
            {  
                Debug.Log("usingWebSocket=true");  
                //初始化WebSocket  
                GameObject go = new GameObject("ClientWebSocket");  
                clientWebSocket = go.AddComponent<CSL_ClientWebSocket>();  
                //设置WebSocket的回调  
                clientWebSocket.onOpen += OnOpen;  
                clientWebSocket.onClose += OnClose;  
                clientWebSocket.onError += OnError;  
                clientWebSocket.onMessage += OnMessage;  
                //设置Uri  
                clientWebSocket.SetUri(webSocketURI);  
                开始连接到服务器  
                //clientWebSocket.Connect();  
            }  
            else  
            {  
                Debug.Log("usingWebSocket=false");  
                //初始化Socket  
                GameObject go = new GameObject("ClientSocket");  
                clientSocket = go.AddComponent<CSL_ClientSocket>();  
                //设置Socket的回调  
                clientSocket.onOpen += OnOpen;  
                clientSocket.onClose += OnClose;  
                clientSocket.onError += OnError;  
                clientSocket.onMessage += OnMessage;  
                clientSocket.Host = socketHost;  
                clientSocket.Port = socketPort;  
                clientSocket.RSAPublicKey = socketRSAPublicKey;  
                开始连接到服务器  
                //clientSocket.Connect();  
            }  
        }  
        /// <summary>  
        /// 关闭当前WebSocket/Socket的连接  
        /// </summary>  
        public void Close()  
        {  
            if (clientWebSocket != null)  
                clientWebSocket.Close();  
            else if (clientSocket != null)  
                clientSocket.Close();  
            else  
                Debug.LogError("SampleSocket : Close : clientWebSocket and clientSocket are both null.");  
        }  
        /// <summary>  
        /// 连接WebSocket/Socket  
        /// </summary>  
        public void Connect()  
        {  
            if (clientWebSocket != null)  
                clientWebSocket.Connect();  
            else if (clientSocket != null)  
                clientSocket.Connect();  
            else  
                Debug.LogError("SampleSocket : Connect : clientWebSocket and clientSocket are both null.");  
        }  
        /// <summary>  
        /// 发送JSON对象到服务器  
        /// </summary>  
        /// <param name="jsonData">将要发到服务器的JSON对象</param>  
        public void Send(JSONData jsonData)  
        {  
            if (clientWebSocket != null)  
                clientWebSocket.Send(jsonData);  
            else if (clientSocket != null)  
                clientSocket.Send(jsonData);  
            else  
                Debug.LogError("SampleSocket : Send : clientWebSocket and clientSocket are both null.");  
        }  
        /// <summary>  
        /// 收到服务器的JSON对象  
        /// </summary>  
        /// <param name="jsonData">服务器发过来的JSON对象</param>  
        void OnMessage(JSONData jsonData)  
        {  
            if (Application.isEditor)  
                Debug.Log("SampleSocket : OnMessage : " + jsonData.ToJson(true));  
            //这里处理不同的命令  
            switch ((PacketType)jsonData.GetPacketType(typeof(PacketType)))  
            {  
                case PacketType.CB_Error:  
                    Debug.LogError(jsonData["error"]);//我们这里打印一个错误信息  
                    break;  
                case PacketType.CB_Tips:  
                    Debug.Log(jsonData["tips"]);//我们这里打印一个提示信息  
                    break;  
                default:  
                    Debug.LogError("SampleSocket : OnMessage : Unknown packetType : " + jsonData["packetType"]);  
                    break;  
            }  
        }  
        /// <summary>  
        /// 销毁WebSocket/Socket对象  
        /// </summary>  
        public void Destroy()  
        {  
            if (clientWebSocket != null)  
                GameObject.Destroy(clientWebSocket.gameObject);  
            else if (clientSocket != null)  
                GameObject.Destroy(clientSocket.gameObject);  
            clientWebSocket = null;  
            clientSocket = null;  
            mInstance = null;  
        }  
        static SampleSocket mInstance;  
        CSL_ClientWebSocket clientWebSocket = null;  
        CSL_ClientSocket clientSocket = null;  
    }  
}

 本系列文章导读:

评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

C#Like

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值