Unity-Mirror网络框架从入门到精通之Attributes属性介绍

前言

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

什么是Attributes

在Unity Mirror中，Attributes(属性) 用于给指定的成员函数添加特殊的网络行为，以便它们可以在客户端或服务器上运行。这些属性可以用于Unity游戏循环中的各种方法，如Start或Update，以及其他已实现的方法。注意：在使用抽象或虚方法时，属性也需要应用到重写的方法上。

以下是一些主要的网络属性及其描述：

[Server]

只有服务器才能调用此方法。如果客户端调用此方法，将显示警告。
示例：可以在服务器初始化函数中使用该属性来确保初始化逻辑只在服务器上执行。


[Server]
void InitServer()
{
    // 仅服务器执行初始化逻辑
}

[ServerCallback]

与[Server]类似，但当在客户端调用时不会抛出警告。
示例：适用于需要在服务器上执行的回调函数，而不希望在客户端显示警告。


[ServerCallback]
void OnServerEvent()
{
    // 处理服务器事件
}

[Client]

只有客户端才能调用此方法。如果服务器尝试调用，将显示警告。
示例：用于处理客户端特定的逻辑，例如玩家输入。


[Client]
void HandleInput()
{
    // 处理客户端输入
}

[ClientCallback]

与[Client]类似，但在服务器调用时不会抛出警告。
示例：用于处理客户端需要响应的事件。


[ClientCallback]
void OnClientAction()
{
    // 响应客户端的动作
}

[Command]

从客户端调用此函数以在服务器上执行逻辑。确保验证输入等。无法从服务器调用此功能。
示例：用于玩家命令，例如移动角色。


[Command]
void CmdMove(Vector3 direction)
{
    // 在服务器上执行移动
    transform.Translate(direction);
}

[ClientRpc]

服务器利用远程过程调用（RPC）在所有连接的客户端上运行此函数。
示例：用于在所有客户端上更新游戏状态，例如分数变化。


[ClientRpc]
void RpcUpdateScore(int score)
{
    // 在所有客户端上更新分数
    scoreText.text = "Score: " + score;
}

[TargetRpc]

此属性允许服务器在特定客户端上调用方法，而不是所有连接的客户端。
示例：用于将消息发送到特定玩家。


[TargetRpc]
void TargetSendMessage(NetworkConnection conn, string message)
{
    // 向特定客户端发送消息
    clientMessageText.text = message;
}

[SyncVar]

SyncVars用于从服务器自动同步变量到所有客户端。请不要从客户端赋值，因为这没有意义。使用时确保它们不为null，否则会出现错误。SyncVar支持的类型包括int、long、float、string、Vector3等（所有基本类型），以及具有附加Network Identity的游戏对象。
SyncVar Hooks：当客户端接收到来自服务器的更新时，可以使用SyncVar钩子在客户端运行代码。这允许开发者在变量改变时执行特定的逻辑。

示例：


[SyncVar(hook = "OnHealthChanged")]
public int health;

void OnHealthChanged(int oldHealth, int newHealth)
{
    // 当健康值变化时更新UI
    healthText.text = "Health: " + newHealth;
}