Unity-Mirror网络框架-从入门到精通之Room示例

前言

在现代游戏开发中，网络功能日益成为提升游戏体验的关键组成部分。Mirror是一个用于Unity的开源网络框架，专为多人游戏开发设计。它使得开发者能够轻松实现网络连接、数据同步和游戏状态管理。本文将深入介绍Mirror的基本概念、如何与其他网络框架进行比较，以及如何从零开始创建一个使用Mirror的简单网络项目。

Room示例

今天我们来讲一下MirrorNetworking网络框架示例中比较有代表意义的Room示例。
它主要讲了如何用Mirror来实现一个房间系统，
为什么要有房间呢？
只要你玩过游戏，你一定只要，当你点击开始游戏后，不是直接进入游戏对战，而是会有一个游戏模式选择，游戏匹配，创建房间，加入房间，好友组队等，然后再进入游戏。
如王者荣耀的匹配房间：

再看示例的房间，如下所示
这是一个房间信息，列表中是房间内的玩家信息
玩家的准备状态

房间匹配

如果所有玩家都准备的情况下，Host端或者Server端，会显示 开始游戏 按钮
点击 开始游戏 按钮，会进入游戏场景

游戏场景

游戏场景中会随机生成一些小道具在场景中，玩家可以通过WASD等按键，操作自己的角色区拾取道具。
一个简单而又功能完善的 带房间的小游戏。

场景设置

我们打开Scenes文件夹，看到这个示例中，共有3个场景
MirrorGameOffLine：离线场景，作为示例的启动场景，连接或者启动服务器后跳转到OnLine场景
MirrorGameOnLine：房间场景，玩家上线后，进入房间，此时属于房间阶段，可以做一些匹配或者选择模式等逻辑。
MirrorGameGame：游戏场景，当所有玩家准备后，服务器点击StartGame，进入Game场景，开始小游戏。

OffLine场景
OffLine场景中，只有一个NetworkRoomManager游戏对象，作为全局的网络管理器。挂在了组件
NetworkRoomManagerExt，继承自NetworkRoomManager。
而NetworkRoomManager又继承自NetworkManager。
所以实际上NetworkManager可以做简单的直连网络小游戏，也可以通过扩展，添加房间，匹配等逻辑，实现更为复杂的带大厅、房间匹配等复杂逻辑的游戏的。

OnLine场景
OnLine场景其实是一个空场景，因为Room示例，使用的是GUI来做的，所以这里直接省略了UI逻辑。
其实就是这个房间信息页面，不过所有的显示逻辑都在RoomPlayer里面写了。

Game场景
这个Game场景，也就设置了一个游戏的场景，一些出生点。

