UnityWebSocket 使用教程

项目介绍

UnityWebSocket 是一个用于 Unity 的 WebSocket 客户端库，它允许开发者在 Unity 项目中轻松实现 WebSocket 通信。WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议，适用于需要实时数据交换的应用场景，如在线游戏、实时聊天等。

项目快速启动

安装

1. 克隆项目仓库到本地：

   git clone https://github.com/psygame/UnityWebSocket.git
   

2. 将 UnityWebSocket 文件夹导入到你的 Unity 项目中。

基本使用

以下是一个简单的示例，展示如何在 Unity 中使用 UnityWebSocket 进行连接、发送和接收消息。

using System;
using System.Text;
using System.Threading;
using UnityEngine;
using UnityWebSocket;

public class WebSocketExample : MonoBehaviour
{
    private WebSocket m_socket;

    void Start()
    {
        m_socket = new WebSocket("ws://echo.websocket.org");

        m_socket.OnOpen += OnOpen;
        m_socket.OnMessage += OnMessage;
        m_socket.OnClose += OnClose;
        m_socket.OnError += OnError;

        m_socket.ConnectAsync();
    }

    private void OnOpen(object sender, OpenEventArgs e)
    {
        Debug.Log("WebSocket Open");
        SendMessage("Hello, WebSocket!");
    }

    private void OnMessage(object sender, MessageEventArgs e)
    {
        Debug.Log("WebSocket Message: " + Encoding.UTF8.GetString(e.RawData));
    }

    private void OnClose(object sender, CloseEventArgs e)
    {
        Debug.Log("WebSocket Close");
    }

    private void OnError(object sender, ErrorEventArgs e)
    {
        Debug.Log("WebSocket Error: " + e.Message);
    }

    private void SendMessage(string message)
    {
        m_socket.SendAsync(Encoding.UTF8.GetBytes(message), null);
    }

    void OnDestroy()
    {
        if (m_socket != null)
        {
            m_socket.CloseAsync();
        }
    }
}

应用案例和最佳实践

实时聊天应用

UnityWebSocket 可以用于实现实时聊天功能。以下是一个简单的实时聊天应用示例：

1. 服务器端：使用 Node.js 和 ws 库创建一个 WebSocket 服务器。

   const WebSocket = require('ws');
   const wss = new WebSocket.Server({ port: 8080 });
   
   wss.on('connection', function connection(ws) {
       ws.on('message', function incoming(message) {
           console.log('received: %s', message);
           wss.clients.forEach(function each(client) {
               if (client !== ws && client.readyState === WebSocket.OPEN) {
                   client.send(message);
               }
           });
       });
   });
   

2. 客户端：在 Unity 中使用 UnityWebSocket 连接到服务器并发送/接收消息。

   using System;
   using System.Text;
   using UnityEngine;
   using UnityWebSocket;
   
   public class ChatClient : MonoBehaviour
   {
       private WebSocket m_socket;
   
       void Start()
       {
           m_socket = new WebSocket("ws://localhost:8080");
   
           m_socket.OnOpen += OnOpen;
           m_socket.OnMessage += OnMessage;
           m_socket.OnClose += OnClose;
           m_socket.OnError += OnError;
   
           m_socket.ConnectAsync();
       }
   
       private void OnOpen(object sender, OpenEventArgs e)
       {
           Debug.Log("WebSocket Open");
       }
   
       private void OnMessage(object sender, MessageEventArgs e)
       {
           Debug.Log("WebSocket Message: " + Encoding.UTF8.GetString(e.RawData));
       }
   
       private void OnClose(object sender, CloseEventArgs e)
       {
           Debug.Log("WebSocket Close");
       }
   
       private void OnError