Unity中Websocket的简单使用
发布时间：2020-02-23 01:06:05
来源：51CTO
阅读：19393
首先我们需要一个websocket服务器，之前的博文中有做
Tomcat架设简单Websocket服务器
用的时候打开就行了，先不管它
Unity中新建场景
建UI(UGUI)
有一个连接按钮Button
一个信息输入框InputField
一个发送按钮Button
一个断开按钮Button
一个消息显示框Text
场景中建一个GameObject，在上面加个脚本，就叫WSMgr好了
用到了BestHTTP这个插件using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using BestHTTP;
using BestHTTP.WebSocket;
using System;
using BestHTTP.Examples;
using UnityEngine.UI;
using System.Text;
public class WSMgr : MonoBehaviour {
//public string url = "ws://localhost:8080/web1/websocket";
public string url = "ws://localhost:8080/web1/ws";
public InputField msg;
public Text console;
private WebSocket webSocket;
private void Start()
{
init();
}
private void init()
{
webSocket = new WebSocket(new Uri(url));
webSocket.OnOpen += OnOpen;
webSocket.OnMessage += OnMessageReceived;
webSocket.OnError += OnError;
webSocket.OnClosed += OnClosed;
}
private void antiInit()
{
webSocket.OnOpen = null;
webSocket.OnMessage = null;
webSocket.OnError = null;
webSocket.OnClosed = null;
webSocket = null;
}
private void setConsoleMsg(string msg)
{
console.text = "Message: " + msg;
}
public void Connect()
{
webSocket.Open();
}
private byte[] getBytes(string message)
{
byte[] buffer = Encoding.Default.GetBytes(message);
return buffer;
}
public void Send()
{
webSocket.Send(msg.text);
}
public void Send(string str)
{
webSocket.Send(str);
}
public void Close()
{
webSocket.Close();
}
#region WebSocket Event Handlers
/// 
/// Called when the web socket is open, and we are ready to send and receive data
/// 
void OnOpen(WebSocket ws)
{
Debug.Log("connected");
setConsoleMsg("Connected");
}
/// 
/// Called when we received a text message from the server
/// 
void OnMessageReceived(WebSocket ws, string message)
{
Debug.Log(message);
setConsoleMsg(message);
}
/// 
/// Called when the web socket closed
/// 
void OnClosed(WebSocket ws, UInt16 code, string message)
{
Debug.Log(message);
setConsoleMsg(message);
antiInit();
init();
}
private void OnDestroy()
{
if(webSocket!=null && webSocket.IsOpen)
{
webSocket.Close();
antiInit();
}
}
/// 
/// Called when an error occured on client side
/// 
void OnError(WebSocket ws, Exception ex)
{
string errorMsg = string.Empty;
#if !UNITY_WEBGL || UNITY_EDITOR
if (ws.InternalRequest.Response != null)
errorMsg = string.Format("Status Code from Server: {0} and Message: {1}", ws.InternalRequest.Response.StatusCode, ws.InternalRequest.Response.Message);
#endif
Debug.Log(errorMsg);
setConsoleMsg(errorMsg);
antiInit();
init();
}
#endregion
}
Connect   Send   Close 三个方法对应的就是三个按钮的功能
OnOpen   OnMessage   OnError   OnClose这四个一看就是Websocket的四个事件对应的方法
首先在Start方法中init()
点击Connect，连接
在输入框中输入，点击Send就发送
点击Close断开连接
底部的Text中会显示消息
同样，Tomcat服务端也有显示
发布WebGL测试可用

