using GFramework.Core.Abstractions.logging;
using GFramework.Core.extensions;
using GFramework.Core.logging;
using GFramework.Core.system;
using GFramework.Game.Abstractions.enums;
using GFramework.Game.Abstractions.ui;
namespace GFramework.Game.ui;
///
/// UI路由类,提供页面栈管理功能
///
public abstract class UiRouterBase : AbstractSystem, IUiRouter
{
private static readonly ILogger Log = LoggerFactoryResolver.Provider.CreateLogger("UiRouterBase");
///
/// UI切换处理器管道
///
private readonly UiTransitionPipeline _pipeline = new();
///
/// 页面栈,用于管理UI页面的显示顺序
///
private readonly Stack _stack = new();
///
/// UI工厂实例,用于创建UI相关的对象
///
private IUiFactory _factory = null!;
private IUiRoot _uiRoot = null!;
///
/// 注册UI切换处理器
///
/// 处理器实例
/// 执行选项
public void RegisterHandler(IUiTransitionHandler handler, UiTransitionHandlerOptions? options = null)
{
_pipeline.RegisterHandler(handler, options);
}
///
/// 注销UI切换处理器
///
/// 处理器实例
public void UnregisterHandler(IUiTransitionHandler handler)
{
_pipeline.UnregisterHandler(handler);
}
///
/// 绑定UI根节点
///
public void BindRoot(IUiRoot root)
{
_uiRoot = root;
Log.Debug("Bind UI Root: {0}", root.GetType().Name);
}
///
/// 将指定UI页面压入栈顶并显示
///
/// UI页面标识符
/// 页面进入参数,可为空
/// 页面切换策略
public void Push(
string uiKey,
IUiPageEnterParam? param = null,
UiTransitionPolicy policy = UiTransitionPolicy.Exclusive
)
{
var @event = CreateEvent(uiKey, UiTransitionType.Push, policy, param);
Log.Debug(
"Push UI Page: key={0}, policy={1}, stackBefore={2}",
uiKey, policy, _stack.Count
);
BeforeChange(@event);
DoPushInternal(uiKey, param, policy);
AfterChange(@event);
}
///
/// 弹出栈顶页面并根据策略处理页面
///
/// 弹出策略,默认为销毁策略
public void Pop(UiPopPolicy policy = UiPopPolicy.Destroy)
{
if (_stack.Count == 0)
{
Log.Debug("Pop ignored: stack is empty");
return;
}
var nextUiKey = _stack.Count > 1
? _stack.ElementAt(1).View.GetType().Name
: string.Empty;
var @event = CreateEvent(nextUiKey, UiTransitionType.Pop);
BeforeChange(@event);
DoPopInternal(policy);
AfterChange(@event);
}
///
/// 替换当前所有页面为新页面
///
/// 新UI页面标识符
/// 页面进入参数,可为空
/// 弹出页面时的销毁策略,默认为销毁
/// 推入页面时的过渡策略,默认为独占
public void Replace(
string uiKey,
IUiPageEnterParam? param = null,
UiPopPolicy popPolicy = UiPopPolicy.Destroy,
UiTransitionPolicy pushPolicy = UiTransitionPolicy.Exclusive
)
{
var @event = CreateEvent(uiKey, UiTransitionType.Replace, pushPolicy, param);
Log.Debug(
"Replace UI Stack with page: key={0}, popPolicy={1}, pushPolicy={2}",
uiKey, popPolicy, pushPolicy
);
BeforeChange(@event);
// 使用内部方法,避免触发额外的Pipeline
DoClearInternal(popPolicy);
DoPushInternal(uiKey, param, pushPolicy);
AfterChange(@event);
}
///
/// 清空所有页面栈中的页面
///
public void Clear()
{
var @event = CreateEvent(string.Empty, UiTransitionType.Clear);
Log.Debug("Clear UI Stack, stackCount={0}", _stack.Count);
BeforeChange(@event);
// 使用内部方法,避免触发额外的Pipeline
DoClearInternal(UiPopPolicy.Destroy);
AfterChange(@event);
}
///
/// 初始化方法,在页面初始化时获取UI工厂实例
///
protected override void OnInit()
{
_factory = this.GetUtility()!;
Log.Debug("UiRouterBase initialized. Factory={0}", _factory.GetType().Name);
RegisterHandlers();
}
///
/// 注册默认的UI切换处理器
///
protected abstract void RegisterHandlers();
///
/// 获取当前栈顶UI的key
///
/// 当前UI key,如果栈为空则返回空字符串
private string GetCurrentUiKey()
{
if (_stack.Count == 0)
return string.Empty;
var page = _stack.Peek();
return page.View.GetType().Name;
}
///
/// 创建UI切换事件
///
private UiTransitionEvent CreateEvent(
string toUiKey,
UiTransitionType type,
UiTransitionPolicy? policy = null,
IUiPageEnterParam? param = null
)
{
return new UiTransitionEvent
{
FromUiKey = GetCurrentUiKey(),
ToUiKey = toUiKey,
TransitionType = type,
Policy = policy ?? UiTransitionPolicy.Exclusive,
EnterParam = param
};
}
///
/// 执行UI切换前的Handler(阻塞)
///
private void BeforeChange(UiTransitionEvent @event)
{
Log.Debug("BeforeChange phases started: {0}", @event.TransitionType);
_pipeline.ExecuteAsync(@event, UITransitionPhases.BeforeChange).GetAwaiter().GetResult();
Log.Debug("BeforeChange phases completed: {0}", @event.TransitionType);
}
///
/// 执行UI切换后的Handler(不阻塞)
///
private void AfterChange(UiTransitionEvent @event)
{
Log.Debug("AfterChange phases started: {0}", @event.TransitionType);
_ = Task.Run(async () =>
{
try
{
await _pipeline.ExecuteAsync(@event, UITransitionPhases.AfterChange).ConfigureAwait(false);
Log.Debug("AfterChange phases completed: {0}", @event.TransitionType);
}
catch (Exception ex)
{
Log.Error("AfterChange phases failed: {0}, Error: {1}", @event.TransitionType, ex.Message);
}
});
}
///
/// 执行Push的核心逻辑(不触发Pipeline)
///
private void DoPushInternal(string uiKey, IUiPageEnterParam? param, UiTransitionPolicy policy)
{
if (_stack.Count > 0)
{
var current = _stack.Peek();
Log.Debug("Pause current page: {0}", current.GetType().Name);
current.OnPause();
if (policy == UiTransitionPolicy.Exclusive)
{
Log.Debug("Hide current page (Exclusive): {0}", current.GetType().Name);
current.OnHide();
}
}
var page = _factory.Create(uiKey);
Log.Debug("Create UI Page instance: {0}", page.GetType().Name);
_uiRoot.AddUiPage(page);
_stack.Push(page);
Log.Debug(
"Enter & Show page: {0}, stackAfter={1}",
page.GetType().Name, _stack.Count
);
page.OnEnter(param);
page.OnShow();
}
///
/// 执行Pop的核心逻辑(不触发Pipeline)
///
private void DoPopInternal(UiPopPolicy policy)
{
if (_stack.Count == 0)
return;
var top = _stack.Pop();
Log.Debug(
"Pop UI Page internal: {0}, policy={1}, stackAfterPop={2}",
top.GetType().Name, policy, _stack.Count
);
top.OnExit();
if (policy == UiPopPolicy.Destroy)
{
Log.Debug("Destroy UI Page: {0}", top.GetType().Name);
_uiRoot.RemoveUiPage(top);
}
else
{
Log.Debug("Hide UI Page: {0}", top.GetType().Name);
top.OnHide();
}
if (_stack.Count > 0)
{
var next = _stack.Peek();
Log.Debug("Resume & Show page: {0}", next.GetType().Name);
next.OnResume();
next.OnShow();
}
else
{
Log.Debug("UI stack is now empty");
}
}
///
/// 执行Clear的核心逻辑(不触发Pipeline)
///
private void DoClearInternal(UiPopPolicy policy)
{
Log.Debug("Clear UI Stack internal, count={0}", _stack.Count);
while (_stack.Count > 0)
DoPopInternal(policy);
}
}