UIManager.ts 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  1. import { instantiate, Node } from 'cc';
  2. import { BUNDLE_ID } from '@scripts/define/ResDefine';
  3. import { getUIViewConfig, UIViewConfig, UIViewID } from '../../define/UIDefine';
  4. import { ResourceManager } from '../resource/ResourceManager';
  5. import { UICachePolicy, UICloseReason, UILayer, UIViewState } from './UILayer';
  6. import { UIView } from './UIView';
  7. import { UIToast } from '@scripts/modules/lobby/ui/UIToast';
  8. import { IDialogConfig, UIDialog } from '@scripts/modules/lobby/ui/UIDialog';
  9. import { AppKernel } from '@scripts/app/AppKernel';
  10. interface UIViewRecord {
  11. config: UIViewConfig;
  12. state: UIViewState;
  13. view: UIView | null;
  14. ownerRoot: Node | null;
  15. generation: number;
  16. opening: Promise<UIView | null> | null;
  17. closing: Promise<boolean> | null;
  18. delayedDestroyTimer: ReturnType<typeof setTimeout> | null;
  19. }
  20. export class UIManager {
  21. private static readonly DELAYED_DESTROY_MS = 5000;
  22. private readonly records = new Map<UIViewID, UIViewRecord>();
  23. private readonly roots = new Map<UILayer, Node>();
  24. private loadingCount = 0;
  25. constructor(private readonly resources: ResourceManager) { }
  26. bindLayer(layer: UILayer, root: Node): void {
  27. this.roots.set(layer, root);
  28. }
  29. /**
  30. * 接管当前场景各 UI Layer 中预放置的 UIView。
  31. * 注册后的 View 先进入缓存态,之后仍由 open/close 统一驱动生命周期。
  32. */
  33. async registerSceneViews(): Promise<void> {
  34. for (const [layer, root] of this.roots) {
  35. if (!root.isValid) continue;
  36. const views = root.getComponentsInChildren(UIView);
  37. for (const view of views) {
  38. const viewId = view.getViewID();
  39. if (!viewId) {
  40. console.warn(`[UIManager] Scene UIView has no viewId: ${view.node.name}`);
  41. continue;
  42. }
  43. const config = getUIViewConfig(viewId);
  44. if (!config) {
  45. console.warn(`[UIManager] Scene UIView is not configured: ${viewId}`);
  46. continue;
  47. }
  48. if (config.layer !== layer) {
  49. console.warn(
  50. `[UIManager] Scene UIView is under the wrong layer: ${viewId}, expected=${config.layer}, actual=${layer}`,
  51. );
  52. continue;
  53. }
  54. const existing = this.records.get(viewId);
  55. if (existing?.view === view) continue;
  56. if (existing?.view?.node?.isValid) {
  57. console.warn(`[UIManager] Duplicate scene UIView ignored: ${viewId}`);
  58. continue;
  59. }
  60. if (existing) this.forgetRecord(existing);
  61. const record: UIViewRecord = {
  62. config,
  63. state: UIViewState.Creating,
  64. view,
  65. ownerRoot: root,
  66. generation: 1,
  67. opening: null,
  68. closing: null,
  69. delayedDestroyTimer: null,
  70. };
  71. this.records.set(viewId, record);
  72. view.node.active = false;
  73. try {
  74. await view.internalCreate();
  75. if (!view.node.isValid || this.records.get(viewId) !== record) {
  76. this.forgetRecord(record);
  77. continue;
  78. }
  79. record.state = UIViewState.Cached;
  80. } catch (error) {
  81. this.forgetRecord(record);
  82. throw error;
  83. }
  84. }
  85. }
  86. }
  87. clearSceneLayers(): void {
  88. const sceneRoots = new Set(this.roots.values());
  89. this.roots.clear();
  90. for (const record of [...this.records.values()]) {
  91. const node = record.view?.node;
  92. const belongsToSceneLayer = node?.isValid
  93. ? [...sceneRoots].some((root) => root.isValid && (node === root || node.isChildOf(root)))
  94. : record.ownerRoot !== null && sceneRoots.has(record.ownerRoot);
  95. if (!node?.isValid || belongsToSceneLayer) {
  96. this.forgetRecord(record);
  97. }
  98. }
  99. }
  100. get<TView extends UIView>(viewId: UIViewID): TView | null {
  101. const record = this.records.get(viewId);
  102. if (
  103. !record
  104. || !record.view?.node?.isValid
  105. || (record.state !== UIViewState.Opening && record.state !== UIViewState.Opened)
  106. ) {
  107. return null;
  108. }
  109. return record.view as TView | null;
  110. }
  111. isOpen(viewId: UIViewID): boolean {
  112. return this.get(viewId) !== null;
  113. }
  114. async open<TView extends UIView, TParams = unknown>(viewId: UIViewID, params?: TParams): Promise<TView | null> {
  115. const config = getUIViewConfig(viewId);
  116. const currentRecord = this.records.get(viewId);
  117. const shouldShowLoading = config.ignoreLoading !== true
  118. && currentRecord?.state !== UIViewState.Opened
  119. && !currentRecord?.opening;
  120. if (!shouldShowLoading) {
  121. return this.openView<TView, TParams>(viewId, params);
  122. }
  123. await this.loading(true, 0.5);
  124. try {
  125. return await this.openView<TView, TParams>(viewId, params);
  126. } finally {
  127. await this.loading(false);
  128. }
  129. }
  130. private async openView<TView extends UIView, TParams = unknown>(
  131. viewId: UIViewID,
  132. params?: TParams,
  133. ): Promise<TView | null> {
  134. let record = this.records.get(viewId);
  135. if (record?.closing) {
  136. await record.closing;
  137. record = this.records.get(viewId);
  138. }
  139. if (record?.view && !record.view.node.isValid) {
  140. this.forgetRecord(record);
  141. record = undefined;
  142. }
  143. if (record?.state === UIViewState.Opened) return record.view as TView;
  144. if (record?.opening) return record.opening as Promise<TView | null>;
  145. if (record) this.cancelDelayedDestroy(record);
  146. if (record?.state === UIViewState.Cached && record.view?.node.isValid) {
  147. const generation = ++record.generation;
  148. const opening = this.performCachedOpen(record, params, generation);
  149. record.opening = opening;
  150. try {
  151. return await opening as TView | null;
  152. } finally {
  153. if (record.opening === opening) record.opening = null;
  154. }
  155. }
  156. const config = getUIViewConfig(viewId);
  157. const root = this.roots.get(config.layer);
  158. if (!root?.isValid) {
  159. console.error(`[UIManager] UILayer is not bound: ${config.layer}`);
  160. return null;
  161. }
  162. record = record ?? {
  163. config,
  164. state: UIViewState.None,
  165. view: null,
  166. ownerRoot: root,
  167. generation: 0,
  168. opening: null,
  169. closing: null,
  170. delayedDestroyTimer: null,
  171. };
  172. record.ownerRoot = root;
  173. this.records.set(viewId, record);
  174. const generation = ++record.generation;
  175. const opening = this.performOpen(record, root, params, generation);
  176. record.opening = opening;
  177. try {
  178. return await opening as TView | null;
  179. } finally {
  180. if (record.opening === opening) record.opening = null;
  181. }
  182. }
  183. async close(viewIdOrInstance: UIViewID, reason = UICloseReason.User): Promise<boolean> {
  184. const record = typeof viewIdOrInstance === 'string'
  185. ? this.records.get(viewIdOrInstance)
  186. : [...this.records.values()].find((item) => item.view === viewIdOrInstance);
  187. if (!record) return false;
  188. if (record.closing) return record.closing;
  189. if (record.state === UIViewState.Cached) {
  190. if (record.opening) {
  191. ++record.generation;
  192. if ((record.config.cache || UICachePolicy.None) === UICachePolicy.Delayed) {
  193. this.scheduleDelayedDestroy(record);
  194. }
  195. }
  196. return true;
  197. }
  198. ++record.generation;
  199. record.closing = this.performClose(record, reason);
  200. try {
  201. return await record.closing;
  202. } finally {
  203. record.closing = null;
  204. }
  205. }
  206. /**
  207. * 关闭全部已登记界面;ignoreViewIds 中的界面会保持当前状态。
  208. */
  209. async closeAll(ignoreViewIds: readonly UIViewID[] = [], reason = UICloseReason.SceneChanged): Promise<void> {
  210. const ignoredViews = new Set(ignoreViewIds);
  211. const handles: Promise<boolean>[] = [];
  212. this.records.forEach(record => {
  213. if (ignoredViews.has(record.config.id)) return;
  214. handles.push(this.close(record.config.id, reason));
  215. })
  216. await Promise.all(handles);
  217. }
  218. private async performOpen(
  219. record: UIViewRecord,
  220. root: Node,
  221. params: unknown,
  222. generation: number,
  223. ): Promise<UIView | null> {
  224. record.state = UIViewState.Loading;
  225. const bundleName = record.config.bundle || BUNDLE_ID.Lobby;
  226. const prefab = await this.resources.loadPrefab(bundleName, record.config.prefabPath);
  227. if (generation !== record.generation) return null;
  228. const prefabView = prefab.data?.getComponent?.(UIView) as UIView | null;
  229. if (!prefabView) {
  230. record.state = UIViewState.None;
  231. console.error(`[UIManager] Prefab has no UIView component: ${record.config.id}`);
  232. return null;
  233. }
  234. record.state = UIViewState.Creating;
  235. const node = instantiate(prefab);
  236. node.active = false;
  237. root.addChild(node);
  238. const view = node.getComponent(UIView);
  239. if (!view) {
  240. node.destroy();
  241. console.error(`[UIManager] Prefab has no UIView component: ${record.config.id}`);
  242. return null;
  243. }
  244. record.view = view;
  245. view.internalCreate();
  246. if (generation !== record.generation || !node.isValid) {
  247. node.destroy();
  248. record.view = null;
  249. return null;
  250. }
  251. let allowOpen: boolean;
  252. try {
  253. allowOpen = await view.internalOpenBefore(params);
  254. } catch (error) {
  255. console.error(error, record.config.id)
  256. node.destroy();
  257. record.view = null;
  258. if (generation === record.generation) record.state = UIViewState.None;
  259. return null;
  260. }
  261. if (generation !== record.generation || !node.isValid) {
  262. node.destroy();
  263. record.view = null;
  264. return null;
  265. }
  266. if (!allowOpen) {
  267. node.destroy();
  268. record.view = null;
  269. record.state = UIViewState.None;
  270. return null;
  271. }
  272. await this.closeMutexViews(record.config);
  273. record.state = UIViewState.Opening;
  274. node.active = true;
  275. await view.internalOpen(params);
  276. if (generation !== record.generation || !node.isValid) return null;
  277. record.state = UIViewState.Opened;
  278. return view;
  279. }
  280. private async performCachedOpen(
  281. record: UIViewRecord,
  282. params: unknown,
  283. generation: number,
  284. ): Promise<UIView | null> {
  285. const view = record.view;
  286. if (!view?.node?.isValid) return null;
  287. let allowOpen: boolean;
  288. try {
  289. allowOpen = await view.internalOpenBefore(params);
  290. } catch (error) {
  291. if (generation === record.generation) this.restoreCachedRecord(record);
  292. throw error;
  293. }
  294. if (generation !== record.generation || !view.node.isValid) return null;
  295. if (!allowOpen) {
  296. this.restoreCachedRecord(record);
  297. return null;
  298. }
  299. await this.closeMutexViews(record.config);
  300. if (generation !== record.generation || !view.node.isValid) return null;
  301. record.state = UIViewState.Opening;
  302. view.node.active = true;
  303. await view.internalOpen(params);
  304. if (generation !== record.generation || !view.node.isValid) return null;
  305. record.state = UIViewState.Opened;
  306. return view;
  307. }
  308. private restoreCachedRecord(record: UIViewRecord): void {
  309. if (!record.view?.node?.isValid || this.records.get(record.config.id) !== record) return;
  310. record.view.node.active = false;
  311. record.state = UIViewState.Cached;
  312. if ((record.config.cache || UICachePolicy.None) === UICachePolicy.Delayed) {
  313. this.scheduleDelayedDestroy(record);
  314. }
  315. }
  316. private async performClose(record: UIViewRecord, reason: UICloseReason): Promise<boolean> {
  317. if (!record.view?.node?.isValid) {
  318. this.cancelDelayedDestroy(record);
  319. record.state = UIViewState.Disposed;
  320. record.view = null;
  321. this.records.delete(record.config.id);
  322. return false;
  323. }
  324. const allow = reason === UICloseReason.ForceDispose
  325. ? true
  326. : await record.view.internalBeforeClose(reason);
  327. if (!allow) return false;
  328. record.state = UIViewState.Closing;
  329. await record.view.internalClose(reason);
  330. const uiCache = record.config.cache || UICachePolicy.None;
  331. if (reason === UICloseReason.ForceDispose || uiCache === UICachePolicy.None) {
  332. this.disposeRecord(record);
  333. return true;
  334. }
  335. record.view.node.active = false;
  336. record.state = UIViewState.Cached;
  337. if (uiCache === UICachePolicy.Delayed) {
  338. this.scheduleDelayedDestroy(record);
  339. }
  340. return true;
  341. }
  342. private scheduleDelayedDestroy(record: UIViewRecord): void {
  343. this.cancelDelayedDestroy(record);
  344. const generation = record.generation;
  345. record.delayedDestroyTimer = setTimeout(() => {
  346. record.delayedDestroyTimer = null;
  347. if (
  348. record.generation === generation
  349. && record.state === UIViewState.Cached
  350. ) {
  351. this.disposeRecord(record);
  352. }
  353. }, UIManager.DELAYED_DESTROY_MS);
  354. }
  355. private cancelDelayedDestroy(record: UIViewRecord): void {
  356. if (record.delayedDestroyTimer === null) return;
  357. clearTimeout(record.delayedDestroyTimer);
  358. record.delayedDestroyTimer = null;
  359. }
  360. private disposeRecord(record: UIViewRecord): void {
  361. this.cancelDelayedDestroy(record);
  362. if (record.view?.node?.isValid) {
  363. record.view.internalDispose();
  364. record.view.node.destroy();
  365. }
  366. record.view = null;
  367. record.ownerRoot = null;
  368. record.state = UIViewState.Disposed;
  369. this.records.delete(record.config.id);
  370. }
  371. /** 从管理器中同步移除记录,不主动销毁正由场景释放的节点。 */
  372. private forgetRecord(record: UIViewRecord): void {
  373. ++record.generation;
  374. this.cancelDelayedDestroy(record);
  375. if (record.view?.node?.isValid) {
  376. record.view.internalDispose();
  377. }
  378. record.view = null;
  379. record.ownerRoot = null;
  380. record.opening = null;
  381. record.closing = null;
  382. record.state = UIViewState.Disposed;
  383. if (this.records.get(record.config.id) === record) {
  384. this.records.delete(record.config.id);
  385. }
  386. }
  387. private async closeMutexViews(config: UIViewConfig): Promise<void> {
  388. const tasks: Promise<boolean>[] = [];
  389. for (const record of this.records.values()) {
  390. if (!record.config.mutexGroup) continue;
  391. if (record.config.id !== config.id && record.config.mutexGroup === config.mutexGroup) {
  392. tasks.push(this.close(record.config.id, UICloseReason.Navigation));
  393. }
  394. }
  395. await Promise.all(tasks);
  396. }
  397. async loading(active: boolean, delay = 0): Promise<void> {
  398. if (active) {
  399. ++this.loadingCount;
  400. try {
  401. await this.open(UIViewID.LoadingView, { delay });
  402. if (this.loadingCount === 0) {
  403. await this.close(UIViewID.LoadingView);
  404. }
  405. } catch (error) {
  406. this.loadingCount = Math.max(0, this.loadingCount - 1);
  407. throw error;
  408. }
  409. return;
  410. }
  411. if (this.loadingCount > 0) --this.loadingCount;
  412. if (this.loadingCount > 0) return;
  413. await this.close(UIViewID.LoadingView);
  414. // close 等待期间可能又有新的加载任务,需重新显示 LoadingView。
  415. if (this.loadingCount > 0) {
  416. await this.open(UIViewID.LoadingView);
  417. }
  418. }
  419. async toast(msg: string) {
  420. let uiToast = this.get<UIToast>(UIViewID.UIToast);
  421. if (!uiToast) {
  422. uiToast = await this.open(UIViewID.UIToast);
  423. }
  424. uiToast.show(msg);
  425. }
  426. async dialog(config: IDialogConfig) {
  427. await AppKernel.ui.open<UIDialog>(UIViewID.UIDialog, config);
  428. }
  429. }