当玩家进入GameScene后，有NetworkRoomManagerExt来处理GamePlayer的创建。

     public virtual void OnServerAddPlayer(NetworkConnectionToClient conn){Transform startPos = GetStartPosition();GameObject player = startPos != null? Instantiate(playerPrefab, startPos.position, startPos.rotation): Instantiate(playerPrefab);// instantiating a "Player" prefab gives it the name "Player(clone)"// => appending the connectionId is WAY more useful for debugging!player.name = $"{playerPrefab.name} [connId={conn.connectionId}]";NetworkServer.AddPlayerForConnection(conn, player);}

其他的游戏逻辑，还是在GamePlayer上面。保罗玩家的运动控制和运动同步，颜色变化等等。

而奖励金币的创建逻辑在Spawner上面。
这里有一个回收和延迟1秒，再创建的逻辑。

        [ServerCallback]internal static void SpawnReward(){Vector3 spawnPosition = new Vector3(Random.Range(-19, 20), 1, Random.Range(-19, 20));NetworkServer.Spawn(Get(spawnPosition, Quaternion.identity));}[ServerCallback]internal static async void RecycleReward(GameObject reward){NetworkServer.UnSpawn(reward);Return(reward);await DelayedSpawn();}static async Task DelayedSpawn(){await Task.Delay(new System.TimeSpan(0, 0, 1));SpawnReward();}

NetworkRoomManager

NetworkRoomManager的话，我来把它简化下，给大家说一下它到底是个什么

namespace Mirror
{[AddComponentMenu("Network/Network Room Manager")]public class NetworkRoomManager : NetworkManager{public int minPlayers = 1;public NetworkRoomPlayer roomPlayerPrefab;public string RoomScene;public string GameplayScene;//房间中的玩家连接列表public HashSet<PendingPlayer> pendingPlayers = new HashSet<PendingPlayer>();//public HashSet<NetworkRoomPlayer> roomSlots = new HashSet<NetworkRoomPlayer>();//internal void CallOnClientEnterRoom()internal void CallOnClientExitRoom()public void CheckReadyToBegin()#region 客户端回调public override void OnStartClient()public override void OnClientConnect()public override void OnClientDisconnect()public override void OnStopClient()public override void OnClientSceneChanged()#endregion#region 房间虚函数，server端public virtual void OnRoomStartHost() {}public virtual void OnRoomStopHost() {}public virtual void OnRoomStartServer() {}public virtual void OnRoomStopServer() {}public virtual void OnRoomServerConnect(NetworkConnectionToClient conn) {}public virtual void OnRoomServerDisconnect(NetworkConnectionToClient conn) {}public virtual void OnRoomServerSceneChanged(string sceneName) {}public virtual void ReadyStatusChanged(){}public virtual void OnRoomServerPlayersReady(){}public virtual void OnRoomServerPlayersNotReady() {}#endregion#region 房间虚函数client端public virtual void OnRoomClientEnter() {}public virtual void OnRoomClientExit() {}public virtual void OnRoomClientConnect() {}public virtual void OnRoomClientDisconnect() {}public virtual void OnRoomStartClient() {}public virtual void OnRoomStopClient() {}public virtual void OnRoomClientSceneChanged() {}#endregion}
}

首先 它又两个HashSet，分别是pendingPlayers和roomSlots，都是存储player引用的，一个是connect引用，一个是roomPlayer组件引用。相当于帮我们封装了一个房间，里面又玩家信息。

然后 我们看到下面有一堆和room相关的虚函数，也就是说在客户端连接服务器后，NetworkRoomManager强行给我们加了一个进入游戏Game的中间层，并新加了一些生命周期的函数，比如OnRoomStartServer，OnRoomStartClient等等。
这些生命周期和父类中的OnStartServer，OnStartClient，其实是一回事。

如下所示：
OnRoomStartClient只不是在OnStartClient时判断了一下roomPlayerPrefab的判空。
其他虚函数也基本类似，就是多了一些判断和修饰，本质上还是NetworkManager。

        public override void OnStartClient(){if (roomPlayerPrefab == null || roomPlayerPrefab.gameObject == null)Debug.LogError("NetworkRoomManager no RoomPlayer prefab is registered. Please add a RoomPlayer prefab.");elseNetworkClient.RegisterPrefab(roomPlayerPrefab.gameObject);if (playerPrefab == null)Debug.LogError("NetworkRoomManager no GamePlayer prefab is registered. Please add a GamePlayer prefab.");OnRoomStartClient();}

所以当我们用到这个NetworkRoomManager做房间管理时，我们在使用生命周期虚函数，就可以在函数中间加上Room，改成OnRoomXXX函数即可。

Spawner

在NetworkRoomManagerExt中的OnRoomServerSceneChange中，有一个判断，如果是Game场景，则开始生成金币道具，
客户端的OnRoomClientSceneChange是客户端的场景切换回调，如果是Game场景，则初始化金币对象池。这样就避免了金币道具的频繁销毁和创建，而是从对象池中获取

    public class NetworkRoomManagerExt : NetworkRoomManager{[Header("Spawner Setup")][Tooltip("Reward Prefab for the Spawner")]public GameObject rewardPrefab;public byte poolSize = 10;public override void OnRoomServerSceneChanged(string sceneName){// spawn the initial batch of Rewardsif (sceneName == GameplayScene){Spawner.InitializePool(rewardPrefab, poolSize);Spawner.InitialSpawn();}elseSpawner.ClearPool();}public override void OnRoomClientSceneChanged(){if (NetworkServer.active) return;if (networkSceneName == GameplayScene)Spawner.InitializePool(rewardPrefab, poolSize);elseSpawner.ClearPool();}}

Spawner的对象池机制
这个NetworkClient.RegisterPrefab机制，是一套创建网络对象的本地创建重载，方便使用对象池，来处理一些大量频繁创建销毁的物体。

        internal static void InitializePool(GameObject poolPrefab, byte count){prefab = poolPrefab;poolSize = count;NetworkClient.RegisterPrefab(prefab, SpawnHandler, UnspawnHandler);pool = new Pool<GameObject>(CreateNew, poolSize);}

Reward

金币奖励道具，着重说一下OnTriggerEnter函数，它已经不是Unity声明周期的OnTriggerEnter函数了，它是经过了网络组件同步的OnTriigerEnter，有服务器来调用，因为客户端调用没有什么意义。
ServerCallback：代表了这个函数只在服务器运行。

        [ServerCallback]void OnTriggerEnter(Collider other){if (!gameObject.activeSelf) return;if (!other.CompareTag("Player")) return;if (!available)return;available = false;uint points = (uint)((randomColor.color.r + randomColor.color.g + randomColor.color.b) / 3);//加分other.GetComponent<PlayerScore>().score += points;//回收对象Spawner.RecycleReward(gameObject);}

RoomPlayer

RoomPlayer是房间中的玩家，它的显示，完全是使用GUI来做的，内部也没有什么逻辑，只有一个准备逻辑，当玩家调用准备函数式，会发送给服务器
[Command]命令，代表客户端调用服务器函数，客户端点了准备按钮后，服务器刷新整体显示。

        [Command]public void CmdChangeReadyState(bool readyState){readyToBegin = readyState;NetworkRoomManager room = NetworkManager.singleton as NetworkRoomManager;if (room != null){room.ReadyStatusChanged();}}

GamePlayer

在Room示例中，GamePlayer有两个实现，分别是GamePlayerReliable和GamePlayerUnreliable
他们有什么区别呢？
我们注意到两个预制体的NetworkTransform组件不一样

它们的主要区别如下：

• 1.可靠性：
  GamePlayerReliable: 这个预制体通常用于需要保证数据传送可靠性的情况。例如，玩家的状态更新、输入指令等关键数据需要确保每个数据包都能成功到达目标客户端，因此适合使用可靠的网络传输方式。这意味着在传输过程中，即使数据包丢失，网络会重发该数据包以确保数据的完整性
  GamePlayerUnreliable: 该预制体则使用不可靠的传输方式，适合对实时性要求更高但可以容忍丢包的情境。例如，物体的位置信息更新可以采用不可靠的方式，因为在快节奏的游戏中，丢失一两个包可能不会对游戏体验造成显著影响。这种方式减少了网络带宽的占用，但对数据传输的完整性没有保证

• 2.性能与延迟：
  GamePlayerReliable: 因需要确认每个数据包的送达，导致在网络不佳的情况下可能出现延迟，影响游戏体验。尤其当网络拥挤时，重复的数据包和确认消息可能会导致更多的延迟
  GamePlayerUnreliable: 更加轻量，适合快速更新和更少的延迟。在高速新的游戏场景中，使用不可靠的传输方式允许更快速的状态更新，使得玩家能够获得更顺畅的体验，尽管会有数据丢失的风险

• 3.使用场景：
  GamePlayerReliable: 适用于需要确保操作准确无误的场景，如玩家首次连接、系统配置、重要游戏状态等需要准确传输的数据
  GamePlayerUnreliable: 更适合于实时的游戏元素交互，如角色的移动和技能释放等，这些更新频繁且不一定需要每次都保证准确传递，允许使用更新丢失而不影响整体游戏进行的情况

我们抛开它们的区别不谈的话，其实GamePlayer就是游戏场景中的，第一人称玩家，他可以控制任务移动，去吃金币，
这里主要说一下NetworkTransform组件，它是用于Unity的游戏对象的Transform的同步的，是最常用的一个同步组件了，因为我们做多人游戏，最重要的是物体的位置，旋转同步。而NetworkTransform就很好的处理的物体的运动平滑和同步。

最后

最后运行起来后呢，就是如下图所示的一个非常简单的吃金币的小游戏了

我们可以通过这个示例，怎么扩展我们的多人游戏呢？
1.是否可以把GUI修改成UGUI呢？（必须可以，而且是必须要做的）
2.是否可以给RoomPlayer扩展一些功能？比如这是名字，选择身份，选择武器等等？
3.是否可以扩展一下GamePlayer，把这个吃金币小游戏，扩展成一个第一人称射击小游戏呢？

如果你想挑战自己，不妨照着做下试试，会有意想不到的收获哦
希望这篇文章对你有所帮助
如果有问题欢迎留言讨论。