今天介绍一下如何在Unity3D下使用WebSocket。
首先介绍一下什么是websocket，以及与socket，和http的区别与联系，然后介绍一下websocket的一些开源的项目。
WebSocket是什么
WebSocket协议是为了实现网络客户端和服务器端全双工通信而引入的一种基于消息帧和TCP的通信机制，这个协议本身的目标是为了在http服务器上引入双向通信的机制，从而克服http单向通信的缺陷(http设计的初衷就不是为了双向通信)，其可以在复用http的端口，支持http的代理，认证等，虽然如此，websocket可以独立于http存在。
详细的内容可以参考RFC6455(https://datatracker.ietf.org/doc/rfc6455/)里面有详细的介绍。
那么WebSocket与http，socket有什么区别和联系呢。
WebSocket和http
其实从历史上来讲，websocket是为了克服http无法双向通信而引入的，在通常的使用中，可以复用http的端口与功能，除此外，他们没有其他的联系，而是完全是独立的协议，通常情况下，http是单向的web
服务，而websocket是全双工的，服务器和客户端可以实时的传输信息，在引用时他们可以在http服务器上同时部署，特别是在NodeJs中。
WebSocket与Socket
那么websocket和socket是什么关系呢？
其实可以理解为websocket是在socket的基础上实现的，其基于消息帧和TCP协议，而socket更通用，在编程中，可以选在tcp，udp，也需要自己控制数据流格式，每次的数据的长度都需要自己控制与读取。
Unity3d下如何使用WebSocket
现在越来越多的Unity3d游戏需要使用websocket或者后台的服务，在实际中，NodeJs，SocketIO越来越多的作为后台的服务加以应用，那么在unity3d的前端上可以使用的开源的websocket有两种：
UnitySocketIO
可以参考https://github.com/kaistseo/UnitySocketIO-WebSocketSharp ，其完全是C# dll的方式Unity3d中使用，测试了在windows和Linux下使用完全没有问题。分析一下优缺点：
优点： 直接使用dll，无unity3d的依赖，代码比较好测试，支持多种消息类型，如文本，Json等。
缺点：需要依赖第三方的库，如SuperSocket，SimpleJson等，在iOS下需要单独维护。
Socket.IO for unity
unity3d 的Asset store上有一个免费的开源项目 Socket.IO for unity (https://www.assetstore.unity3d.com/en/#!/content/21721)可以使用。测试了windows和linux版本，没有问题。 其他的andriod和ios应该也没有问题，根据代码和文档。
优点： 代码直接嵌入到Unity3d中，有所有的源代码，支持Json的消息传输。
缺点： 写测试用例相对繁琐，Json消息简单，不支持对象的Json解析，不过这块应该可以重写。http://blog.csdn.net/leoleocs/article/details/48824921

/// 
///--------------------这是需要连接的URL地址/// 
public string url = "ws://localhost:8080//websocket/";privateWebSocket webSocket;private voidInit()
{
webSocket= new WebSocket(newUri(url));
webSocket.OnOpen+=OnOpen;
webSocket.OnMessage+=OnMessageReceived;
webSocket.OnError+=OnError;
webSocket.OnClosed+=OnClosed;
}private voidAntiInit()
{
webSocket.OnOpen= null;
webSocket.OnMessage= null;
webSocket.OnError= null;
webSocket.OnClosed= null;
webSocket= null;
}public voidConnect()
{
webSocket.Open();
print("发送连接");
}private byte[] getBytes(stringmessage)
{byte[] buffer =Encoding.Default.GetBytes(message);returnbuffer;
}public void Send(stringstr)
{
webSocket.Send(str);
}public voidClose()
{
webSocket.Close();
}voidOnOpen(WebSocket ws)
{
Debug.Log("连接成功");
}/// 
///接收信息/// 
/// 
/// 接收内容
void OnMessageReceived(WebSocket ws,stringmsg)
{
Debug.Log(msg);
SetLog(msg);
}/// 
///关闭连接/// 
void OnClosed(WebSocket ws, UInt16 code, stringmessage)
{
Debug.Log(message);
setConsoleMsg(message);
antiInit();
init();
}private voidOnDestroy()
{if (webSocket != null &&webSocket.IsOpen)
{
webSocket.Close();
antiInit();
}
}/// 
///Called when an error occured on client side/// 
voidOnError(WebSocket ws, Exception ex)
{string errorMsg = string.Empty;#if !UNITY_WEBGL || UNITY_EDITOR
if (ws.InternalRequest.Response != null)
errorMsg= string.Format("Status Code from Server: {0} and Message: {1}",      ws.InternalRequest.Response.StatusCode, ws.InternalRequest.Response.Message);#endifDebug.Log(errorMsg);
setConsoleMsg(errorMsg);
antiInit();
init();
}

Unity 连接ws，不用任何插件，忙活了一天终于搞定了，一直连接不上，原来是没有添加header，
代码比较简单，直接贴出来普度众生
using System;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using UnityEngine;
public class NewBehaviourScript : MonoBehaviour
{
private void Start()
{
WebSocket();
}
public async void WebSocket()
{
try
{
ClientWebSocket ws = new ClientWebSocket();
CancellationToken ct = new CancellationToken();
//添加header
//ws.Options.SetRequestHeader("X-Token", "eyJhbGciOiJIUzI1N");
Uri url = new Uri("ws://121.40.165.18:8800/v1/test/test");
await ws.ConnectAsync(url, ct);
await ws.SendAsync(new ArraySegment(Encoding.UTF8.GetBytes("hello")), WebSocketMessageType.Binary, true, ct); //发送数据
while (true)
{
var result = new byte[1024];
await ws.ReceiveAsync(new ArraySegment(result), new CancellationToken());//接受数据
var str = Encoding.UTF8.GetString(result, 0, result.Length);
Debug.Log(str);
}
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
}