MeowFramework是一套基于QF架构改良的高性能框架,适合追求自定义和轻量级设计的开发者。架构支持模块化和灵活的系统设计,实现了命令/查询处理模式和事件处理模式。
(注:该架构会自动提示更新 如运行后提示更新 请及时前往Github 获取最新版本)
建议使用 C# 8.0 - Unity 2021及以上版本
-
架构模块接口 通常用来统一<模块层>的基接口
-
public interface IBaseModule : IModule { // 这里定义模块接口方法 } public class BaseModule : IBaseModule { public void TryInit() { // 尝试初始化模块,如果已经初始化,则不重复进行 } }
-
架构抽象模块基类 用于拓展模块的初始化规则 提供了初始化和逆初始化的状态变更
-
public class MyModule : AbsModule, IMyModule { // 对于特殊情况 可将 Preload 重写为true 以提前加载该模块 public override bool Preload => true; // 初始化阶段 protected override void OnInit(){} // 销毁阶段 protected override void OnDeInit(){} void IMyModule.Say() => "Say".Log(); void IMyModule.Say(string msg) => msg.Log(); string IMyModule.Get(int id) => id.ToString(); string IMyModule.Msg => "说话呀!"; }
-
架构工具接口 通常用来统一<工具层>的基接口
-
public interface IMyUtility : IUtility { void Use(); } public class MyUtility : IMyUtility { void IMyUtility.Use() => "Use".Log(); }
-
架构可初始化接口 通常用来统一初始化动作
-
// 这里将接口作为模块的子类 外部调用涉及IModule接口时 初始化方法不至于被错误的调用 public interface ICanInit : IModule { bool Preload { get; } void PreInit(IModuleHub hub); void Deinit(); }
-
架构权限接口 通常用来给表现层对象或特殊对象提供架构的访问权限
-
public class FK_Example : MonoBehaviour, IPermissionProvider { IModuleHub IPermissionProvider.Hub => ExampleHub.GetIns(); }
-
架构命令接口 通常用来统一所有<无>参数命令的执行
-
public struct ExampleCmd : ICmd { public void Do(IModuleHub hub) { // 执行命令逻辑 hub 可以在命令中调用架构权限 例如 hub.Module<IMyModule>().Say(); } }
-
架构命令接口 通常用来统一所有<有>参数命令的执行
-
public struct ExampleDataCmd : ICmd<string> { public void Do(IModuleHub hub, string msg) { // 执行命令逻辑 hub 可以在命令中调用架构权限 例如 hub.Module<IMyModule>().Say(msg); } }
-
架构查询接口 通常用来统一所有<无>参数查询的执行
-
public struct ExampleQuery : IQuery<string> { public string Do(IModuleHub hub) { return hub.Module<IMyModule>().Msg; } }
-
架构查询接口 通常用来统一所有<有>参数查询的执行
-
public struct ExampleDataQuery : IQuery<int, string> { public string Do(IModuleHub hub, int num) { return hub.Module<IMyModule>().Get(10); } }
- 框架的核心基类,负责管理框架中的所有模块和工具以及提供所有内嵌功能函数的具体实现
- 获取当前架构的单例对象实例 <懒汉式>。
var ins = ExampleHub.GetIns()
// CheckUpdate() 用于检查更新的函数 <架构会主动调用 不要去动它> 已移动到编辑器
- 定义某些操作仅用于调试
- 用于让子类重写注册模块的顺序和逻辑 <架构会主动调用 不要去动它>
- 框架的核心接口,负责提供架构中所有的对外功能函数。主要方法如下:
- 获取一个已注册的模块实例 通常会在命令或查询等特殊情况使用。
var myModule = hub.Module<MyModule>();
获取一个已注册的工具实例 通常会在命令或查询等特殊情况使用。
var myUtility = hub.Utility<MyUtility>();
public struct MyEvent
{
public string Message;
}
注册一个携带自身类型的事件监听器 注意不要注册到一些不可控的对象中。
hub.AddEvent<MyEvent>(eventHandler);
移除一个携带自身类型的事件监听器 与注册同理 。
hub.RmvEvent<MyEvent>(eventHandler);
触发一个携带自身类型的事件 <外部赋值> 通常会在命令或查询等特殊情况使用。
hub.SendEvent(new MyEvent { Message = "Hello World" });
触发一个携带自身类型的事件 <内部赋值> 通常会在命令或查询等特殊情况使用。
hub.SendEvent<MyEvent>();
public struct MyNotify{}
注册一个仅通知的事件监听器 注意不要注册到一些不可控的对象中。
hub.AddNotify<MyNotify>(notifyHandler);
移除一个仅通知的事件监听器 与注册同理。
hub.RmvNotify<MyNotify>(notifyHandler);
触发一个仅通知的事件 通常会在命令或查询等特殊情况使用。
hub.SendNotify<MyNotify>();
发送一条无参数命令 <外部赋值> 通常会在命令或查询等特殊情况使用。
public struct ExampleCmd : ICmd
{
public void Do(IModuleHub hub)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say();
}
}
hub.SendCmd(new ExampleCmd());
发送一条有参数命令 <外部赋值> 通常会在命令或查询等特殊情况使用。
public struct ExampleDataCmd : ICmd<string>
{
public void Do(IModuleHub hub, string msg)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say(msg);
}
}
hub.SendCmd(new ExampleDataCmd(), "消息");
发送一条无参数命令 <内部赋值> 通常会在命令或查询等特殊情况使用。
public struct ExampleCmd : ICmd
{
public void Do(IModuleHub hub)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say();
}
}
hub.SendCmd<ExampleCmd>();
发送一条有参数命令 <内部赋值> 通常会在命令或查询等特殊情况使用。
public struct ExampleDataCmd : ICmd<string>
{
public void Do(IModuleHub hub, string msg)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say(msg);
}
}
hub.SendCmd<ExampleDataCmd, string>("消息");
发送一条无参数的查询 通常会在命令或查询等特殊情况使用
public struct ExampleQuery : IQuery<string>
{
public string Do(IModuleHub hub)
{
return hub.Module<IMyModule>().Msg;
}
}
var str = hub.Query<ExampleQuery, string>();
发送一条有参数的查询 通常会在命令或查询等特殊情况使用
public struct ExampleDataQuery : IQuery<int, string>
{
public string Do(IModuleHub hub, int num)
{
return hub.Module<IMyModule>().Get(num);
}
}
var str = hub.Query<ExampleDataQuery, int, string>(10);
发送一条无参数且返回自身的查询 通常会在命令或查询等特殊情况使用
public struct ExampleSelfQuery : IQuery<ExampleSelfQuery>
{
public ExampleSelfQuery Do(IModuleHub hub)
{
return this;
}
}
var q = hub.Query<ExampleSelfQuery>();
发送一条有参数且返回自身的查询 通常会在命令或查询等特殊情况使用
public struct ExampleSelfDataQuery : IQuery<int, ExampleSelfDataQuery>
{
public ExampleSelfDataQuery Do(IModuleHub hub, int num)
{
return this;
}
}
var q = hub.Query<ExampleSelfDataQuery, int>(10);
- 架构权限的静态扩展类 用于给 IPermissionProvider 接口 提供静态扩展方法 主要功能如下:
- 获取一个已注册的模块实例 。
var myModule = this.Module<MyModule>();
获取一个已注册的工具实例 。
var myUtility = this.Utility<MyUtility>();
public struct MyEvent
{
public string Message;
}
注册一个携带自身类型的事件监听器 。
this.AddEvent<MyEvent>(eventHandler);
移除一个携带自身类型的事件监听器 记得注销 。
this.RmvEvent<MyEvent>(eventHandler);
触发一个携带自身类型的事件 <外部赋值> 。
this.SendEvent(new MyEvent { Message = "Hello World" });
触发一个携带自身类型的事件 <内部赋值> 。
this.SendEvent<MyEvent>();
public struct MyNotify{}
注册一个仅通知的事件监听器 。
this.AddNotify<MyNotify>(notifyHandler);
移除一个仅通知的事件监听器 。
this.RmvNotify<MyNotify>(notifyHandler);
触发一个仅通知的事件 。
this.SendNotify<MyNotify>();
发送一条无参数命令 <外部赋值> 。
public struct ExampleCmd : ICmd
{
public void Do(IModuleHub hub)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say();
}
}
this.SendCmd(new ExampleCmd());
发送一条有参数命令 <外部赋值> 。
public struct ExampleDataCmd : ICmd<string>
{
public void Do(IModuleHub hub, string msg)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say(msg);
}
}
this.SendCmd(new ExampleDataCmd(), "消息");
发送一条无参数命令 <内部赋值> 。
public struct ExampleCmd : ICmd
{
public void Do(IModuleHub hub)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say();
}
}
this.SendCmd<ExampleCmd>();
发送一条有参数命令 <内部赋值> 。
public struct ExampleDataCmd : ICmd<string>
{
public void Do(IModuleHub hub, string msg)
{
// 执行命令逻辑 hub 可以在命令中调用架构权限 例如
hub.Module<IMyModule>().Say(msg);
}
}
this.SendCmd<ExampleDataCmd, string>("消息");
发送一条无参数的查询
public struct ExampleQuery : IQuery<string>
{
public string Do(IModuleHub hub)
{
return hub.Module<IMyModule>().Msg;
}
}
var str = this.Query<ExampleQuery, string>();
发送一条有参数的查询
public struct ExampleDataQuery : IQuery<int, string>
{
public string Do(IModuleHub hub, int num)
{
return hub.Module<IMyModule>().Get(num);
}
}
var str = this.Query<ExampleDataQuery, int, string>(10);
发送一条无参数且返回自身的查询
public struct ExampleSelfQuery : IQuery<ExampleSelfQuery>
{
public ExampleSelfQuery Do(IModuleHub hub)
{
return this;
}
}
var q = this.Query<ExampleSelfQuery>();
发送一条有参数且返回自身的查询
public struct ExampleSelfDataQuery : IQuery<int, ExampleSelfDataQuery>
{
public ExampleSelfDataQuery Do(IModuleHub hub, int num)
{
return this;
}
}
var q = this.Query<ExampleSelfDataQuery, int>(10);
// 导入拓展后 自动注册场景卸载事件
public abstract partial class ModuleHub<H>
{
protected ModuleHub()
{
SceneManager.sceneUnloaded += op => this.ExecuteSceneUnloadEvent();
MonoKit.GetIns().OnDeInit += Deinit;
}
}
- 获取一个已注册的模块实例 是 Module 的别名 用于在视觉上将模块定义为<数据>。
var myModule = this.GetModel<MyModule>();
- 获取一个已注册的模块实例 是 Module 的别名 用于在视觉上将模块定义为<系统>。
var myModule = this.GetSystem<MyModule>();
- 注册一个由当前场景卸载为注销时机的有参数事件
this.AddEventAndUnregisterOnUnload(MyEvent);
- 注册一个由当前场景卸载为注销时机的无参数事件通知
this.AddNotifyAndUnregisterOnUnload(MyNotify);
ExecuteSceneUnloadEvent< H>
- 手动提前执行所有场景事件和通知
this.ExecuteSceneUnloadEvent();
//一个用于Unity编辑器的基类,它提供了一套框架和界面元素,使得开发者可以通过继承这个类来快速创建具有特定功能的自定义编辑器窗口。子类需要实现一些抽象或虚拟方法来定制窗口的行为和外观
// 提供了一系列的功能按钮,用于快速创建不同类型的Unity脚本或文件,比如创建脚本、创建编辑器、创建Hub类、创建模块、创建架构、创建系统、创建数据模型以及检查更新
//提供了一个方便的方式来在 Unity 编辑器中显示一个带有确认和取消按钮的消息对话框,开发者可以在自己的编辑器扩展中使用这个对话框来提示用户或者收集用户的输入。
// 用于快速创建ScriptableObject资产。它通过一个自定义窗口提供拖放功能,允许开发者直接拖入脚本文件来自动创建对应的ScriptableObject。此外,还提供了设置保存路径和文件名的选项,并通过简单的“Create”按钮完成资产的生成和导入
可以使用架构中带的 MeowEditor 来快速生成模板代码
首先从GitHub中拿到框架后 会拿到一个名字叫 MeowEditor 的编辑器 我们使用在顶部菜单 ”PnTool“中 点击打开 MeowEditor 会弹出一个编辑窗口
弹出编辑器窗口后 按照下图进行设置 文本框中设置的是当前项目的架构名 设置完成 点击创建Hub类 会自动创建一个脚本文件 如下
using UnityEngine;
namespace Panty.Test
{
public class CounterHub : ModuleHub<CounterHub>
{
protected override void BuildModule()
{
// 这里记得注册模块进去
AddModule<ICounterModel>(new CounterModel());
}
}
public class CounterGame : MonoBehaviour, IPermissionProvider
{
IModuleHub IPermissionProvider.Hub => CounterHub.GetIns();
}
public class CounterUI : UIPanel, IPermissionProvider
{
IModuleHub IPermissionProvider.Hub => CounterHub.GetIns();
}
}
也可以通过手动定义来搭建架构环境 样板代码如下:
using UnityEngine;
namespace Panty.Test
{
public class ExampleHub : ModuleHub<ExampleHub>
{
protected override void BuildModule()
{
// 推荐使用 MonoKit 的 OnDeInit事件 来进行销毁
// 1.0.6 版本 如果是Unity 环境 将不再需要下方步骤
MonoKit.GetIns().OnDeInit += Deinit;
}
}
public class ExampleGame : MonoBehaviour, IPermissionProvider
{
IModuleHub IPermissionProvider.Hub => ExampleHub.GetIns();
}
public class ExampleUI : UIPanel, IPermissionProvider
{
IModuleHub IPermissionProvider.Hub => ExampleHub.GetIns();
}
}
using System;
using UnityEngine;
namespace Panty.Test
{
public interface ICounterModel : IModule
{
ValueBinder<float> A { get; }
ValueBinder<float> B { get; }
string GetOpIcon(int id);
string[] GetItems();
}
public class CounterModel : AbsModule, ICounterModel
{
ValueBinder<float> ICounterModel.A { get; } = new ValueBinder<float>();
ValueBinder<float> ICounterModel.B { get; } = new ValueBinder<float>();
private string[] Items;
protected override void OnInit()
{
"第一次调用 该模块 时 执行".Log();
Items = new string[] { "+", "-", "*", "/" };
}
protected override void OnDeInit()
{
"当应用或编辑器退出 时 执行".Log();
}
string ICounterModel.GetOpIcon(int id)
{
return Items[id];
}
string[] ICounterModel.GetItems()
{
return Items;
}
}
public struct ChangeOpCmd : ICmd<int>
{
public void Do(IModuleHub hub, int id)
{
var model = hub.Module<ICounterModel>();
hub.SendEvent(new ChangeOpIconEvent() { icon = model.GetOpIcon(id) });
hub.SendNotify<OperationSuccessfulNotify>();
}
}
public struct RandomValueCmd : ICmd
{
public void Do(IModuleHub hub)
{
var model = hub.Module<ICounterModel>();
model.A.Value = UnityEngine.Random.Range(1, 100);
model.B.Value = UnityEngine.Random.Range(1, 100);
}
}
public struct ResultQuery : IQuery<CounterApp.Op, float>
{
public float Do(IModuleHub hub, CounterApp.Op op)
{
var model = hub.Module<ICounterModel>();
float a = model.A.Value;
float b = model.B.Value;
return op switch
{
CounterApp.Op.Add => a + b,
CounterApp.Op.Sub => a - b,
CounterApp.Op.Mul => a * b,
CounterApp.Op.Div => a / b,
_ => throw new Exception("未识别运算符"),
};
}
}
public struct ChangeOpIconEvent
{
public string icon;
}
public struct OperationSuccessfulNotify { }
public struct OperationFailedNotify { }
public class CounterApp : CounterGame
{
public enum Op : byte
{
Add, Sub, Mul, Div
}
private float startW, startH;
private GUIStyle style, btnStyle, inputStyle;
private string A, B, R;
private string opText = "+";
private int mSelect;
private bool ShowList;
private ICounterModel model;
private void Start()
{
startW = Screen.width >> 1;
startH = Screen.height >> 1;
model = this.Model<ICounterModel>();
model.A.RegisterWithInitValue(OnAChange);
model.B.RegisterWithInitValue(OnBChange);
this.AddEvent<ChangeOpIconEvent>(OnChangeOp);
this.AddNotify<OperationSuccessfulNotify>(OnOperationSuccessful);
this.AddNotify<OperationFailedNotify>(OnOperationFailed);
}
private void OnOperationSuccessful()
{
"操作成功".Log();
}
private void OnOperationFailed()
{
"操作失败".Log();
}
private void OnChangeOp(ChangeOpIconEvent e)
{
opText = e.icon;
}
private void OnDestroy()
{
var model = this.Model<ICounterModel>();
model.A.UnRegister(OnAChange);
model.B.UnRegister(OnBChange);
this.RmvEvent<ChangeOpIconEvent>(OnChangeOp);
this.RmvNotify<OperationSuccessfulNotify>(OnOperationSuccessful);
this.RmvNotify<OperationFailedNotify>(OnOperationFailed);
}
private void OnAChange(float a)
{
A = a.ToString();
}
private void OnBChange(float b)
{
B = b.ToString();
}
private void OnGUI()
{
if (style == null)
{
style = GUI.skin.label;
style.fontSize = 30;
style.alignment = TextAnchor.MiddleCenter;
style.normal.textColor = Color.white;
btnStyle = GUI.skin.button;
btnStyle.fontSize = style.fontSize;
btnStyle.alignment = TextAnchor.MiddleCenter;
inputStyle = GUI.skin.textField;
inputStyle.fontSize = style.fontSize;
inputStyle.alignment = TextAnchor.MiddleCenter;
}
float size = 50f;
var startX = startW - size * 4f;
var rect = new Rect(startX, startH - size, size * 6f, size);
if (GUI.Button(rect, "RandomNum", btnStyle))
{
this.SendCmd<RandomValueCmd>();
}
rect = new Rect(startX, startH, size, size);
string a = GUI.TextField(rect, A, inputStyle);
if (a != A)
{
if (int.TryParse(a, out int r))
{
A = a;
model.A.Value = r;
}
else
{
this.SendNotify<OperationFailedNotify>();
}
}
rect.x += size;
GUI.Label(rect, opText, style);
rect.x += size;
string b = GUI.TextField(rect, B, inputStyle);
if (b != B)
{
if (int.TryParse(b, out int r))
{
B = b;
model.B.Value = r;
}
else
{
this.SendNotify<OperationFailedNotify>();
}
}
rect.x += size;
GUI.Label(rect, "=", style);
rect.x += size;
rect.width = size * 2f;
GUI.Label(rect, R, inputStyle);
rect.y += size;
rect.x = startW - size;
rect.width = size * 3f;
if (GUI.Button(rect, "Calc", btnStyle))
{
var op = (Op)mSelect;
float r = this.Query<ResultQuery, Op, float>(op);
R = op == Op.Div ? r.ToString("F2") : r.ToString();
this.SendNotify<OperationSuccessfulNotify>();
}
rect.x = startX;
if (GUI.Button(rect, "Operator", btnStyle))
{
ShowList = !ShowList;
}
if (ShowList)
{
rect.height = size * 3f;
rect.y += size;
var sel = GUI.SelectionGrid(rect, mSelect, Enum.GetNames(typeof(Op)), 1);
if (mSelect == sel) return;
mSelect = sel;
this.SendCmd<ChangeOpCmd, int>(sel);
ShowList = false;
}
}
}
}
- 1.0.7 (2024-05-19): 统一整体的命名风格 为架构增加详细的注释 将查找所有组件方法移到了架构扩展类中 增加2个事件注册扩展和2个通知注册扩展 将架构版本号集成进架构本体 更新的文件有 ModuleHub、UnityModuleHub、MeowEditor、MonoKit
- 1.0.6 (2024-05-18): 对架构底层和编辑器布局进行一些必要调整 新增了架构的拓展分布类 将检查更新移到了编辑器部分 修复事件系统无法移除key的bug 将MonoKit中的 Log 方法集成到架构中。
- 1.0.5 (2024-05-13): 增加示例单元 增加文档。
- 1.0.4 (2024-05-13): 修复语法错误,增加对 Deinit 的状态变更,避免重复调用。
- 1.0.3 (2024-05-12): 移除反射机制,增加延迟初始化。
- 1.0.2 (2024-05-11): 调整架构生命周期,避免重复初始化。
- 1.0.1 (2024-05-09): 区分有参数和无参数事件API。