added: unload feature for URLCaching.

Author: sassembla

Assets/Autoya/Backyard/PersistImplementation.cs

@@ -166,6 +166,26 @@ public static void Persist_URLCaching_Load<T>(string domain, string url, Func<by
             autoya.mainthreadDispatcher.Commit(cor);
         }
 
+        public static bool Persist_URLCaching_IsLoaded(string domain, string url)
+        {
+            if (autoya._autoyaURLCache == null)
+            {
+                autoya._autoyaURLCache = new URLCache(autoya._autoyaFilePersistence);
+            }
+
+            return autoya._autoyaURLCache.IsLoaded(domain, url, out var path);
+        }
+
+        public static void Persist_URLCaching_Unload(string domain, string url, bool destroyLoadedObject = false)
+        {
+            if (autoya._autoyaURLCache == null)
+            {
+                autoya._autoyaURLCache = new URLCache(autoya._autoyaFilePersistence);
+            }
+
+            autoya._autoyaURLCache.Unload(domain, url, destroyLoadedObject);
+        }
+
         public static void Persist_URLCaching_Purge(string domain, string url)
         {
             if (autoya._autoyaURLCache == null)

Assets/Autoya/Persistence/URLCaching/URLCaching.cs

@@ -26,31 +26,53 @@ public URLCache(FilePersistence fp)
 
         private Hashtable cachingLock = new Hashtable();
 
-        private Dictionary<string, UnityEngine.Object> pathObjectCache = new Dictionary<string, UnityEngine.Object>();
+        // オンメモリキャッシュ
+        private Dictionary<string, UnityEngine.Object> pathObjectOnMemoryCache = new Dictionary<string, UnityEngine.Object>();
 
-        public void PurgeCache(string storePath, string urlWithoutHash)
+        /*
+            urlに紐づく対象をファイルとオンメモリキャッシュから削除する
+        */
+        public void PurgeCache(string storePath, string urlWithoutHash, bool destroyLoadedObject = false)
         {
             var deleteTargetPath = Path.Combine(storePath, GenerateFolderAndFilePath(urlWithoutHash, string.Empty, storePath).url);
 
             var filePaths = filePersist.FileNamesInDomain(deleteTargetPath);
-            if (filePaths.Any())
+            if (!filePaths.Any())
             {
-                // remove from hard cache.
-                filePersist.DeleteByDomain(deleteTargetPath);
+                return;
+            }
 
-                // remove from on memory cache.
-                var filePath = Path.Combine(deleteTargetPath, Path.GetFileName(filePaths[0]));
-                if (pathObjectCache.ContainsKey(filePath))
+            // remove from hard cache.
+            filePersist.DeleteByDomain(deleteTargetPath);
+
+            // remove from on memory cache.
+            var filePath = Path.Combine(deleteTargetPath, Path.GetFileName(filePaths[0]));
+            if (pathObjectOnMemoryCache.ContainsKey(filePath))
+            {
+                UnityEngine.Object obj = null;
+                if (destroyLoadedObject)
+                {
+                    obj = pathObjectOnMemoryCache[filePath];
+                }
+
+                pathObjectOnMemoryCache.Remove(filePath);
+
+                if (destroyLoadedObject)
                 {
-                    pathObjectCache.Remove(filePath);
+                    GameObject.Destroy(obj);
                 }
             }
         }
 
+        /*
+            ドメイン単位で消す。
+        */
         public void ClearCaching(string storePath)
         {
             filePersist.DeleteByDomain(storePath);
-            pathObjectCache = new Dictionary<string, UnityEngine.Object>();
+
+            // TODO: ドメイン単位で消せると嬉しいが、現在は全部のオンメモリキャッシュを消している。
+            pathObjectOnMemoryCache = new Dictionary<string, UnityEngine.Object>();
         }
 
         private UrlAndHash GenerateFolderAndFilePath(string urlWithoutHash, string hashSource, string storePath)
@@ -94,9 +116,7 @@ public IEnumerator LoadFromURLAs<T>(string storePath, string url, Func<byte[], T
             }
         }
 
-        /*
-            URLから取得したAssetをT型のインスタンスに変形させる手順を提供する。
-        */
+        // 指定したkeyパラメータをurlのqueryパラメータの代わりに使用する = urlで取得したものをkeyパラメータに依存したパスにキャッシュする。
         public IEnumerator LoadFromURLAs<T>(string storePath, string key, string url, Func<byte[], T> bytesToTConverter, Action<T> onLoaded, Action<int, string> onLoadFailed, Dictionary<string, string> requestHeader = null, int timeout = (int)BackyardSettings.HTTP_TIMEOUT_SEC) where T : UnityEngine.Object
         {
             // urlでない場合、urlとして扱うためのパラメータを足す。
@@ -118,6 +138,62 @@ public IEnumerator LoadFromURLAs<T>(string storePath, string key, string url, Fu
             }
         }
 
+        /*
+            メモリにload済であればtrueを返す。
+            loadされていなければfalseを返す。
+        */
+        public bool IsLoaded(string storePath, string url, out string fileUniquePath)
+        {
+            var urlBase = new Uri(url);
+            var pathWithoutHash = urlBase.Authority + urlBase.LocalPath;
+            var hash = Convert.ToBase64String(Encoding.UTF8.GetBytes(urlBase.Query));
+
+            // ファイルパス、ファイル名を生成する
+            var targetFolderNameAndHash = GenerateFolderAndFilePath(pathWithoutHash, hash, storePath);
+            var targetFolderName = targetFolderNameAndHash.url;
+            var targetFileName = targetFolderNameAndHash.url + "_" + targetFolderNameAndHash.hash;
+
+            // フォルダ、ファイルがあるかどうかチェックする
+            var folderPath = Path.Combine(storePath, targetFolderName);
+            var existFolderPaths = filePersist.FileNamesInDomain(folderPath);
+
+            fileUniquePath = Path.Combine(folderPath, targetFileName);
+
+            // オンメモリキャッシュに対象が存在するかどうか
+            if (pathObjectOnMemoryCache.ContainsKey(fileUniquePath))
+            {
+                return true;
+            }
+
+            return false;
+        }
+
+        /*
+            ロード済のオンメモリから削除する。
+        */
+        public void Unload(string storePath, string urlWithoutHash, bool destroyLoadedObject = false)
+        {
+            if (IsLoaded(storePath, urlWithoutHash, out var fileUniquePath))
+            {
+                // remove from on memory cache.
+                UnityEngine.Object obj = null;
+                if (destroyLoadedObject)
+                {
+                    obj = pathObjectOnMemoryCache[fileUniquePath];
+                }
+
+                pathObjectOnMemoryCache.Remove(fileUniquePath);
+
+                if (destroyLoadedObject)
+                {
+                    GameObject.Destroy(obj);
+                }
+            }
+        }
+
+        /*
+            urlに対してキャッシュされるpathを返す
+        */
         public string PathOf(string storePath, string url)
         {
             var urlBase = new Uri(url);
@@ -206,7 +282,6 @@ public IEnumerator ExecuteExpiration(string storePath, int expirationDayCount, i
 
         private IEnumerator Load<T>(string url, string pathWithoutHash, string hash, string storePath, Func<byte[], T> bytesToTConverter, Action<T> onLoaded, Action<int, string> onLoadFailed, Dictionary<string, string> requestHeader = null, double timeout = BackyardSettings.HTTP_TIMEOUT_SEC) where T : UnityEngine.Object
         {
-
             // ファイルパス、ファイル名を生成する
             var targetFolderNameAndHash = GenerateFolderAndFilePath(pathWithoutHash, hash, storePath);
             var targetFolderName = targetFolderNameAndHash.url;
@@ -219,9 +294,9 @@ private IEnumerator Load<T>(string url, string pathWithoutHash, string hash, str
             var fileUniquePath = Path.Combine(folderPath, targetFileName);
 
             // キャッシュに対象が存在するかどうか
-            if (pathObjectCache.ContainsKey(fileUniquePath))
+            if (pathObjectOnMemoryCache.ContainsKey(fileUniquePath))
             {
-                var cached = pathObjectCache[fileUniquePath] as T;
+                var cached = pathObjectOnMemoryCache[fileUniquePath] as T;
                 onLoaded(cached);
                 yield break;
             }
@@ -237,7 +312,7 @@ private IEnumerator Load<T>(string url, string pathWithoutHash, string hash, str
                 // 待機完了、オンメモリのキャッシュにあるかどうかチェックし、あれば返す。なければダウンロードに移行する。
 
                 UnityEngine.Object _object;
-                if (pathObjectCache.TryGetValue(fileUniquePath, out _object))
+                if (pathObjectOnMemoryCache.TryGetValue(fileUniquePath, out _object))
                 {
                     onLoaded(_object as T);
                     yield break;
@@ -268,7 +343,7 @@ private IEnumerator Load<T>(string url, string pathWithoutHash, string hash, str
                         // 読み出し成功したのでオンメモリに載せる。
                         var tObj = bytesToTConverter(bytes);
 
-                        pathObjectCache[fileUniquePath] = tObj;
+                        pathObjectOnMemoryCache[fileUniquePath] = tObj;
                         lock (writeLock)
                         {
                             cachingLock.Remove(targetFolderName);
@@ -364,8 +439,8 @@ private IEnumerator Load<T>(string url, string pathWithoutHash, string hash, str
                     // 型に対しての返還式を取り出し、byteからT型を生成する。
                     var obj = bytesToTConverter(bytes);
 
-                    // キャッシュを行う
-                    pathObjectCache[fileUniquePath] = obj;
+                    // オンメモリへのキャッシュを行う
+                    pathObjectOnMemoryCache[fileUniquePath] = obj;
 
                     lock (writeLock)
                     {

Assets/AutoyaTests/Tests/Persistence/URLCachingImplementationTests.cs

@@ -574,6 +574,7 @@ public IEnumerator Timeout()
         // large picture.
         var imagePath = "https://upload.wikimedia.org/wikipedia/commons/2/2e/Zhao_Chang_-_Picture_of_the_New_Year_-_Google_Art_Project.jpg";
         var loadedFailed = false;
+
         Autoya.Persist_URLCaching_Load<Sprite>(
             AutoyaURLCachingTestsFileDomain,
             imagePath,
@@ -600,7 +601,7 @@ public IEnumerator Timeout()
         yield return WaitUntil(
             () => loadedFailed,
             () => { throw new TimeoutException("timeout."); },
-            1000
+            10
         );
     }
 
@@ -773,5 +774,58 @@ public IEnumerator ExecuteExpirationForManyFiles()
             Assert.False(File.Exists(path), "should not exist.");
         }
     }
+
+    [MTest]
+    public IEnumerator Unload()
+    {
+        // store one image.
+        var loaded = false;
+        var imagePath = "https://upload.wikimedia.org/wikipedia/commons/thumb/9/9e/2016-06-14_Orange_and_white_tabby_cat_born_in_2016_茶トラ白ねこ_DSCF6526☆彡.jpg/400px-2016-06-14_Orange_and_white_tabby_cat_born_in_2016_茶トラ白ねこ_DSCF6526☆彡.jpg?a=b";
+
+        Autoya.Persist_URLCaching_Load(
+            AutoyaURLCachingTestsFileDomain,
+            imagePath,
+            bytes =>
+            {
+                // return sprite from bytes.
+                var tex = new Texture2D(1, 1);
+                tex.LoadImage(bytes);
+                var newSprite = Sprite.Create(tex, new Rect(0, 0, tex.width, tex.height), new Vector2(.5f, .5f));
+                return newSprite;
+            },
+            cached =>
+            {
+                loaded = true;
+            },
+            (code, reason) =>
+            {
+                loaded = true;
+                Fail();
+            }
+        );
+
+        yield return WaitUntil(
+            () => loaded,
+            () => { throw new TimeoutException("timeout for making cache."); }
+        );
+
+        var pathOfCachedImage = Autoya.Persist_URLCaching_PathOf(AutoyaURLCachingTestsFileDomain, imagePath);
+        Assert.True(File.Exists(pathOfCachedImage), "not exist.");
+
+        // キャッシュ done.
+
+        Autoya.Persist_URLCaching_Unload(
+            AutoyaURLCachingTestsFileDomain,
+            imagePath,
+            true
+        );
+
+        var isLoaded = Autoya.Persist_URLCaching_IsLoaded(
+            AutoyaURLCachingTestsFileDomain,
+            imagePath
+        );
+
+        Assert.True(!isLoaded, "failed to unload.");
+    }
 }
 

Assets/Editor/AssetGraph-1.4-release/UnityEngine.AssetGraph/Cache/TemporalSettingFiles/AssetReferenceDB.asset

@@ -13,10 +13,6 @@ MonoBehaviour:
   m_Name: AssetReferenceDB
   m_EditorClassIdentifier: 
   m_assets:
-  - m_assetDatabaseId: 526cdb84319594850bae31788e91464d
-    m_importFrom: Assets/Autoya/Persistence/URLCaching/URLCaching.cs
-    m_exportTo: 
-    m_variantName: 
   - m_assetDatabaseId: 269a7412e7d2a4bee9fa6e819ae61e8a
     m_importFrom: Assets/Autoya/Manifest/ShouldGitIgnore/Resources/BuildManifest.json
     m_exportTo: 
@@ -25,8 +21,4 @@ MonoBehaviour:
     m_importFrom: Assets/Editor/AssetGraph-1.4-release/UnityEngine.AssetGraph/Cache/TemporalSettingFiles/AssetReferenceDB.asset
     m_exportTo: 
     m_variantName: 
-  - m_assetDatabaseId: ec5ec1496f4ed40b9a67e5b76a534e22
-    m_importFrom: Assets/AutoyaTests/RuntimeData/AssetBundles/MainResources/nestedPrefab.prefab
-    m_exportTo: 
-    m_variantName: 
   m_version: 2