InitializationOperation.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504
  1. using System.Collections;
  2. using System.Collections.Generic;
  3. using System.IO;
  4. using UnityEngine;
  5. namespace YooAsset
  6. {
  7. /// <summary>
  8. /// 初始化操作
  9. /// </summary>
  10. public abstract class InitializationOperation : AsyncOperationBase
  11. {
  12. public string PackageVersion { protected set; get; }
  13. }
  14. /// <summary>
  15. /// 编辑器下模拟模式的初始化操作
  16. /// </summary>
  17. internal sealed class EditorSimulateModeInitializationOperation : InitializationOperation
  18. {
  19. private enum ESteps
  20. {
  21. None,
  22. LoadEditorManifest,
  23. Done,
  24. }
  25. private readonly EditorSimulateModeImpl _impl;
  26. private readonly string _simulateManifestFilePath;
  27. private LoadEditorManifestOperation _loadEditorManifestOp;
  28. private ESteps _steps = ESteps.None;
  29. internal EditorSimulateModeInitializationOperation(EditorSimulateModeImpl impl, string simulateManifestFilePath)
  30. {
  31. _impl = impl;
  32. _simulateManifestFilePath = simulateManifestFilePath;
  33. }
  34. internal override void InternalOnStart()
  35. {
  36. _steps = ESteps.LoadEditorManifest;
  37. }
  38. internal override void InternalOnUpdate()
  39. {
  40. if (_steps == ESteps.LoadEditorManifest)
  41. {
  42. if (_loadEditorManifestOp == null)
  43. {
  44. _loadEditorManifestOp = new LoadEditorManifestOperation(_impl.PackageName, _simulateManifestFilePath);
  45. OperationSystem.StartOperation(_impl.PackageName, _loadEditorManifestOp);
  46. }
  47. if (_loadEditorManifestOp.IsDone == false)
  48. return;
  49. if (_loadEditorManifestOp.Status == EOperationStatus.Succeed)
  50. {
  51. PackageVersion = _loadEditorManifestOp.Manifest.PackageVersion;
  52. _impl.ActiveManifest = _loadEditorManifestOp.Manifest;
  53. _steps = ESteps.Done;
  54. Status = EOperationStatus.Succeed;
  55. }
  56. else
  57. {
  58. _steps = ESteps.Done;
  59. Status = EOperationStatus.Failed;
  60. Error = _loadEditorManifestOp.Error;
  61. }
  62. }
  63. }
  64. }
  65. /// <summary>
  66. /// 离线运行模式的初始化操作
  67. /// </summary>
  68. internal sealed class OfflinePlayModeInitializationOperation : InitializationOperation
  69. {
  70. private enum ESteps
  71. {
  72. None,
  73. QueryBuildinPackageVersion,
  74. LoadBuildinManifest,
  75. PackageCaching,
  76. Done,
  77. }
  78. private readonly OfflinePlayModeImpl _impl;
  79. private QueryBuildinPackageVersionOperation _queryBuildinPackageVersionOp;
  80. private LoadBuildinManifestOperation _loadBuildinManifestOp;
  81. private PackageCachingOperation _cachingOperation;
  82. private ESteps _steps = ESteps.None;
  83. internal OfflinePlayModeInitializationOperation(OfflinePlayModeImpl impl)
  84. {
  85. _impl = impl;
  86. }
  87. internal override void InternalOnStart()
  88. {
  89. _steps = ESteps.QueryBuildinPackageVersion;
  90. }
  91. internal override void InternalOnUpdate()
  92. {
  93. if (_steps == ESteps.None || _steps == ESteps.Done)
  94. return;
  95. if (_steps == ESteps.QueryBuildinPackageVersion)
  96. {
  97. if (_queryBuildinPackageVersionOp == null)
  98. {
  99. _queryBuildinPackageVersionOp = new QueryBuildinPackageVersionOperation(_impl.Persistent);
  100. OperationSystem.StartOperation(_impl.PackageName, _queryBuildinPackageVersionOp);
  101. }
  102. if (_queryBuildinPackageVersionOp.IsDone == false)
  103. return;
  104. if (_queryBuildinPackageVersionOp.Status == EOperationStatus.Succeed)
  105. {
  106. _steps = ESteps.LoadBuildinManifest;
  107. }
  108. else
  109. {
  110. _steps = ESteps.Done;
  111. Status = EOperationStatus.Failed;
  112. Error = _queryBuildinPackageVersionOp.Error;
  113. }
  114. }
  115. if (_steps == ESteps.LoadBuildinManifest)
  116. {
  117. if (_loadBuildinManifestOp == null)
  118. {
  119. _loadBuildinManifestOp = new LoadBuildinManifestOperation(_impl.Persistent, _queryBuildinPackageVersionOp.PackageVersion);
  120. OperationSystem.StartOperation(_impl.PackageName, _loadBuildinManifestOp);
  121. }
  122. Progress = _loadBuildinManifestOp.Progress;
  123. if (_loadBuildinManifestOp.IsDone == false)
  124. return;
  125. if (_loadBuildinManifestOp.Status == EOperationStatus.Succeed)
  126. {
  127. PackageVersion = _loadBuildinManifestOp.Manifest.PackageVersion;
  128. _impl.ActiveManifest = _loadBuildinManifestOp.Manifest;
  129. _steps = ESteps.PackageCaching;
  130. }
  131. else
  132. {
  133. _steps = ESteps.Done;
  134. Status = EOperationStatus.Failed;
  135. Error = _loadBuildinManifestOp.Error;
  136. }
  137. }
  138. if (_steps == ESteps.PackageCaching)
  139. {
  140. if (_cachingOperation == null)
  141. {
  142. _cachingOperation = new PackageCachingOperation(_impl.Persistent, _impl.Cache);
  143. OperationSystem.StartOperation(_impl.PackageName, _cachingOperation);
  144. }
  145. Progress = _cachingOperation.Progress;
  146. if (_cachingOperation.IsDone)
  147. {
  148. _steps = ESteps.Done;
  149. Status = EOperationStatus.Succeed;
  150. }
  151. }
  152. }
  153. }
  154. /// <summary>
  155. /// 联机运行模式的初始化操作
  156. /// 注意:优先从沙盒里加载清单,如果沙盒里不存在就尝试把内置清单拷贝到沙盒并加载该清单。
  157. /// </summary>
  158. internal sealed class HostPlayModeInitializationOperation : InitializationOperation
  159. {
  160. private enum ESteps
  161. {
  162. None,
  163. CheckAppFootPrint,
  164. QueryCachePackageVersion,
  165. TryLoadCacheManifest,
  166. QueryBuildinPackageVersion,
  167. UnpackBuildinManifest,
  168. LoadBuildinManifest,
  169. PackageCaching,
  170. Done,
  171. }
  172. private readonly HostPlayModeImpl _impl;
  173. private QueryBuildinPackageVersionOperation _queryBuildinPackageVersionOp;
  174. private QueryCachePackageVersionOperation _queryCachePackageVersionOp;
  175. private UnpackBuildinManifestOperation _unpackBuildinManifestOp;
  176. private LoadBuildinManifestOperation _loadBuildinManifestOp;
  177. private LoadCacheManifestOperation _loadCacheManifestOp;
  178. private PackageCachingOperation _cachingOperation;
  179. private ESteps _steps = ESteps.None;
  180. internal HostPlayModeInitializationOperation(HostPlayModeImpl impl)
  181. {
  182. _impl = impl;
  183. }
  184. internal override void InternalOnStart()
  185. {
  186. _steps = ESteps.CheckAppFootPrint;
  187. }
  188. internal override void InternalOnUpdate()
  189. {
  190. if (_steps == ESteps.None || _steps == ESteps.Done)
  191. return;
  192. if (_steps == ESteps.CheckAppFootPrint)
  193. {
  194. var appFootPrint = new AppFootPrint(_impl.Persistent);
  195. appFootPrint.Load(_impl.PackageName);
  196. // 如果水印发生变化,则说明覆盖安装后首次打开游戏
  197. if (appFootPrint.IsDirty())
  198. {
  199. _impl.Persistent.DeleteSandboxManifestFilesFolder();
  200. appFootPrint.Coverage(_impl.PackageName);
  201. YooLogger.Log("Delete manifest files when application foot print dirty !");
  202. }
  203. _steps = ESteps.QueryCachePackageVersion;
  204. }
  205. if (_steps == ESteps.QueryCachePackageVersion)
  206. {
  207. if (_queryCachePackageVersionOp == null)
  208. {
  209. _queryCachePackageVersionOp = new QueryCachePackageVersionOperation(_impl.Persistent);
  210. OperationSystem.StartOperation(_impl.PackageName, _queryCachePackageVersionOp);
  211. }
  212. if (_queryCachePackageVersionOp.IsDone == false)
  213. return;
  214. if (_queryCachePackageVersionOp.Status == EOperationStatus.Succeed)
  215. {
  216. _steps = ESteps.TryLoadCacheManifest;
  217. }
  218. else
  219. {
  220. _steps = ESteps.QueryBuildinPackageVersion;
  221. }
  222. }
  223. if (_steps == ESteps.TryLoadCacheManifest)
  224. {
  225. if (_loadCacheManifestOp == null)
  226. {
  227. _loadCacheManifestOp = new LoadCacheManifestOperation(_impl.Persistent, _queryCachePackageVersionOp.PackageVersion);
  228. OperationSystem.StartOperation(_impl.PackageName, _loadCacheManifestOp);
  229. }
  230. if (_loadCacheManifestOp.IsDone == false)
  231. return;
  232. if (_loadCacheManifestOp.Status == EOperationStatus.Succeed)
  233. {
  234. PackageVersion = _loadCacheManifestOp.Manifest.PackageVersion;
  235. _impl.ActiveManifest = _loadCacheManifestOp.Manifest;
  236. _steps = ESteps.PackageCaching;
  237. }
  238. else
  239. {
  240. _steps = ESteps.QueryBuildinPackageVersion;
  241. }
  242. }
  243. if (_steps == ESteps.QueryBuildinPackageVersion)
  244. {
  245. if (_queryBuildinPackageVersionOp == null)
  246. {
  247. _queryBuildinPackageVersionOp = new QueryBuildinPackageVersionOperation(_impl.Persistent);
  248. OperationSystem.StartOperation(_impl.PackageName, _queryBuildinPackageVersionOp);
  249. }
  250. if (_queryBuildinPackageVersionOp.IsDone == false)
  251. return;
  252. if (_queryBuildinPackageVersionOp.Status == EOperationStatus.Succeed)
  253. {
  254. _steps = ESteps.UnpackBuildinManifest;
  255. }
  256. else
  257. {
  258. // 注意:为了兼容MOD模式,初始化动态新增的包裹的时候,如果内置清单不存在也不需要报错!
  259. _steps = ESteps.PackageCaching;
  260. string error = _queryBuildinPackageVersionOp.Error;
  261. YooLogger.Log($"Failed to load buildin package version file : {error}");
  262. }
  263. }
  264. if (_steps == ESteps.UnpackBuildinManifest)
  265. {
  266. if (_unpackBuildinManifestOp == null)
  267. {
  268. _unpackBuildinManifestOp = new UnpackBuildinManifestOperation(_impl.Persistent, _queryBuildinPackageVersionOp.PackageVersion);
  269. OperationSystem.StartOperation(_impl.PackageName, _unpackBuildinManifestOp);
  270. }
  271. if (_unpackBuildinManifestOp.IsDone == false)
  272. return;
  273. if (_unpackBuildinManifestOp.Status == EOperationStatus.Succeed)
  274. {
  275. _steps = ESteps.LoadBuildinManifest;
  276. }
  277. else
  278. {
  279. _steps = ESteps.Done;
  280. Status = EOperationStatus.Failed;
  281. Error = _unpackBuildinManifestOp.Error;
  282. }
  283. }
  284. if (_steps == ESteps.LoadBuildinManifest)
  285. {
  286. if (_loadBuildinManifestOp == null)
  287. {
  288. _loadBuildinManifestOp = new LoadBuildinManifestOperation(_impl.Persistent, _queryBuildinPackageVersionOp.PackageVersion);
  289. OperationSystem.StartOperation(_impl.PackageName, _loadBuildinManifestOp);
  290. }
  291. Progress = _loadBuildinManifestOp.Progress;
  292. if (_loadBuildinManifestOp.IsDone == false)
  293. return;
  294. if (_loadBuildinManifestOp.Status == EOperationStatus.Succeed)
  295. {
  296. PackageVersion = _loadBuildinManifestOp.Manifest.PackageVersion;
  297. _impl.ActiveManifest = _loadBuildinManifestOp.Manifest;
  298. _steps = ESteps.PackageCaching;
  299. }
  300. else
  301. {
  302. _steps = ESteps.Done;
  303. Status = EOperationStatus.Failed;
  304. Error = _loadBuildinManifestOp.Error;
  305. }
  306. }
  307. if (_steps == ESteps.PackageCaching)
  308. {
  309. if (_cachingOperation == null)
  310. {
  311. _cachingOperation = new PackageCachingOperation(_impl.Persistent, _impl.Cache);
  312. OperationSystem.StartOperation(_impl.PackageName, _cachingOperation);
  313. }
  314. Progress = _cachingOperation.Progress;
  315. if (_cachingOperation.IsDone)
  316. {
  317. _steps = ESteps.Done;
  318. Status = EOperationStatus.Succeed;
  319. }
  320. }
  321. }
  322. }
  323. /// <summary>
  324. /// WebGL运行模式的初始化操作
  325. /// </summary>
  326. internal sealed class WebPlayModeInitializationOperation : InitializationOperation
  327. {
  328. private enum ESteps
  329. {
  330. None,
  331. QueryWebPackageVersion,
  332. LoadWebManifest,
  333. Done,
  334. }
  335. private readonly WebPlayModeImpl _impl;
  336. private QueryBuildinPackageVersionOperation _queryWebPackageVersionOp;
  337. private LoadBuildinManifestOperation _loadWebManifestOp;
  338. private ESteps _steps = ESteps.None;
  339. internal WebPlayModeInitializationOperation(WebPlayModeImpl impl)
  340. {
  341. _impl = impl;
  342. }
  343. internal override void InternalOnStart()
  344. {
  345. _steps = ESteps.QueryWebPackageVersion;
  346. }
  347. internal override void InternalOnUpdate()
  348. {
  349. if (_steps == ESteps.None || _steps == ESteps.Done)
  350. return;
  351. if (_steps == ESteps.QueryWebPackageVersion)
  352. {
  353. if (_queryWebPackageVersionOp == null)
  354. {
  355. _queryWebPackageVersionOp = new QueryBuildinPackageVersionOperation(_impl.Persistent);
  356. OperationSystem.StartOperation(_impl.PackageName, _queryWebPackageVersionOp);
  357. }
  358. if (_queryWebPackageVersionOp.IsDone == false)
  359. return;
  360. if (_queryWebPackageVersionOp.Status == EOperationStatus.Succeed)
  361. {
  362. _steps = ESteps.LoadWebManifest;
  363. }
  364. else
  365. {
  366. // 注意:WebGL平台可能因为网络的原因会导致请求失败。如果内置清单不存在或者超时也不需要报错!
  367. _steps = ESteps.Done;
  368. Status = EOperationStatus.Succeed;
  369. string error = _queryWebPackageVersionOp.Error;
  370. YooLogger.Log($"Failed to load web package version file : {error}");
  371. }
  372. }
  373. if (_steps == ESteps.LoadWebManifest)
  374. {
  375. if (_loadWebManifestOp == null)
  376. {
  377. _loadWebManifestOp = new LoadBuildinManifestOperation(_impl.Persistent, _queryWebPackageVersionOp.PackageVersion);
  378. OperationSystem.StartOperation(_impl.PackageName, _loadWebManifestOp);
  379. }
  380. Progress = _loadWebManifestOp.Progress;
  381. if (_loadWebManifestOp.IsDone == false)
  382. return;
  383. if (_loadWebManifestOp.Status == EOperationStatus.Succeed)
  384. {
  385. PackageVersion = _loadWebManifestOp.Manifest.PackageVersion;
  386. _impl.ActiveManifest = _loadWebManifestOp.Manifest;
  387. _steps = ESteps.Done;
  388. Status = EOperationStatus.Succeed;
  389. }
  390. else
  391. {
  392. _steps = ESteps.Done;
  393. Status = EOperationStatus.Failed;
  394. Error = _loadWebManifestOp.Error;
  395. }
  396. }
  397. }
  398. }
  399. /// <summary>
  400. /// 应用程序水印
  401. /// </summary>
  402. internal class AppFootPrint
  403. {
  404. private PersistentManager _persistent;
  405. private string _footPrint;
  406. public AppFootPrint(PersistentManager persistent)
  407. {
  408. _persistent = persistent;
  409. }
  410. /// <summary>
  411. /// 读取应用程序水印
  412. /// </summary>
  413. public void Load(string packageName)
  414. {
  415. string footPrintFilePath = _persistent.SandboxAppFootPrintFilePath;
  416. if (File.Exists(footPrintFilePath))
  417. {
  418. _footPrint = FileUtility.ReadAllText(footPrintFilePath);
  419. }
  420. else
  421. {
  422. Coverage(packageName);
  423. }
  424. }
  425. /// <summary>
  426. /// 检测水印是否发生变化
  427. /// </summary>
  428. public bool IsDirty()
  429. {
  430. #if UNITY_EDITOR
  431. return _footPrint != Application.version;
  432. #else
  433. return _footPrint != Application.buildGUID;
  434. #endif
  435. }
  436. /// <summary>
  437. /// 覆盖掉水印
  438. /// </summary>
  439. public void Coverage(string packageName)
  440. {
  441. #if UNITY_EDITOR
  442. _footPrint = Application.version;
  443. #else
  444. _footPrint = Application.buildGUID;
  445. #endif
  446. string footPrintFilePath = _persistent.SandboxAppFootPrintFilePath;
  447. FileUtility.WriteAllText(footPrintFilePath, _footPrint);
  448. YooLogger.Log($"Save application foot print : {_footPrint}");
  449. }
  450. }
  451. }