- 规范 UI 设计成为：

- UIForm 负责展示 - Controller 负责控制 - UseCase 负责业务逻辑 - RawData 负责提供原始数据 - Context 负责为 UIForm 提供数据 - 添加和补充一系列 UI 功能
2026-02-16 19:03:09 +08:00
parent d650dd63e7
commit 85b0205c73
251 changed files with 12705 additions and 5220 deletions
@@ -0,0 +1,293 @@
+using CustomEvent;
+using Definition.Enum;
+using GameFramework.Event;
+using UnityGameFramework.Runtime;
+
+namespace UI
+{
+    public class SelectRoleFormController : UIFormControllerBase<SelectRoleFormContext>
+    {
+        private SelectRoleFormUseCase _useCase;
+
+        private SelectRoleFormContext _context;
+
+        private SelectRoleForm _selectRoleForm;
+
+        private int? _selectRoleFormSerialId;
+
+        private bool _pendingRefresh;
+
+        private bool _isBindEvent;
+
+        private void SubscribeEvents()
+        {
+            if (_isBindEvent) return;
+
+            GameEntry.Event.Subscribe(OpenUIFormSuccessEventArgs.EventId, OpenUIFormSuccess);
+            GameEntry.Event.Subscribe(CloseUIFormCompleteEventArgs.EventId, CloseUIFormComplete);
+            GameEntry.Event.Subscribe(MenuSelectRoleReturnEventArgs.EventId, OnMenuSelectRoleReturn);
+            GameEntry.Event.Subscribe(MenuSelectRoleSelectedEventArgs.EventId, OnMenuSelectRoleSelected);
+            GameEntry.Event.Subscribe(MenuSelectRoleConfirmEventArgs.EventId, OnMenuSelectRoleConfirm);
+
+            _isBindEvent = true;
+        }
+
+        private void UnsubscribeEvents()
+        {
+            if (!_isBindEvent) return;
+
+            GameEntry.Event.Unsubscribe(OpenUIFormSuccessEventArgs.EventId, OpenUIFormSuccess);
+            GameEntry.Event.Unsubscribe(CloseUIFormCompleteEventArgs.EventId, CloseUIFormComplete);
+            GameEntry.Event.Unsubscribe(MenuSelectRoleReturnEventArgs.EventId, OnMenuSelectRoleReturn);
+            GameEntry.Event.Unsubscribe(MenuSelectRoleSelectedEventArgs.EventId, OnMenuSelectRoleSelected);
+            GameEntry.Event.Unsubscribe(MenuSelectRoleConfirmEventArgs.EventId, OnMenuSelectRoleConfirm);
+
+            _isBindEvent = false;
+        }
+
+        private static SelectRoleFormContext BuildContext(SelectRoleFormRawData rawData)
+        {
+            if (rawData == null)
+            {
+                return null;
+            }
+
+            int count = rawData.RoleIds?.Length ?? 0;
+            RoleItemContext[] roleItems = new RoleItemContext[count];
+            for (int i = 0; i < count; i++)
+            {
+                string iconName = rawData.RoleIconNames != null && i < rawData.RoleIconNames.Length
+                    ? rawData.RoleIconNames[i]
+                    : null;
+
+                roleItems[i] = new RoleItemContext
+                {
+                    RoleId = rawData.RoleIds[i],
+                    IconName = iconName
+                };
+            }
+
+            RolePropertyAreaContext propertyContext = null;
+            if (rawData.SelectedRoleId >= 0)
+            {
+                propertyContext = new RolePropertyAreaContext
+                {
+                    RoleName = rawData.SelectedRoleName,
+                    InitialPropertyText = rawData.SelectedRoleInitialPropertyText
+                };
+            }
+
+            return new SelectRoleFormContext
+            {
+                RoleItemContexts = roleItems,
+                RolePropertyAreaContext = propertyContext,
+                RoleIds = rawData.RoleIds
+            };
+        }
+
+        #region UI Methods
+
+        protected override int? OpenUIInternal(SelectRoleFormContext context)
+        {
+            if (context == null)
+            {
+                Log.Warning("SelectRoleFormController.OpenUI() context is null.");
+                return null;
+            }
+
+            _context = context;
+
+            if (_selectRoleForm != null && _selectRoleFormSerialId.HasValue &&
+                GameEntry.UI.HasUIForm(_selectRoleFormSerialId.Value))
+            {
+                _selectRoleForm.RefreshUI(_context);
+                return _selectRoleFormSerialId;
+            }
+
+            CloseUI();
+            _pendingRefresh = true;
+            SubscribeEvents();
+            _selectRoleFormSerialId = GameEntry.UI.OpenUIForm(UIFormType.SelectRoleForm, context);
+            return _selectRoleFormSerialId;
+        }
+
+        public override int? OpenUI(object userData = null)
+        {
+            if (userData is SelectRoleFormContext selectRoleFormContext)
+            {
+                return OpenUIInternal(selectRoleFormContext);
+            }
+
+            if (userData != null)
+            {
+                Log.Warning("SelectRoleFormController.OpenUI() userData type is invalid.");
+                return null;
+            }
+
+            SelectRoleFormRawData rawData = _useCase.CreateModel();
+            SelectRoleFormContext context = BuildContext(rawData);
+            return OpenUIInternal(context);
+        }
+
+        public override void CloseUI()
+        {
+            _pendingRefresh = false;
+            UnsubscribeEvents();
+
+            if (_selectRoleFormSerialId.HasValue)
+            {
+                if (GameEntry.UI.HasUIForm(_selectRoleFormSerialId.Value))
+                {
+                    GameEntry.UI.CloseUIForm(_selectRoleFormSerialId.Value);
+                }
+
+                _selectRoleForm = null;
+                _selectRoleFormSerialId = null;
+                return;
+            }
+
+            if (_selectRoleForm != null)
+            {
+                _selectRoleForm.Close();
+                _selectRoleForm = null;
+            }
+        }
+
+        public override void BindUseCase(IUIUseCase useCase)
+        {
+            if (!(useCase is SelectRoleFormUseCase selectRoleUseCase))
+            {
+                Log.Error("SelectRoleUseCase.BindUseCase() useCase is invalid.");
+                return;
+            }
+
+            _useCase = selectRoleUseCase;
+        }
+
+        private void TryRefreshUI()
+        {
+            if (_context == null)
+            {
+                return;
+            }
+
+            if (_selectRoleForm == null)
+            {
+                _pendingRefresh = true;
+                return;
+            }
+
+            _selectRoleForm.RefreshUI(_context);
+            _pendingRefresh = false;
+        }
+
+        #endregion
+
+        #region Service
+
+        public void UpdateShowRole(RolePropertyAreaContext rolePropertyAreaContext)
+        {
+            if (_context != null)
+            {
+                _context.RolePropertyAreaContext = rolePropertyAreaContext;
+            }
+
+            if (_selectRoleForm != null)
+            {
+                _selectRoleForm.UpdateShowRole(rolePropertyAreaContext);
+            }
+        }
+
+        #endregion
+
+        #region Event Handlers
+
+        private void OpenUIFormSuccess(object sender, GameEventArgs e)
+        {
+            if (!(e is OpenUIFormSuccessEventArgs args))
+            {
+                return;
+            }
+
+            if (!_selectRoleFormSerialId.HasValue)
+            {
+                return;
+            }
+
+            if (args.UIForm == null || args.UIForm.SerialId != _selectRoleFormSerialId.Value ||
+                args.UserData != _context)
+            {
+                return;
+            }
+
+            _selectRoleForm = args.UIForm.Logic as SelectRoleForm;
+
+            if (_selectRoleForm == null)
+            {
+                Log.Warning("SelectRoleFormController open success but form logic is invalid.");
+                return;
+            }
+
+            if (_pendingRefresh)
+            {
+                TryRefreshUI();
+            }
+        }
+
+        private void CloseUIFormComplete(object sender, GameEventArgs e)
+        {
+            if (!(e is CloseUIFormCompleteEventArgs args))
+            {
+                return;
+            }
+
+            if (args.SerialId != _selectRoleFormSerialId)
+            {
+                return;
+            }
+
+            _selectRoleForm = null;
+            _selectRoleFormSerialId = null;
+        }
+
+        private void OnMenuSelectRoleReturn(object sender, GameEventArgs e)
+        {
+            if (!(sender is SelectRoleForm) || !(e is MenuSelectRoleReturnEventArgs))
+            {
+                return;
+            }
+
+            CloseUI();
+        }
+
+        private void OnMenuSelectRoleSelected(object sender, GameEventArgs e)
+        {
+            if (!(e is MenuSelectRoleSelectedEventArgs args))
+            {
+                return;
+            }
+
+            SelectRoleFormRawData rawData = _useCase != null ? _useCase.SelectRole(args.RoleId) : null;
+            SelectRoleFormContext context = BuildContext(rawData);
+            if (context == null)
+            {
+                return;
+            }
+
+            _context = context;
+            UpdateShowRole(_context.RolePropertyAreaContext);
+        }
+
+        private void OnMenuSelectRoleConfirm(object sender, GameEventArgs e)
+        {
+            if (!(e is MenuSelectRoleConfirmEventArgs))
+            {
+                return;
+            }
+
+            _useCase.ConfirmSelectedRole();
+        }
+
+        #endregion
+    }
+}
@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: ff46cd6b508b0304a801223cbae79419
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
@@ -0,0 +1,276 @@
+using CustomEvent;
+using Definition.Enum;
+using GameFramework.Event;
+using UnityGameFramework.Runtime;
+
+namespace UI
+{
+    public class StartMenuFormController : UIFormControllerBase<StartMenuFormContext>
+    {
+        private StartMenuFormContext _context;
+
+        private StartMenuForm _startMenuForm;
+
+        private int? _startMenuFormSerialId;
+
+        private bool _pendingRefresh;
+
+        private bool _isBindEvent;
+
+        private void SubscribeEvents()
+        {
+            if (_isBindEvent) return;
+
+            GameEntry.Event.Subscribe(OpenUIFormSuccessEventArgs.EventId, OpenUIFormSuccess);
+            GameEntry.Event.Subscribe(CloseUIFormCompleteEventArgs.EventId, CloseUIFormComplete);
+
+            GameEntry.Event.Subscribe(MenuStartGameEventArgs.EventId, OnMenuStartGameButtonClick);
+            GameEntry.Event.Subscribe(MenuFileButtonClickEventArgs.EventId, OnMenuFileButtonClick);
+            GameEntry.Event.Subscribe(MenuGuideButtonClickEventArgs.EventId, OnMenuGuideButtonClick);
+            GameEntry.Event.Subscribe(MenuSettingButtonClickEventArgs.EventId, OnMenuSettingButtonClick);
+            GameEntry.Event.Subscribe(MenuQuitButtonClickEventArgs.EventId, OnMenuQuitButtonClick);
+            GameEntry.Event.Subscribe(MenuAboutButtonClickEventArgs.EventId, OnMenuAboutButtonClick);
+
+            _isBindEvent = true;
+        }
+
+        private void UnsubscribeEvents()
+        {
+            if (!_isBindEvent) return;
+
+            GameEntry.Event.Unsubscribe(OpenUIFormSuccessEventArgs.EventId, OpenUIFormSuccess);
+            GameEntry.Event.Unsubscribe(CloseUIFormCompleteEventArgs.EventId, CloseUIFormComplete);
+
+            GameEntry.Event.Unsubscribe(MenuStartGameEventArgs.EventId, OnMenuStartGameButtonClick);
+            GameEntry.Event.Unsubscribe(MenuFileButtonClickEventArgs.EventId, OnMenuFileButtonClick);
+            GameEntry.Event.Unsubscribe(MenuGuideButtonClickEventArgs.EventId, OnMenuGuideButtonClick);
+            GameEntry.Event.Unsubscribe(MenuSettingButtonClickEventArgs.EventId, OnMenuSettingButtonClick);
+            GameEntry.Event.Unsubscribe(MenuQuitButtonClickEventArgs.EventId, OnMenuQuitButtonClick);
+            GameEntry.Event.Unsubscribe(MenuAboutButtonClickEventArgs.EventId, OnMenuAboutButtonClick);
+
+            _isBindEvent = false;
+        }
+
+        private static StartMenuFormContext BuildStartMenuFormContext()
+        {
+            return new StartMenuFormContext();
+        }
+        
+        #region UI Methods
+
+        protected override int? OpenUIInternal(StartMenuFormContext context)
+        {
+            if (context == null)
+            {
+                Log.Warning("StartMenuFormController.OpenUI() context is null.");
+                return null;
+            }
+
+            _context = context;
+
+            if (_startMenuForm != null && _startMenuFormSerialId.HasValue &&
+                GameEntry.UI.HasUIForm(_startMenuFormSerialId.Value))
+            {
+                _startMenuForm.RefreshUI(_context);
+                return _startMenuFormSerialId;
+            }
+
+            CloseUI();
+            _pendingRefresh = true;
+            SubscribeEvents();
+            _startMenuFormSerialId = GameEntry.UI.OpenUIForm(UIFormType.StartMenuForm, context);
+            return _startMenuFormSerialId;
+        }
+
+        public override int? OpenUI(object userData = null)
+        {
+            if (userData is StartMenuFormContext context)
+            {
+                return OpenUIInternal(context);
+            }
+
+            if (userData != null)
+            {
+                Log.Warning("StartMenuFormController.OpenUI() userData type is invalid.");
+                return null;
+            }
+
+            return OpenUIInternal(BuildStartMenuFormContext());
+        }
+
+        public int? OpenUI(StartMenuFormContext context)
+        {
+            return OpenUIInternal(context);
+        }
+
+        public override void CloseUI()
+        {
+            _pendingRefresh = false;
+            UnsubscribeEvents();
+
+            if (_startMenuFormSerialId.HasValue)
+            {
+                if (GameEntry.UI.HasUIForm(_startMenuFormSerialId.Value))
+                {
+                    GameEntry.UI.CloseUIForm(_startMenuFormSerialId.Value);
+                }
+
+                _startMenuForm = null;
+                _startMenuFormSerialId = null;
+                return;
+            }
+
+            if (_startMenuForm != null)
+            {
+                _startMenuForm.Close();
+                _startMenuForm = null;
+            }
+        }
+
+        public override void BindUseCase(IUIUseCase useCase)
+        {
+            Log.Info("StartMenuForm doesn't need UseCase");
+        }
+
+        private void TryRefreshUI()
+        {
+            if (_context == null)
+            {
+                return;
+            }
+
+            if (_startMenuForm == null)
+            {
+                _pendingRefresh = true;
+                return;
+            }
+
+            _startMenuForm.RefreshUI(_context);
+            _pendingRefresh = false;
+        }
+
+        #endregion
+
+
+        #region Event Handlers
+
+        private void OpenUIFormSuccess(object sender, GameEventArgs e)
+        {
+            if (!(e is OpenUIFormSuccessEventArgs args))
+            {
+                return;
+            }
+
+            if (!_startMenuFormSerialId.HasValue)
+            {
+                return;
+            }
+
+            if (args.UIForm == null || args.UIForm.SerialId != _startMenuFormSerialId.Value ||
+                args.UserData != _context)
+            {
+                return;
+            }
+
+            _startMenuForm = args.UIForm.Logic as StartMenuForm;
+
+            if (_startMenuForm == null)
+            {
+                Log.Warning("StartMenuFormController open success but form logic is invalid.");
+                return;
+            }
+
+            if (_pendingRefresh)
+            {
+                TryRefreshUI();
+            }
+        }
+
+        private void CloseUIFormComplete(object sender, GameEventArgs e)
+        {
+            if (!(e is CloseUIFormCompleteEventArgs args))
+            {
+                return;
+            }
+
+            if (args.SerialId != _startMenuFormSerialId)
+            {
+                return;
+            }
+
+            _startMenuForm = null;
+            _startMenuFormSerialId = null;
+        }
+
+        private void OnMenuStartGameButtonClick(object sender, GameEventArgs e)
+        {
+            if (!(sender is StartMenuForm) || !(e is MenuStartGameEventArgs))
+            {
+                return;
+            }
+
+            GameEntry.UIRouter.OpenUI(UIFormType.SelectRoleForm);
+        }
+
+        private void OnMenuFileButtonClick(object sender, GameEventArgs e)
+        {
+            if (!(sender is StartMenuForm) || !(e is MenuFileButtonClickEventArgs))
+            {
+                return;
+            }
+
+            Log.Warning("Menu file button click is not implemented.");
+        }
+
+        private void OnMenuGuideButtonClick(object sender, GameEventArgs e)
+        {
+            if (!(sender is StartMenuForm) || !(e is MenuGuideButtonClickEventArgs))
+            {
+                return;
+            }
+
+            Log.Warning("Menu guide button click is not implemented.");
+        }
+
+        private void OnMenuSettingButtonClick(object sender, GameEventArgs e)
+        {
+            if (!(sender is StartMenuForm) || !(e is MenuSettingButtonClickEventArgs))
+            {
+                return;
+            }
+
+            GameEntry.UIRouter.OpenUI(UIFormType.SettingForm);
+        }
+
+        private void OnMenuQuitButtonClick(object sender, GameEventArgs e)
+        {
+            if (!(sender is StartMenuForm) || !(e is MenuQuitButtonClickEventArgs))
+            {
+                return;
+            }
+
+            GameEntry.UIRouter.OpenUI(UIFormType.DialogForm, new DialogFormRawData
+            {
+                Mode = 2,
+                Title = GameEntry.Localization.GetString("AskQuitGame.Title"),
+                Message = GameEntry.Localization.GetString("AskQuitGame.Message"),
+                OnClickConfirm = delegate(object userData)
+                {
+                    UnityGameFramework.Runtime.GameEntry.Shutdown(ShutdownType.Quit);
+                }
+            });
+        }
+
+        private void OnMenuAboutButtonClick(object sender, GameEventArgs e)
+        {
+            if (!(sender is StartMenuForm) || !(e is MenuAboutButtonClickEventArgs))
+            {
+                return;
+            }
+
+            Log.Warning("Menu about button click is not implemented.");
+        }
+
+        #endregion
+    }
+}
@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 3feee66cf220f6f47b147bca4f7967f4
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: