DownloadComponent.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  1. //------------------------------------------------------------
  2. // Game Framework
  3. // Copyright © 2013-2021 loyalsoft. All rights reserved.
  4. // Homepage: http://www.game7000.com/
  5. // Feedback: http://www.game7000.com/
  6. //------------------------------------------------------------
  7. using GameFramework;
  8. using GameFramework.Download;
  9. using System.Collections.Generic;
  10. using UnityEngine;
  11. namespace UnityGameFramework.Runtime
  12. {
  13. /// <summary>
  14. /// 下载组件。
  15. /// </summary>
  16. [DisallowMultipleComponent]
  17. [AddComponentMenu("Game Framework/Download")]
  18. public sealed class DownloadComponent : GameFrameworkComponent
  19. {
  20. private const int DefaultPriority = 0;
  21. private const int OneMegaBytes = 1024 * 1024;
  22. private IDownloadManager m_DownloadManager = null;
  23. private EventComponent m_EventComponent = null;
  24. [SerializeField]
  25. private Transform m_InstanceRoot = null;
  26. [SerializeField]
  27. private string m_DownloadAgentHelperTypeName = "UnityGameFramework.Runtime.UnityWebRequestDownloadAgentHelper";
  28. [SerializeField]
  29. private DownloadAgentHelperBase m_CustomDownloadAgentHelper = null;
  30. [SerializeField]
  31. private int m_DownloadAgentHelperCount = 3;
  32. [SerializeField]
  33. private float m_Timeout = 30f;
  34. [SerializeField]
  35. private int m_FlushSize = OneMegaBytes;
  36. /// <summary>
  37. /// 获取或设置下载是否被暂停。
  38. /// </summary>
  39. public bool Paused
  40. {
  41. get
  42. {
  43. return m_DownloadManager.Paused;
  44. }
  45. set
  46. {
  47. m_DownloadManager.Paused = value;
  48. }
  49. }
  50. /// <summary>
  51. /// 获取下载代理总数量。
  52. /// </summary>
  53. public int TotalAgentCount
  54. {
  55. get
  56. {
  57. return m_DownloadManager.TotalAgentCount;
  58. }
  59. }
  60. /// <summary>
  61. /// 获取可用下载代理数量。
  62. /// </summary>
  63. public int FreeAgentCount
  64. {
  65. get
  66. {
  67. return m_DownloadManager.FreeAgentCount;
  68. }
  69. }
  70. /// <summary>
  71. /// 获取工作中下载代理数量。
  72. /// </summary>
  73. public int WorkingAgentCount
  74. {
  75. get
  76. {
  77. return m_DownloadManager.WorkingAgentCount;
  78. }
  79. }
  80. /// <summary>
  81. /// 获取等待下载任务数量。
  82. /// </summary>
  83. public int WaitingTaskCount
  84. {
  85. get
  86. {
  87. return m_DownloadManager.WaitingTaskCount;
  88. }
  89. }
  90. /// <summary>
  91. /// 获取或设置下载超时时长,以秒为单位。
  92. /// </summary>
  93. public float Timeout
  94. {
  95. get
  96. {
  97. return m_DownloadManager.Timeout;
  98. }
  99. set
  100. {
  101. m_DownloadManager.Timeout = m_Timeout = value;
  102. }
  103. }
  104. /// <summary>
  105. /// 获取或设置将缓冲区写入磁盘的临界大小,仅当开启断点续传时有效。
  106. /// </summary>
  107. public int FlushSize
  108. {
  109. get
  110. {
  111. return m_DownloadManager.FlushSize;
  112. }
  113. set
  114. {
  115. m_DownloadManager.FlushSize = m_FlushSize = value;
  116. }
  117. }
  118. /// <summary>
  119. /// 获取当前下载速度。
  120. /// </summary>
  121. public float CurrentSpeed
  122. {
  123. get
  124. {
  125. return m_DownloadManager.CurrentSpeed;
  126. }
  127. }
  128. /// <summary>
  129. /// 游戏框架组件初始化。
  130. /// </summary>
  131. protected override void Awake()
  132. {
  133. base.Awake();
  134. m_DownloadManager = GameFrameworkEntry.GetModule<IDownloadManager>();
  135. if (m_DownloadManager == null)
  136. {
  137. Log.Fatal("Download manager is invalid.");
  138. return;
  139. }
  140. m_DownloadManager.DownloadStart += OnDownloadStart;
  141. m_DownloadManager.DownloadUpdate += OnDownloadUpdate;
  142. m_DownloadManager.DownloadSuccess += OnDownloadSuccess;
  143. m_DownloadManager.DownloadFailure += OnDownloadFailure;
  144. m_DownloadManager.FlushSize = m_FlushSize;
  145. m_DownloadManager.Timeout = m_Timeout;
  146. }
  147. private void Start()
  148. {
  149. m_EventComponent = GameEntry.GetComponent<EventComponent>();
  150. if (m_EventComponent == null)
  151. {
  152. Log.Fatal("Event component is invalid.");
  153. return;
  154. }
  155. if (m_InstanceRoot == null)
  156. {
  157. m_InstanceRoot = new GameObject("Download Agent Instances").transform;
  158. m_InstanceRoot.SetParent(gameObject.transform);
  159. m_InstanceRoot.localScale = Vector3.one;
  160. }
  161. for (int i = 0; i < m_DownloadAgentHelperCount; i++)
  162. {
  163. AddDownloadAgentHelper(i);
  164. }
  165. }
  166. /// <summary>
  167. /// 根据下载任务的序列编号获取下载任务的信息。
  168. /// </summary>
  169. /// <param name="serialId">要获取信息的下载任务的序列编号。</param>
  170. /// <returns>下载任务的信息。</returns>
  171. public GameFramework.TaskInfo GetDownloadInfo(int serialId)
  172. {
  173. return m_DownloadManager.GetDownloadInfo(serialId);
  174. }
  175. /// <summary>
  176. /// 根据下载任务的标签获取下载任务的信息。
  177. /// </summary>
  178. /// <param name="tag">要获取信息的下载任务的标签。</param>
  179. /// <returns>下载任务的信息。</returns>
  180. public GameFramework.TaskInfo[] GetDownloadInfos(string tag)
  181. {
  182. return m_DownloadManager.GetDownloadInfos(tag);
  183. }
  184. /// <summary>
  185. /// 根据下载任务的标签获取下载任务的信息。
  186. /// </summary>
  187. /// <param name="tag">要获取信息的下载任务的标签。</param>
  188. /// <param name="results">下载任务的信息。</param>
  189. public void GetDownloadInfos(string tag, List<GameFramework.TaskInfo> results)
  190. {
  191. m_DownloadManager.GetDownloadInfos(tag, results);
  192. }
  193. /// <summary>
  194. /// 获取所有下载任务的信息。
  195. /// </summary>
  196. /// <returns>所有下载任务的信息。</returns>
  197. public GameFramework.TaskInfo[] GetAllDownloadInfos()
  198. {
  199. return m_DownloadManager.GetAllDownloadInfos();
  200. }
  201. /// <summary>
  202. /// 获取所有下载任务的信息。
  203. /// </summary>
  204. /// <param name="results">所有下载任务的信息。</param>
  205. public void GetAllDownloadInfos(List<GameFramework.TaskInfo> results)
  206. {
  207. m_DownloadManager.GetAllDownloadInfos(results);
  208. }
  209. /// <summary>
  210. /// 增加下载任务。
  211. /// </summary>
  212. /// <param name="downloadPath">下载后存放路径。</param>
  213. /// <param name="downloadUri">原始下载地址。</param>
  214. /// <returns>新增下载任务的序列编号。</returns>
  215. public int AddDownload(string downloadPath, string downloadUri)
  216. {
  217. return AddDownload(downloadPath, downloadUri, null, DefaultPriority, null);
  218. }
  219. /// <summary>
  220. /// 增加下载任务。
  221. /// </summary>
  222. /// <param name="downloadPath">下载后存放路径。</param>
  223. /// <param name="downloadUri">原始下载地址。</param>
  224. /// <param name="tag">下载任务的标签。</param>
  225. /// <returns>新增下载任务的序列编号。</returns>
  226. public int AddDownload(string downloadPath, string downloadUri, string tag)
  227. {
  228. return AddDownload(downloadPath, downloadUri, tag, DefaultPriority, null);
  229. }
  230. /// <summary>
  231. /// 增加下载任务。
  232. /// </summary>
  233. /// <param name="downloadPath">下载后存放路径。</param>
  234. /// <param name="downloadUri">原始下载地址。</param>
  235. /// <param name="priority">下载任务的优先级。</param>
  236. /// <returns>新增下载任务的序列编号。</returns>
  237. public int AddDownload(string downloadPath, string downloadUri, int priority)
  238. {
  239. return AddDownload(downloadPath, downloadUri, null, priority, null);
  240. }
  241. /// <summary>
  242. /// 增加下载任务。
  243. /// </summary>
  244. /// <param name="downloadPath">下载后存放路径。</param>
  245. /// <param name="downloadUri">原始下载地址。</param>
  246. /// <param name="userData">用户自定义数据。</param>
  247. /// <returns>新增下载任务的序列编号。</returns>
  248. public int AddDownload(string downloadPath, string downloadUri, object userData)
  249. {
  250. return AddDownload(downloadPath, downloadUri, null, DefaultPriority, userData);
  251. }
  252. /// <summary>
  253. /// 增加下载任务。
  254. /// </summary>
  255. /// <param name="downloadPath">下载后存放路径。</param>
  256. /// <param name="downloadUri">原始下载地址。</param>
  257. /// <param name="tag">下载任务的标签。</param>
  258. /// <param name="priority">下载任务的优先级。</param>
  259. /// <returns>新增下载任务的序列编号。</returns>
  260. public int AddDownload(string downloadPath, string downloadUri, string tag, int priority)
  261. {
  262. return AddDownload(downloadPath, downloadUri, tag, priority, null);
  263. }
  264. /// <summary>
  265. /// 增加下载任务。
  266. /// </summary>
  267. /// <param name="downloadPath">下载后存放路径。</param>
  268. /// <param name="downloadUri">原始下载地址。</param>
  269. /// <param name="tag">下载任务的标签。</param>
  270. /// <param name="userData">用户自定义数据。</param>
  271. /// <returns>新增下载任务的序列编号。</returns>
  272. public int AddDownload(string downloadPath, string downloadUri, string tag, object userData)
  273. {
  274. return AddDownload(downloadPath, downloadUri, tag, DefaultPriority, userData);
  275. }
  276. /// <summary>
  277. /// 增加下载任务。
  278. /// </summary>
  279. /// <param name="downloadPath">下载后存放路径。</param>
  280. /// <param name="downloadUri">原始下载地址。</param>
  281. /// <param name="priority">下载任务的优先级。</param>
  282. /// <param name="userData">用户自定义数据。</param>
  283. /// <returns>新增下载任务的序列编号。</returns>
  284. public int AddDownload(string downloadPath, string downloadUri, int priority, object userData)
  285. {
  286. return AddDownload(downloadPath, downloadUri, null, priority, userData);
  287. }
  288. /// <summary>
  289. /// 增加下载任务。
  290. /// </summary>
  291. /// <param name="downloadPath">下载后存放路径。</param>
  292. /// <param name="downloadUri">原始下载地址。</param>
  293. /// <param name="tag">下载任务的标签。</param>
  294. /// <param name="priority">下载任务的优先级。</param>
  295. /// <param name="userData">用户自定义数据。</param>
  296. /// <returns>新增下载任务的序列编号。</returns>
  297. public int AddDownload(string downloadPath, string downloadUri, string tag, int priority, object userData)
  298. {
  299. return m_DownloadManager.AddDownload(downloadPath, downloadUri, tag, priority, userData);
  300. }
  301. /// <summary>
  302. /// 根据下载任务的序列编号移除下载任务。
  303. /// </summary>
  304. /// <param name="serialId">要移除下载任务的序列编号。</param>
  305. /// <returns>是否移除下载任务成功。</returns>
  306. public bool RemoveDownload(int serialId)
  307. {
  308. return m_DownloadManager.RemoveDownload(serialId);
  309. }
  310. /// <summary>
  311. /// 根据下载任务的标签移除下载任务。
  312. /// </summary>
  313. /// <param name="tag">要移除下载任务的标签。</param>
  314. /// <returns>移除下载任务的数量。</returns>
  315. public int RemoveDownloads(string tag)
  316. {
  317. return m_DownloadManager.RemoveDownloads(tag);
  318. }
  319. /// <summary>
  320. /// 移除所有下载任务。
  321. /// </summary>
  322. /// <returns>移除下载任务的数量。</returns>
  323. public int RemoveAllDownloads()
  324. {
  325. return m_DownloadManager.RemoveAllDownloads();
  326. }
  327. /// <summary>
  328. /// 增加下载代理辅助器。
  329. /// </summary>
  330. /// <param name="index">下载代理辅助器索引。</param>
  331. private void AddDownloadAgentHelper(int index)
  332. {
  333. DownloadAgentHelperBase downloadAgentHelper = Helper.CreateHelper(m_DownloadAgentHelperTypeName, m_CustomDownloadAgentHelper, index);
  334. if (downloadAgentHelper == null)
  335. {
  336. Log.Error("Can not create download agent helper.");
  337. return;
  338. }
  339. downloadAgentHelper.name = Utility.Text.Format("Download Agent Helper - {0}", index.ToString());
  340. Transform transform = downloadAgentHelper.transform;
  341. transform.SetParent(m_InstanceRoot);
  342. transform.localScale = Vector3.one;
  343. m_DownloadManager.AddDownloadAgentHelper(downloadAgentHelper);
  344. }
  345. private void OnDownloadStart(object sender, GameFramework.Download.DownloadStartEventArgs e)
  346. {
  347. m_EventComponent.Fire(this, DownloadStartEventArgs.Create(e));
  348. }
  349. private void OnDownloadUpdate(object sender, GameFramework.Download.DownloadUpdateEventArgs e)
  350. {
  351. m_EventComponent.Fire(this, DownloadUpdateEventArgs.Create(e));
  352. }
  353. private void OnDownloadSuccess(object sender, GameFramework.Download.DownloadSuccessEventArgs e)
  354. {
  355. m_EventComponent.Fire(this, DownloadSuccessEventArgs.Create(e));
  356. }
  357. private void OnDownloadFailure(object sender, GameFramework.Download.DownloadFailureEventArgs e)
  358. {
  359. Log.Warning("Download failure, download serial id '{0}', download path '{1}', download uri '{2}', error message '{3}'.", e.SerialId.ToString(), e.DownloadPath, e.DownloadUri, e.ErrorMessage);
  360. m_EventComponent.Fire(this, DownloadFailureEventArgs.Create(e));
  361. }
  362. }
  363. }