PackageManifest.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  1. using System;
  2. using System.IO;
  3. using System.Diagnostics;
  4. using System.Collections;
  5. using System.Collections.Generic;
  6. namespace YooAsset
  7. {
  8. /// <summary>
  9. /// 清单文件
  10. /// </summary>
  11. [Serializable]
  12. internal class PackageManifest
  13. {
  14. /// <summary>
  15. /// 文件版本
  16. /// </summary>
  17. public string FileVersion;
  18. /// <summary>
  19. /// 启用可寻址资源定位
  20. /// </summary>
  21. public bool EnableAddressable;
  22. /// <summary>
  23. /// 资源定位地址大小写不敏感
  24. /// </summary>
  25. public bool LocationToLower;
  26. /// <summary>
  27. /// 包含资源GUID数据
  28. /// </summary>
  29. public bool IncludeAssetGUID;
  30. /// <summary>
  31. /// 文件名称样式
  32. /// </summary>
  33. public int OutputNameStyle;
  34. /// <summary>
  35. /// 构建资源包类型
  36. /// </summary>
  37. public int BuildBundleType;
  38. /// <summary>
  39. /// 构建管线名称
  40. /// </summary>
  41. public string BuildPipeline;
  42. /// <summary>
  43. /// 资源包裹名称
  44. /// </summary>
  45. public string PackageName;
  46. /// <summary>
  47. /// 资源包裹的版本信息
  48. /// </summary>
  49. public string PackageVersion;
  50. /// <summary>
  51. /// 资源包裹的备注信息
  52. /// </summary>
  53. public string PackageNote;
  54. /// <summary>
  55. /// 资源列表(主动收集的资源列表)
  56. /// </summary>
  57. public List<PackageAsset> AssetList = new List<PackageAsset>();
  58. /// <summary>
  59. /// 资源包列表
  60. /// </summary>
  61. public List<PackageBundle> BundleList = new List<PackageBundle>();
  62. /// <summary>
  63. /// 资源映射集合(提供AssetPath获取PackageAsset)
  64. /// </summary>
  65. [NonSerialized]
  66. public Dictionary<string, PackageAsset> AssetDic;
  67. /// <summary>
  68. /// 资源路径映射集合(提供Location获取AssetPath)
  69. /// </summary>
  70. [NonSerialized]
  71. public Dictionary<string, string> AssetPathMapping1;
  72. /// <summary>
  73. /// 资源路径映射集合(提供AssetGUID获取AssetPath)
  74. /// </summary>
  75. [NonSerialized]
  76. public Dictionary<string, string> AssetPathMapping2;
  77. /// <summary>
  78. /// 资源包集合(提供BundleName获取PackageBundle)
  79. /// </summary>
  80. [NonSerialized]
  81. public Dictionary<string, PackageBundle> BundleDic1;
  82. /// <summary>
  83. /// 资源包集合(提供FileName获取PackageBundle)
  84. /// </summary>
  85. [NonSerialized]
  86. public Dictionary<string, PackageBundle> BundleDic2;
  87. /// <summary>
  88. /// 资源包集合(提供BundleGUID获取PackageBundle)
  89. /// </summary>
  90. [NonSerialized]
  91. public Dictionary<string, PackageBundle> BundleDic3;
  92. /// <summary>
  93. /// 获取包裹的详细信息
  94. /// </summary>
  95. public PackageDetails GetPackageDetails()
  96. {
  97. PackageDetails details = new PackageDetails();
  98. details.FileVersion = FileVersion;
  99. details.EnableAddressable = EnableAddressable;
  100. details.LocationToLower = LocationToLower;
  101. details.IncludeAssetGUID = IncludeAssetGUID;
  102. details.OutputNameStyle = OutputNameStyle;
  103. details.BuildBundleType = BuildBundleType;
  104. details.BuildPipeline = BuildPipeline;
  105. details.PackageName = PackageName;
  106. details.PackageVersion = PackageVersion;
  107. details.PackageNote = PackageNote;
  108. details.AssetTotalCount = AssetList.Count;
  109. details.BundleTotalCount = BundleList.Count;
  110. return details;
  111. }
  112. /// <summary>
  113. /// 尝试映射为资源路径
  114. /// </summary>
  115. public string TryMappingToAssetPath(string location)
  116. {
  117. if (string.IsNullOrEmpty(location))
  118. return string.Empty;
  119. if (LocationToLower)
  120. location = location.ToLower();
  121. if (AssetPathMapping1.TryGetValue(location, out string assetPath))
  122. return assetPath;
  123. else
  124. return string.Empty;
  125. }
  126. /// <summary>
  127. /// 获取主资源包
  128. /// 注意:传入的资源包ID一定合法有效!
  129. /// </summary>
  130. public PackageBundle GetMainPackageBundle(int bundleID)
  131. {
  132. if (bundleID >= 0 && bundleID < BundleList.Count)
  133. {
  134. var packageBundle = BundleList[bundleID];
  135. return packageBundle;
  136. }
  137. else
  138. {
  139. throw new Exception($"Invalid bundle id : {bundleID}");
  140. }
  141. }
  142. /// <summary>
  143. /// 获取主资源包
  144. /// 注意:传入的资源对象一定合法有效!
  145. /// </summary>
  146. public PackageBundle GetMainPackageBundle(PackageAsset packageAsset)
  147. {
  148. return GetMainPackageBundle(packageAsset.BundleID);
  149. }
  150. /// <summary>
  151. /// 获取依赖列表
  152. /// 注意:传入的资源对象一定合法有效!
  153. /// </summary>
  154. public PackageBundle[] GetAllDependencies(PackageAsset packageAsset)
  155. {
  156. List<PackageBundle> result = new List<PackageBundle>(packageAsset.DependBundleIDs.Length);
  157. foreach (var dependID in packageAsset.DependBundleIDs)
  158. {
  159. var dependBundle = GetMainPackageBundle(dependID);
  160. result.Add(dependBundle);
  161. }
  162. return result.ToArray();
  163. }
  164. /// <summary>
  165. /// 获取依赖列表
  166. /// 注意:传入的资源包对象一定合法有效!
  167. /// </summary>
  168. public PackageBundle[] GetAllDependencies(PackageBundle packageBundle)
  169. {
  170. List<PackageBundle> result = new List<PackageBundle>(packageBundle.DependBundleIDs.Length);
  171. foreach (var dependID in packageBundle.DependBundleIDs)
  172. {
  173. var dependBundle = GetMainPackageBundle(dependID);
  174. result.Add(dependBundle);
  175. }
  176. return result.ToArray();
  177. }
  178. /// <summary>
  179. /// 尝试获取包裹的资源
  180. /// </summary>
  181. public bool TryGetPackageAsset(string assetPath, out PackageAsset result)
  182. {
  183. return AssetDic.TryGetValue(assetPath, out result);
  184. }
  185. /// <summary>
  186. /// 尝试获取包裹的资源包
  187. /// </summary>
  188. public bool TryGetPackageBundleByBundleName(string bundleName, out PackageBundle result)
  189. {
  190. return BundleDic1.TryGetValue(bundleName, out result);
  191. }
  192. /// <summary>
  193. /// 尝试获取包裹的资源包
  194. /// </summary>
  195. public bool TryGetPackageBundleByFileName(string fileName, out PackageBundle result)
  196. {
  197. return BundleDic2.TryGetValue(fileName, out result);
  198. }
  199. /// <summary>
  200. /// 尝试获取包裹的资源包
  201. /// </summary>
  202. public bool TryGetPackageBundleByBundleGUID(string bundleGUID, out PackageBundle result)
  203. {
  204. return BundleDic3.TryGetValue(bundleGUID, out result);
  205. }
  206. /// <summary>
  207. /// 是否包含资源文件
  208. /// </summary>
  209. public bool IsIncludeBundleFile(string bundleGUID)
  210. {
  211. return BundleDic3.ContainsKey(bundleGUID);
  212. }
  213. /// <summary>
  214. /// 获取所有的资源信息
  215. /// </summary>
  216. public AssetInfo[] GetAllAssetInfos()
  217. {
  218. List<AssetInfo> result = new List<AssetInfo>(AssetList.Count);
  219. foreach (var packageAsset in AssetList)
  220. {
  221. AssetInfo assetInfo = new AssetInfo(PackageName, packageAsset, null);
  222. result.Add(assetInfo);
  223. }
  224. return result.ToArray();
  225. }
  226. /// <summary>
  227. /// 获取资源信息列表
  228. /// </summary>
  229. public AssetInfo[] GetAssetInfosByTags(string[] tags)
  230. {
  231. List<AssetInfo> result = new List<AssetInfo>(100);
  232. foreach (var packageAsset in AssetList)
  233. {
  234. if (packageAsset.HasTag(tags))
  235. {
  236. AssetInfo assetInfo = new AssetInfo(PackageName, packageAsset, null);
  237. result.Add(assetInfo);
  238. }
  239. }
  240. return result.ToArray();
  241. }
  242. /// <summary>
  243. /// 资源定位地址转换为资源信息。
  244. /// </summary>
  245. /// <returns>如果转换失败会返回一个无效的资源信息类</returns>
  246. public AssetInfo ConvertLocationToAssetInfo(string location, System.Type assetType)
  247. {
  248. DebugCheckLocation(location);
  249. string assetPath = ConvertLocationToAssetInfoMapping(location);
  250. if (TryGetPackageAsset(assetPath, out PackageAsset packageAsset))
  251. {
  252. AssetInfo assetInfo = new AssetInfo(PackageName, packageAsset, assetType);
  253. return assetInfo;
  254. }
  255. else
  256. {
  257. string error;
  258. if (string.IsNullOrEmpty(location))
  259. error = $"The location is null or empty !";
  260. else
  261. error = $"The location is invalid : {location}";
  262. AssetInfo assetInfo = new AssetInfo(PackageName, error);
  263. return assetInfo;
  264. }
  265. }
  266. private string ConvertLocationToAssetInfoMapping(string location)
  267. {
  268. if (string.IsNullOrEmpty(location))
  269. {
  270. YooLogger.Error("Failed to mapping location to asset path, The location is null or empty.");
  271. return string.Empty;
  272. }
  273. if (LocationToLower)
  274. location = location.ToLower();
  275. if (AssetPathMapping1.TryGetValue(location, out string assetPath))
  276. {
  277. return assetPath;
  278. }
  279. else
  280. {
  281. YooLogger.Warning($"Failed to mapping location to asset path : {location}");
  282. return string.Empty;
  283. }
  284. }
  285. /// <summary>
  286. /// 资源GUID转换为资源信息。
  287. /// </summary>
  288. /// <returns>如果转换失败会返回一个无效的资源信息类</returns>
  289. public AssetInfo ConvertAssetGUIDToAssetInfo(string assetGUID, System.Type assetType)
  290. {
  291. if (IncludeAssetGUID == false)
  292. {
  293. YooLogger.Warning("Package manifest not include asset guid ! Please check asset bundle collector settings.");
  294. AssetInfo assetInfo = new AssetInfo(PackageName, "AssetGUID data is empty !");
  295. return assetInfo;
  296. }
  297. string assetPath = ConvertAssetGUIDToAssetInfoMapping(assetGUID);
  298. if (TryGetPackageAsset(assetPath, out PackageAsset packageAsset))
  299. {
  300. AssetInfo assetInfo = new AssetInfo(PackageName, packageAsset, assetType);
  301. return assetInfo;
  302. }
  303. else
  304. {
  305. string error;
  306. if (string.IsNullOrEmpty(assetGUID))
  307. error = $"The assetGUID is null or empty !";
  308. else
  309. error = $"The assetGUID is invalid : {assetGUID}";
  310. AssetInfo assetInfo = new AssetInfo(PackageName, error);
  311. return assetInfo;
  312. }
  313. }
  314. private string ConvertAssetGUIDToAssetInfoMapping(string assetGUID)
  315. {
  316. if (string.IsNullOrEmpty(assetGUID))
  317. {
  318. YooLogger.Error("Failed to mapping assetGUID to asset path, The assetGUID is null or empty.");
  319. return string.Empty;
  320. }
  321. if (AssetPathMapping2.TryGetValue(assetGUID, out string assetPath))
  322. {
  323. return assetPath;
  324. }
  325. else
  326. {
  327. YooLogger.Warning($"Failed to mapping assetGUID to asset path : {assetGUID}");
  328. return string.Empty;
  329. }
  330. }
  331. #region 调试方法
  332. [Conditional("DEBUG")]
  333. private void DebugCheckLocation(string location)
  334. {
  335. if (string.IsNullOrEmpty(location) == false)
  336. {
  337. // 检查路径末尾是否有空格
  338. int index = location.LastIndexOf(' ');
  339. if (index != -1)
  340. {
  341. if (location.Length == index + 1)
  342. YooLogger.Warning($"Found blank character in location : \"{location}\"");
  343. }
  344. if (location.IndexOfAny(System.IO.Path.GetInvalidPathChars()) >= 0)
  345. YooLogger.Warning($"Found illegal character in location : \"{location}\"");
  346. }
  347. }
  348. #endregion
  349. }
  350. }