Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 3.86 KB

FileCache.md

File metadata and controls

90 lines (70 loc) · 3.86 KB

资源缓存

一、什么情况触发资源缓存

当使用以下API发起网络请求时会检查是否需要缓存

  • UnityWebRequest
  • WWW
  • UnityWebRequestAssetBundle
  • Addressables

游戏业务侧无需关心资源是否有缓存，正常调用API即可，当有缓存时，Loader插件会构造正常响应返回给游戏

二、哪些资源会自动缓存？

  • wasm主包/分包，即wasm.code.unityweb文件
  • 首包资源，即webgl.data.unityweb文件
  • 预加载的文件
  • 请求URL包含于bundlePathIdentifier列表，并且没有添加到excludeFileExtensions列表中的文件
  • 开启纹理缓存后，纹理资源

转换插件相关配置

bundlePathIdentifier: 需要缓存的路径
bundleHashLength: bundle中hash占多少长度
excludeFileExtensions: 不需要缓存的文件类型
needCacheTextures: 是否缓存纹理
texturesPath: 纹理存放路径
texturesHashLength: 纹理中hash长度

三、缓存规则

适用于预加载的文件和URL中包含bundlePathIdentifier的文件

假设有以下配置

1. DATA_CDN: https://weixin.qq.com
2. bundlePathIdentifier: ['StreamingAssets']
3. bundleHashLength: 32

在写入缓存前需要经过三步

  1. 根据URL生成缓存路径 URL剔除掉DATA_CDN部分后作为缓存路径 例如：

那么：

  • 则缓存路径=StreamingAssets/textures_8d265a9dfd6cb7669cdb8b726f0afb1e
  • 资源唯一标识=StreamingAssets/textures
  • 资源版本=8d265a9dfd6cb7669cdb8b726f0afb1e

注意：资源实际部署的CDN前缀必须与转换面板填写的CDN地址一致，否则无法按照前文的缓存规则获得资源的唯一标识。导致缓存失败

  1. 清理掉同名旧文件 通过文件名中的hash区分同名文件的不同版本 继续上面的例子，假如本地已经有StreamingAssets/textures_cdb8b726f0afb1e8d265a9dfd6cb7669 在写入缓存前，插件认为已经本地已经有同名文件StreamingAssets/textures，但hash与本次写入的文件不一致，则需要删除StreamingAssets/textures_cdb8b726f0afb1e8d265a9dfd6cb7669

支持的bundle命名：需以-或_分割，当以其他符号分割时，无法正确处理版本信息，故无法正确删除旧版本资源

  • textures_8d265a9dfd6cb7669cdb8b726f0afb1e
  • textures-8d265a9dfd6cb7669cdb8b726f0afb1e

转换插件相关配置

bundleHashLength: bundle中hash的长度
  1. 检查存储空间是否足够，是否需要清理 当已有缓存+待写入缓存超过允许的上限时，按照LRU清理出所需大小

转换插件相关配置

defaultReleaseSize: 清理时，默认额外清理的大小，单位Bytes，1MB = 1024KB = 1024*1024Bytes
maxStorage: 最大缓存容量，修改此值需要联系研发助手开通权限，否则无效

四、判断是否走缓存

  1. minigame/unity-namespace.js打开详细日志开关enableDebugLog: true查看资源日志是否有读取缓存

五、注意项

  1. 文件名需要带上hash BuildAssetBundleOptions.AppendHashToAssetBundleName，以便清理掉该文件的旧缓存。默认32位长度，可通过导出选项中Bundle名中Hash长度来自定义。比如游戏自己计算了crc，可将Bundle名中Hash长度设置为crc长度。
  2. 配置到不自动缓存文件类型中的文件，不会自动缓存，默认值是json，比如addressable打包后生成StreamingAssets/aa/WebGL/catalog.json，这个文件不会自动缓存。
  3. 开发者工具上可以打开文件系统查看缓存文件

缓存文件在usr目录下

  1. 真机安卓缓存目录：data/com.tencent.mm/MicroMsg/wxanewfiles/随机ID(根据最近使用时间判断是哪个目录)