Core Helper

Core Helper
This commit is contained in:
ALEXTANG
2022-08-29 20:57:41 +08:00
parent f5e783a42c
commit 8c1c3b7291
26 changed files with 635 additions and 0 deletions

View File

@@ -0,0 +1,8 @@
fileFormatVersion: 2
guid: 9de71dee8e9fb74469064a1e1cf7a77b
folderAsset: yes
DefaultImporter:
externalObjects: {}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,13 @@
namespace TEngine.Runtime
{
public abstract class CSPacketBase : PacketBase
{
public override PacketType PacketType
{
get
{
return PacketType.ClientToServer;
}
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: ae0dc3216c53aaa4bb05456c6acc64f7
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,13 @@
namespace TEngine.Runtime
{
public sealed class CSPacketHeader : PacketHeaderBase
{
public override PacketType PacketType
{
get
{
return PacketType.ClientToServer;
}
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 383e04755715b054f9e57b1ab1d322af
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,255 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using ProtoBuf;
using ProtoBuf.Meta;
namespace TEngine.Runtime
{
public class NetworkChannelHelper : INetworkChannelHelper
{
private readonly Dictionary<int, Type> m_ServerToClientPacketTypes = new Dictionary<int, Type>();
private readonly MemoryStream m_CachedStream = new MemoryStream(1024 * 8);
private INetworkChannel m_NetworkChannel = null;
/// <summary>
/// 获取消息包头长度。
/// </summary>
public int PacketHeaderLength => sizeof(int);
/// <summary>
/// 初始化网络频道辅助器。
/// </summary>
/// <param name="networkChannel">网络频道。</param>
public void Initialize(INetworkChannel networkChannel)
{
m_NetworkChannel = networkChannel;
// 反射注册包和包处理函数。
Type packetBaseType = typeof(SCPacketBase);
Type packetHandlerBaseType = typeof(PacketHandlerBase);
Assembly assembly = Assembly.GetExecutingAssembly();
Type[] types = assembly.GetTypes();
for (int i = 0; i < types.Length; i++)
{
if (!types[i].IsClass || types[i].IsAbstract)
{
continue;
}
if (types[i].BaseType == packetBaseType)
{
PacketBase packetBase = (PacketBase)Activator.CreateInstance(types[i]);
Type packetType = GetServerToClientPacketType(packetBase.Id);
if (packetType != null)
{
Log.Warning("Already exist packet type '{0}', check '{1}' or '{2}'?.", packetBase.Id.ToString(), packetType.Name, packetBase.GetType().Name);
continue;
}
m_ServerToClientPacketTypes.Add(packetBase.Id, types[i]);
}
else if (types[i].BaseType == packetHandlerBaseType)
{
IPacketHandler packetHandler = (IPacketHandler)Activator.CreateInstance(types[i]);
m_NetworkChannel.RegisterHandler(packetHandler);
}
}
NetEvent.Instance.Subscribe(NetworkConnectedEventArgs.EventId, OnNetworkConnected);
NetEvent.Instance.Subscribe(NetworkClosedEventArgs.EventId, OnNetworkClosed);
NetEvent.Instance.Subscribe(NetworkMissHeartBeatEventArgs.EventId, OnNetworkMissHeartBeat);
NetEvent.Instance.Subscribe(NetworkErrorEventArgs.EventId, OnNetworkError);
NetEvent.Instance.Subscribe(NetworkCustomErrorEventArgs.EventId, OnNetworkCustomError);
}
/// <summary>
/// 准备进行连接。
/// </summary>
public void PrepareForConnecting()
{
m_NetworkChannel.Socket.ReceiveBufferSize = 1024 * 64;
m_NetworkChannel.Socket.SendBufferSize = 1024 * 64;
}
/// <summary>
/// 发送心跳消息包。
/// </summary>
/// <returns>是否发送心跳消息包成功。</returns>
public bool SendHeartBeat()
{
m_NetworkChannel.Send(MemoryPool.Acquire<CSHeartBeat>());
return true;
}
/// <summary>
/// 序列化消息包。
/// </summary>
/// <typeparam name="T">消息包类型。</typeparam>
/// <param name="packet">要序列化的消息包。</param>
/// <param name="destination">要序列化的目标流。</param>
/// <returns>是否序列化成功。</returns>
public bool Serialize<T>(T packet, Stream destination) where T : Packet
{
PacketBase packetImpl = packet as PacketBase;
if (packetImpl == null)
{
Log.Warning("Packet is invalid.");
return false;
}
if (packetImpl.PacketType != PacketType.ClientToServer)
{
Log.Warning("Send packet invalid.");
return false;
}
m_CachedStream.SetLength(m_CachedStream.Capacity); // 此行防止 Array.Copy 的数据无法写入
m_CachedStream.Position = 0L;
CSPacketHeader packetHeader = MemoryPool.Acquire<CSPacketHeader>();
Serializer.Serialize(m_CachedStream, packetHeader);
MemoryPool.Release(packetHeader);
Serializer.SerializeWithLengthPrefix(m_CachedStream, packet, PrefixStyle.Fixed32);
MemoryPool.Release((IMemory)packet);
m_CachedStream.WriteTo(destination);
return true;
}
/// <summary>
/// 反序列化消息包。
/// </summary>
/// <param name="packetHeader">消息包头。</param>
/// <param name="source">要反序列化的来源流。</param>
/// <param name="customErrorData">用户自定义错误数据。</param>
/// <returns>反序列化后的消息包。</returns>
public Packet DeserializePacket(IPacketHeader packetHeader, Stream source, out object customErrorData)
{
// 注意:此函数并不在主线程调用!
customErrorData = null;
SCPacketHeader scPacketHeader = packetHeader as SCPacketHeader;
if (scPacketHeader == null)
{
Log.Warning("Packet header is invalid.");
return null;
}
Packet packet = null;
if (scPacketHeader.IsValid)
{
Type packetType = GetServerToClientPacketType(scPacketHeader.Id);
if (packetType != null)
{
packet = (Packet)RuntimeTypeModel.Default.DeserializeWithLengthPrefix(source, MemoryPool.Acquire(packetType), packetType, PrefixStyle.Fixed32, 0);
}
else
{
Log.Warning("Can not deserialize packet for packet id '{0}'.", scPacketHeader.Id.ToString());
}
}
else
{
Log.Warning("Packet header is invalid.");
}
MemoryPool.Release(scPacketHeader);
return packet;
}
public IPacketHeader DeserializePacketHeader(Stream source, out object customErrorData)
{
// 注意:此函数并不在主线程调用!
customErrorData = null;
return (IPacketHeader)RuntimeTypeModel.Default.Deserialize(source, MemoryPool.Acquire<SCPacketHeader>(), typeof(SCPacketHeader));
}
private Type GetServerToClientPacketType(int id)
{
Type type = null;
if (m_ServerToClientPacketTypes.TryGetValue(id, out type))
{
return type;
}
return null;
}
/// <summary>
/// 关闭并清理网络频道辅助器。
/// </summary>
public void Shutdown()
{
NetEvent.Instance.Unsubscribe(NetworkConnectedEventArgs.EventId, OnNetworkConnected);
NetEvent.Instance.Unsubscribe(NetworkClosedEventArgs.EventId, OnNetworkClosed);
NetEvent.Instance.Unsubscribe(NetworkMissHeartBeatEventArgs.EventId, OnNetworkMissHeartBeat);
NetEvent.Instance.Unsubscribe(NetworkErrorEventArgs.EventId, OnNetworkError);
NetEvent.Instance.Unsubscribe(NetworkCustomErrorEventArgs.EventId, OnNetworkCustomError);
m_NetworkChannel = null;
}
#region Handle
private void OnNetworkConnected(object sender, GameEventArgs e)
{
NetworkConnectedEventArgs ne = (NetworkConnectedEventArgs)e;
if (ne.NetworkChannel != m_NetworkChannel)
{
return;
}
Log.Info("Network channel '{0}' connected, local address '{1}', remote address '{2}'.", ne.NetworkChannel.Name, ne.NetworkChannel.Socket.LocalEndPoint.ToString(), ne.NetworkChannel.Socket.RemoteEndPoint.ToString());
}
private void OnNetworkClosed(object sender, GameEventArgs e)
{
NetworkClosedEventArgs ne = (NetworkClosedEventArgs)e;
if (ne.NetworkChannel != m_NetworkChannel)
{
return;
}
Log.Info("Network channel '{0}' closed.", ne.NetworkChannel.Name);
}
private void OnNetworkMissHeartBeat(object sender, GameEventArgs e)
{
NetworkMissHeartBeatEventArgs ne = (NetworkMissHeartBeatEventArgs)e;
if (ne.NetworkChannel != m_NetworkChannel)
{
return;
}
Log.Info("Network channel '{0}' miss heart beat '{1}' times.", ne.NetworkChannel.Name, ne.MissCount.ToString());
if (ne.MissCount < 2)
{
return;
}
ne.NetworkChannel.Close();
}
private void OnNetworkError(object sender, GameEventArgs e)
{
NetworkErrorEventArgs ne = (NetworkErrorEventArgs)e;
if (ne.NetworkChannel != m_NetworkChannel)
{
return;
}
Log.Info("Network channel '{0}' error, error code is '{1}', error message is '{2}'.", ne.NetworkChannel.Name, ne.ErrorCode.ToString(), ne.ErrorMessage);
ne.NetworkChannel.Close();
}
private void OnNetworkCustomError(object sender, GameEventArgs e)
{
NetworkCustomErrorEventArgs ne = (NetworkCustomErrorEventArgs)e;
if (ne.NetworkChannel != m_NetworkChannel)
{
return;
}
}
#endregion
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 02d761e658b2dcd4ea9ebff4ce324968
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,8 @@
fileFormatVersion: 2
guid: 77278504198432741b5b1efb12e04803
folderAsset: yes
DefaultImporter:
externalObjects: {}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,19 @@
using System;
using ProtoBuf;
namespace TEngine.Runtime
{
[Serializable, ProtoContract(Name = @"CSHeartBeat")]
public class CSHeartBeat : CSPacketBase
{
public CSHeartBeat()
{
}
public override int Id => 1;
public override void Clear()
{
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 0df96c80b0460c24fad98087851fd96c
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,20 @@
using ProtoBuf;
using System;
namespace TEngine.Runtime
{
[Serializable, ProtoContract(Name = @"SCHeartBeat")]
public class SCHeartBeat : SCPacketBase
{
public SCHeartBeat()
{
}
public override int Id => 2;
public override void Clear()
{
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 2c6c67efd23a0ea49b469cde0c44f234
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,24 @@
using ProtoBuf;
namespace TEngine.Runtime
{
public abstract class PacketBase : Packet, IExtensible
{
private IExtension m_ExtensionObject;
public PacketBase()
{
m_ExtensionObject = null;
}
public abstract PacketType PacketType
{
get;
}
IExtension IExtensible.GetExtensionObject(bool createIfMissing)
{
return Extensible.GetExtensionObject(ref m_ExtensionObject, createIfMissing);
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: e8f72df0df1102a4493aac4a082edb0a
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,12 @@
namespace TEngine.Runtime
{
public abstract class PacketHandlerBase : IPacketHandler
{
public abstract int Id
{
get;
}
public abstract void Handle(object sender, Packet packet);
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 6da38694044dff944af5213c4cb2d413
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,36 @@
namespace TEngine.Runtime
{
public abstract class PacketHeaderBase : IPacketHeader, IMemory
{
public abstract PacketType PacketType
{
get;
}
public int Id
{
get;
set;
}
public int PacketLength
{
get;
set;
}
public bool IsValid
{
get
{
return PacketType != PacketType.Undefined && Id > 0 && PacketLength >= 0;
}
}
public void Clear()
{
Id = 0;
PacketLength = 0;
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 279045bf4ec72144aa03880102a04057
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,20 @@
namespace TEngine
{
public enum PacketType : byte
{
/// <summary>
/// 未定义。
/// </summary>
Undefined = 0,
/// <summary>
/// 客户端发往服务器的包。
/// </summary>
ClientToServer,
/// <summary>
/// 服务器发往客户端的包。
/// </summary>
ServerToClient,
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 71e37d0b444a9f646984e673744d2bcf
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,49 @@
using System.IO;
namespace TEngine.Runtime
{
public class ProtoUtils
{
/// <summary>
/// 序列化 MainPack -> byte[]
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="mainPack"></param>
/// <returns></returns>
public static byte[] Serialize<T>(T mainPack) where T : class
{
try
{
using (var stream = new System.IO.MemoryStream())
{
ProtoBuf.Serializer.Serialize(stream, mainPack);
return stream.ToArray();
}
}
catch (IOException ex)
{
Log.Error($"[Serialize] Error{ex.Message}, {ex.Data["StackTrace"]}");
return null;
}
}
/// <summary>
/// 反序列化
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="buffer"></param>
/// <returns></returns>
public static T DeSerialize<T>(byte[] buffer) where T : class
{
try
{
return ProtoBuf.Serializer.Deserialize(typeof(T), new System.IO.MemoryStream(buffer)) as T;
}
catch (IOException ex)
{
Log.Error(($"[DeSerialize] 错误:{ex.Message}, {ex.Data["StackTrace"]}"));
return null;
}
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 2ab82c8abf14856489102fe60cc78926
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,13 @@
namespace TEngine.Runtime
{
public abstract class SCPacketBase : PacketBase
{
public override PacketType PacketType
{
get
{
return PacketType.ServerToClient;
}
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 9bf44767ac4b0ff43b0c6b86d8d255ec
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

View File

@@ -0,0 +1,13 @@
namespace TEngine.Runtime
{
public sealed class SCPacketHeader : PacketHeaderBase
{
public override PacketType PacketType
{
get
{
return PacketType.ServerToClient;
}
}
}
}

View File

@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 2855018a5b9e3d641a4275143aed88f0
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant: