[Tips] RPCメッセージの送信量・頻度の軽減

目次

概要▲

RPCメッセージに関するパフォーマンス改善方法について

送受信ロジックについて▲

RPCメッセージの送信方式

　MUN 2.2.0 以降の場合、RPCの送信帯域制限以上のRPCメッセージデータについては、次フレームまで送信が保留されます。

RPCメッセージの受信方式

		// シーン内の全てのMonoBehaviourからRPCメソッドを探索してコルーチンを実行する
		//     methodName       - RPCメソッド名
		//     methodArgs       - RPCメソッドパラメータの型
		//     methodParams     - RPCメソッドパラメータの実値
		//     behaviourInScene - シーン内に存在する、すべての MonobitView コンポーネントと同列に存在する MonoBehaviourの派生インスタンス
		public void ReceiveRpcMethod(string methodName, Type[] methodArgs, object[] methodParams, MonobitEngine.MonoBehaviour[] behaviourInScene)
		{
			foreach(MonoBehaviour behaviour in behaviourInScene)
			{
				Type monoType = behaviour.GetType();
				List<MethodInfo> methodList;

				// シーン内の全てのMonoBehaviourから[MunRPC]のアトリビュート付きのメソッドを探索する
				var result = MethodsCache.TryGetValue(monoType, out methodList);
				if (result != true)
				{
					MethodInfo[] methods = monoType.GetMethods(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic);
					foreach (MethodInfo method in methods)
					{
						if (method.IsDefined(typeof(MunRPC), false))
							methodList.Add(method);
					}
					MethodsCache[monoType] = methodList;
				}
				if (methodList == null || methodList.Count == 0)
					continue;

				// メソッド名が同一であるものを抽出する
				var selectInfo = methodList.Where(m => m.Name.Equals(methodName));
				if (selectInfo == null) continue;

				// パラメータが同一であるものを抽出し、コルーチンを実行する
				foreach (MethodInfo info in selectInfo)
				{
					var paramInfo = info.GetParameters();
					if (paramInfo.Length == methodParams.Length && VerifyArgType(paramInfo, methodArgs))
					{
						object retValue = info.Invoke(behaviour, methodParams);
						if (retValue is System.Collections.IEnumerator)
						{
							behaviour.StartCoroutine(retValue as System.Collections.IEnumerator);
						}
					}
				}
			}
		}

Tips(1) : シーン内の情報同期が目的である場合、MonobitView コンポーネントを持つ、
　　　　　 単独の静的シーンオブジェクトでRPCメッセージをやり取りする▲

受信時に呼び出されるメソッド検索対象の「インスタンス」を少なくする

・スコアやタイマーなどの数値計算、およびそのデータ共有
・NPCやアイテムなどの出現管理（スポーン処理）
・チャットの会話文の送受信

【避けるべきこと】
  × １つのシーンに対し、「MonobitView コンポーネントを持つ静的オブジェクト」を２つ以上作る
　× 単独または複数の静的オブジェクトに対し、「MonoBehaviour を継承したクラス（スクリプト）」を２つ以上コンポーネントに持たせる
　× 単独または複数のMonoBehaviourに対し、「RPC 受信メソッド」を２つ以上作る

【推奨されるべきこと】
  〇 １つのシーンに対し、「MonobitView コンポーネントを持つ静的オブジェクト」を１つだけ作る
　〇 単独または複数の静的オブジェクトに対し、「MonoBehaviour を継承したクラス（スクリプト）」を１つだけコンポーネントに持たせる
　〇 単独または複数のMonoBehaviourに対し、「RPC 受信メソッド」を１つだけ作る

【悪い例】 複数の MonoBehaviour を継承したクラスで実装する事例

機能ごとにオブジェクトを分割し、各々で MonobitView コンポーネントを追加し、さらに各々のオブジェクトで
RPC メッセージを別々に呼び出す方法です。

プログラムの可読性や運用性のメリットはあるにしても、MUN のパフォーマンス向上のためにはあまり推奨されるやり方ではありません。
出来ることであれば、このような方法は避けるべきです。

【良い例】 単独の MonoBehaviour を継承したクラスで実装する事例

同一の機能のまま、１つのシーンで１つの静的オブジェクト、１つの MonobitView、１つの MonoBehaviour で
RPCメッセージを送受信する方法です。

プログラム的には冗長になりますが、上記の悪例に比べて、単純比較で３倍のパフォーマンス向上が見込まれます。

【最良例】 単独の MonoBehaviour を継承したクラスで、単独のRPCメソッドで実装する事例

同一の機能のまま、１つのシーンで１つの静的オブジェクト、１つの MonobitView、１つの MonoBehaviour で
さらに１つのRPCメッセージを送受信する方法です。
　　※ 省略していますが、Hierarchy および Inspector は上述の「単独の MonoBehaviour を継承したクラスで実装する事例」と同一です。

プログラム的には複雑になりますが、上記の例よりもさらにパフォーマンス向上が見込まれます。

Tips(2) : ある特定のオブジェクト（prefab）の情報同期が目的である場合、
　　　　　 RPCメッセージを使わず、OnMonobitSerializeView() を使う▲

オブジェクトの位置情報以外のデータ同期について、RPCメッセージによるオーバーヘッドから脱する

・オブジェクト単体のステータス（体力値や攻撃力などの、一般的なキャラステータスデータ）
・キャラクタの特定操作に伴う挙動フラグなど

【避けるべきこと】
  × オブジェクトの特定情報の同期について RPC メソッドを使う

【推奨されるべきこと】
  〇 オブジェクトの特定情報の同期については OnMonobitSerializeView() メソッドを使う