using GFramework.Core.command;
using GFramework.Core.events;
using GFramework.Core.ioc;
using GFramework.Core.model;
using GFramework.Core.query;
using GFramework.Core.system;
using GFramework.Core.utility;
namespace GFramework.Core.architecture;
///
/// 架构基类,提供系统、模型、工具等组件的注册与管理功能。
/// 使用单例模式确保全局唯一实例,并支持命令、查询和事件机制。
///
/// 派生类类型,用于实现单例
public abstract class Architecture : IArchitecture where T : Architecture, new()
{
#region Fields and Properties
///
/// 控制反转容器,用于存储和获取各种服务(如系统、模型、工具)
///
private readonly IocContainer _mContainer = new();
///
/// 存储尚未初始化的模型集合,在初始化阶段统一调用Init方法
///
private readonly HashSet _mModels = [];
///
/// 存储尚未初始化的系统集合,在初始化阶段统一调用Init方法
///
private readonly HashSet _mSystems = [];
///
/// 存储所有已注册的系统,用于销毁
///
private readonly HashSet _allSystems = [];
///
/// 类型化事件系统,负责事件的发布与订阅管理
///
private readonly TypeEventSystem _mTypeEventSystem = new();
///
/// 标记架构是否已初始化完成
///
private bool _mInited;
///
/// 获取架构实例的静态属性
///
/// 返回IArchitecture类型的架构实例
public static IArchitecture Instance => MArchitectureLazy.Value;
///
/// 生命周期感知对象列表
///
private readonly List _lifecycleHooks = [];
///
/// 当前架构的阶段
///
public ArchitecturePhase CurrentPhase { get; private set; }
///
/// 静态只读字段,用于延迟初始化架构实例
/// 使用Lazy确保线程安全的单例模式实现
///
///
/// 初始化过程包括:
/// 1. 创建T类型的实例
/// 2. 调用用户自定义的Init方法
/// 3. 执行注册的补丁逻辑
/// 4. 初始化所有已注册的模型和系统
/// 5. 清理临时集合并标记初始化完成
///
/// T类型的架构实例
private static readonly Lazy MArchitectureLazy = new(() =>
{
var arch = new T();
// == Architecture Init ==
arch.EnterPhase(ArchitecturePhase.Created);
arch.EnterPhase(ArchitecturePhase.BeforeInit);
// 调用用户实现的初始化
arch.Init();
arch.EnterPhase(ArchitecturePhase.AfterInit);
// == Model Init ==
arch.EnterPhase(ArchitecturePhase.BeforeModelInit);
// 初始化所有已注册但尚未初始化的模型
foreach (var model in arch._mModels) model.Init();
arch._mModels.Clear();
arch.EnterPhase(ArchitecturePhase.AfterModelInit);
// == System Init ==
arch.EnterPhase(ArchitecturePhase.BeforeSystemInit);
// 初始化所有已注册但尚未初始化的系统
foreach (var system in arch._mSystems) system.Init();
arch._mSystems.Clear();
arch.EnterPhase(ArchitecturePhase.AfterSystemInit);
// == Finalize ==
// 冻结IOC容器,不允许 anymore
arch._mContainer.Freeze();
arch._mInited = true;
arch.EnterPhase(ArchitecturePhase.Ready);
// 发送架构生命周期就绪事件
arch.SendEvent(new ArchitectureEvents.ArchitectureLifecycleReadyEvent());
return arch;
}, LazyThreadSafetyMode.ExecutionAndPublication);
#endregion
#region Lifecycle Management
///
/// 进入指定的架构阶段,并执行相应的生命周期管理操作
///
/// 要进入的下一个架构阶段
/// 当阶段转换不被允许时抛出异常
private void EnterPhase(ArchitecturePhase next)
{
// 验证阶段转换是否合法
if (!ArchitectureConstants.PhaseTransitions.TryGetValue(CurrentPhase, out var allowed) ||
!allowed.Contains(next))
{
throw new InvalidOperationException(
$"Invalid phase transition: {CurrentPhase} -> {next}");
}
CurrentPhase = next;
NotifyPhase(next);
// 通知所有架构阶段感知对象阶段变更
foreach (var obj in _mContainer.GetAll())
{
obj.OnArchitecturePhase(next);
}
}
///
/// 通知所有生命周期钩子当前阶段变更
///
/// 当前架构阶段
private void NotifyPhase(ArchitecturePhase phase)
{
foreach (var hook in _lifecycleHooks)
hook.OnPhase(phase, this);
}
///
/// 注册生命周期钩子
///
/// 生命周期钩子实例
public void RegisterLifecycleHook(IArchitectureLifecycle hook)
{
if (CurrentPhase >= ArchitecturePhase.Ready)
throw new InvalidOperationException(
"Cannot register lifecycle hook after architecture is Ready");
_lifecycleHooks.Add(hook);
}
///
/// 抽象初始化方法,由子类重写以进行自定义初始化操作
///
protected abstract void Init();
///
/// 销毁架构并清理所有系统资源
///
///
/// 此函数负责有序地销毁架构中的所有系统组件,并发送相应的生命周期事件。
/// 函数会确保只执行一次销毁操作,避免重复销毁。
///
public virtual void Destroy()
{
// 检查当前阶段,如果已经处于销毁或已销毁状态则直接返回
if (CurrentPhase >= ArchitecturePhase.Destroying)
return;
// 进入销毁阶段并发送销毁开始事件
EnterPhase(ArchitecturePhase.Destroying);
SendEvent(new ArchitectureEvents.ArchitectureDestroyingEvent());
// 销毁所有系统组件并清空系统列表
foreach (var system in _allSystems)
system.Destroy();
_allSystems.Clear();
// 进入已销毁阶段并发送销毁完成事件
EnterPhase(ArchitecturePhase.Destroyed);
SendEvent(new ArchitectureEvents.ArchitectureDestroyedEvent());
}
#endregion
#region Module Management
///
/// 安装架构模块
///
/// 要安装的模块
public void InstallModule(IArchitectureModule module)
{
RegisterLifecycleHook(module);
_mContainer.RegisterPlurality(module);
module.Install(this);
}
#endregion
#region Component Registration
///
/// 注册一个系统到架构中。
/// 若当前未初始化,则暂存至待初始化列表;否则立即初始化该系统。
///
/// 要注册的系统类型
/// 要注册的系统实例
public void RegisterSystem(TSystem system) where TSystem : ISystem
{
if (CurrentPhase >= ArchitecturePhase.Ready)
throw new InvalidOperationException(
$"Cannot register system after Architecture is Ready");
system.SetArchitecture(this);
_mContainer.RegisterPlurality(system);
_allSystems.Add(system);
if (!_mInited)
_mSystems.Add(system);
else
system.Init();
}
///
/// 注册一个模型到架构中。
/// 若当前未初始化,则暂存至待初始化列表;否则立即初始化该模型。
///
/// 要注册的模型类型
/// 要注册的模型实例
public void RegisterModel(TModel model) where TModel : IModel
{
if (CurrentPhase >= ArchitecturePhase.Ready)
throw new InvalidOperationException(
$"Cannot register system after Architecture is Ready");
model.SetArchitecture(this);
_mContainer.RegisterPlurality(model);
if (!_mInited)
_mModels.Add(model);
else
model.Init();
}
///
/// 注册一个工具到架构中。
/// 工具不会被延迟初始化,直接放入IOC容器供后续使用。
///
/// 要注册的工具类型
/// 要注册的工具实例
public void RegisterUtility(TUtility utility) where TUtility : IUtility
{
_mContainer.RegisterPlurality(utility);
}
#endregion
#region Component Retrieval
///
/// 从IOC容器中获取指定类型的系统实例
///
/// 目标系统类型
/// 对应的系统实例
public TSystem? GetSystem() where TSystem : class, ISystem
{
return _mContainer.Get();
}
///
/// 从IOC容器中获取指定类型的模型实例
///
/// 目标模型类型
/// 对应的模型实例
public TModel? GetModel() where TModel : class, IModel
{
return _mContainer.Get();
}
///
/// 从IOC容器中获取指定类型的工具实例
///
/// 目标工具类型
/// 对应的工具实例
public TUtility? GetUtility() where TUtility : class, IUtility
{
return _mContainer.Get();
}
#endregion
#region Command Execution
///
/// 发送一个带返回结果的命令请求
///
/// 命令执行后的返回值类型
/// 要发送的命令对象
/// 命令执行的结果
public TResult SendCommand(ICommand command)
{
return ExecuteCommand(command);
}
///
/// 发送一个无返回结果的命令请求
///
/// 命令的具体类型
/// 要发送的命令对象
public void SendCommand(TCommand command) where TCommand : ICommand
{
ExecuteCommand(command);
}
///
/// 执行一个带返回结果的命令
///
/// 命令执行后的返回值类型
/// 要执行的命令对象
/// 命令执行的结果
protected virtual TResult ExecuteCommand(ICommand command)
{
command.SetArchitecture(this);
return command.Execute();
}
///
/// 执行一个无返回结果的命令
///
/// 要执行的命令对象
protected virtual void ExecuteCommand(ICommand command)
{
command.SetArchitecture(this);
command.Execute();
}
#endregion
#region Query Execution
///
/// 发起一次查询请求并获得其结果
///
/// 查询结果的数据类型
/// 要发起的查询对象
/// 查询得到的结果数据
public TResult SendQuery(IQuery query)
{
return DoQuery(query);
}
///
/// 实际执行查询逻辑的方法
///
/// 查询结果的数据类型
/// 要处理的查询对象
/// 查询结果
protected virtual TResult DoQuery(IQuery query)
{
query.SetArchitecture(this);
return query.Do();
}
#endregion
#region Event Management
///
/// 发布一个默认构造的新事件对象
///
/// 事件类型
public void SendEvent() where TEvent : new()
{
_mTypeEventSystem.Send();
}
///
/// 发布一个具体的事件对象
///
/// 事件类型
/// 要发布的事件实例
public void SendEvent(TEvent e)
{
_mTypeEventSystem.Send(e);
}
///
/// 订阅某个特定类型的事件
///
/// 事件类型
/// 当事件发生时触发的动作
/// 可用于取消订阅的对象
public IUnRegister RegisterEvent(Action onEvent)
{
return _mTypeEventSystem.Register(onEvent);
}
///
/// 取消对某类型事件的监听
///
/// 事件类型
/// 之前绑定的事件处理器
public void UnRegisterEvent(Action onEvent)
{
_mTypeEventSystem.UnRegister(onEvent);
}
#endregion
}