Replaced ImageCacheItem by Tuple

This commit is contained in:
Clemens 2021-07-02 15:57:01 +02:00
parent 2709f90cdc
commit 77c2169999
14 changed files with 60 additions and 122 deletions

View file

@ -13,7 +13,7 @@ namespace MapControl.Caching
{
/// <summary>
/// Image Cache implementation based on local image files.
/// The only valid data type for cached values is ImageCacheItem.
/// The only valid data type for cached values is Tuple<byte[], DateTime>.
/// </summary>
public partial class ImageFileCache
{

View file

@ -13,15 +13,6 @@ using System.Threading.Tasks;
namespace MapControl
{
namespace Caching
{
public class ImageCacheItem
{
public byte[] Buffer { get; set; }
public DateTime Expiration { get; set; }
}
}
#if NETFRAMEWORK
static class ConcurrentQueueEx
{

View file

@ -11,9 +11,9 @@ namespace MapControl.Caching
{
public partial class ImageFileCache : IImageCache
{
public async Task<ImageCacheItem> GetAsync(string key)
public async Task<Tuple<byte[], DateTime>> GetAsync(string key)
{
ImageCacheItem cacheItem = null;
Tuple<byte[], DateTime> cacheItem = null;
var path = GetPath(key);
try
@ -23,13 +23,7 @@ namespace MapControl.Caching
var buffer = await File.ReadAllBytesAsync(path);
var expiration = ReadExpiration(ref buffer);
cacheItem = new ImageCacheItem
{
Buffer = buffer,
Expiration = expiration
};
//Debug.WriteLine("ImageFileCache: Read {0}, Expires {1}", path, expiration.ToLocalTime());
cacheItem = Tuple.Create(buffer, expiration);
}
}
catch (Exception ex)
@ -40,11 +34,11 @@ namespace MapControl.Caching
return cacheItem;
}
public async Task SetAsync(string key, ImageCacheItem cacheItem)
public async Task SetAsync(string key, byte[] buffer, DateTime expiration)
{
var path = GetPath(key);
if (cacheItem.Buffer != null && cacheItem.Buffer.Length > 0 && path != null)
if (buffer != null && buffer.Length > 0 && path != null)
{
try
{
@ -52,11 +46,9 @@ namespace MapControl.Caching
using (var stream = File.Create(path))
{
await stream.WriteAsync(cacheItem.Buffer, 0, cacheItem.Buffer.Length);
await WriteExpirationAsync(stream, cacheItem.Expiration);
await stream.WriteAsync(buffer, 0, buffer.Length);
await WriteExpirationAsync(stream, expiration);
}
//Debug.WriteLine("ImageFileCache: Wrote {0}, Expires {1}", path, expiration.ToLocalTime());
}
catch (Exception ex)
{

View file

@ -4,7 +4,6 @@
using System;
using System.Threading.Tasks;
using MapControl.Caching;
#if WINDOWS_UWP
using Windows.UI.Core;
using Windows.UI.Xaml.Media;
@ -19,9 +18,9 @@ namespace MapControl
{
public interface IImageCache
{
Task<ImageCacheItem> GetAsync(string key);
Task<Tuple<byte[], DateTime>> GetAsync(string key);
Task SetAsync(string key, ImageCacheItem cacheItem);
Task SetAsync(string key, byte[] buffer, DateTime expiration);
}
}
@ -39,15 +38,15 @@ namespace MapControl
/// <summary>
/// The IImageCache implementation used to cache tile images. The default is null.
/// </summary>
public static IImageCache Cache { get; set; }
public static Caching.IImageCache Cache { get; set; }
private static async Task LoadCachedTileAsync(Tile tile, Uri uri, string cacheKey)
{
var cacheItem = await Cache.GetAsync(cacheKey).ConfigureAwait(false);
var buffer = cacheItem?.Buffer;
var buffer = cacheItem?.Item1;
if (cacheItem == null || cacheItem.Expiration < DateTime.UtcNow)
if (cacheItem == null || cacheItem.Item2 < DateTime.UtcNow)
{
var response = await ImageLoader.GetHttpResponseAsync(uri).ConfigureAwait(false);
@ -55,15 +54,10 @@ namespace MapControl
{
buffer = response.Buffer; // may be null or empty when no tile available, but still be cached
cacheItem = new ImageCacheItem
{
Buffer = buffer,
Expiration = GetExpiration(response.MaxAge)
};
await Cache.SetAsync(cacheKey, cacheItem).ConfigureAwait(false);
await Cache.SetAsync(cacheKey, buffer, GetExpiration(response.MaxAge)).ConfigureAwait(false);
}
}
else System.Diagnostics.Debug.WriteLine("Cached: " + cacheKey);
if (buffer != null && buffer.Length > 0)
{

View file

@ -95,7 +95,7 @@ namespace MapControl.Caching
throw new ArgumentNullException(nameof(key));
}
var cacheItem = memoryCache.Get(key) as ImageCacheItem;
var cacheItem = memoryCache.Get(key) as Tuple<byte[], DateTime>;
if (cacheItem == null)
{
@ -108,15 +108,9 @@ namespace MapControl.Caching
var buffer = File.ReadAllBytes(path);
var expiration = ReadExpiration(ref buffer);
cacheItem = new ImageCacheItem
{
Buffer = buffer,
Expiration = expiration
};
cacheItem = new Tuple<byte[], DateTime>(buffer, expiration);
memoryCache.Set(key, cacheItem, new CacheItemPolicy { AbsoluteExpiration = expiration });
//Debug.WriteLine("ImageFileCache: Read {0}, Expires {1}", path, cacheItem.Expiration.ToLocalTime());
}
}
catch (Exception ex)
@ -152,16 +146,17 @@ namespace MapControl.Caching
throw new ArgumentNullException(nameof(key));
}
if (!(value is ImageCacheItem cacheItem))
if (!(value is Tuple<byte[], DateTime> cacheItem))
{
throw new ArgumentException("The value argument must be a MapControl.Caching.ImageCacheItem instance.", nameof(value));
throw new ArgumentException("The value argument must be a Tuple<byte[], DateTime>.", nameof(value));
}
memoryCache.Set(key, cacheItem, policy);
var buffer = cacheItem.Item1;
var path = GetPath(key);
if (cacheItem.Buffer != null && cacheItem.Buffer.Length > 0 && path != null)
if (buffer != null && buffer.Length > 0 && path != null)
{
try
{
@ -169,16 +164,14 @@ namespace MapControl.Caching
using (var stream = File.Create(path))
{
stream.Write(cacheItem.Buffer, 0, cacheItem.Buffer.Length);
WriteExpiration(stream, cacheItem.Expiration);
stream.Write(buffer, 0, buffer.Length);
WriteExpiration(stream, cacheItem.Item2);
}
var fileInfo = new FileInfo(path);
var fileSecurity = fileInfo.GetAccessControl();
fileSecurity.AddAccessRule(fullControlRule);
fileInfo.SetAccessControl(fileSecurity);
//Debug.WriteLine("ImageFileCache: Wrote {0}, Expires {1}", path, cacheItem.Expiration.ToLocalTime());
}
catch (Exception ex)
{

View file

@ -6,7 +6,6 @@ using System;
using System.IO;
using System.Runtime.Caching;
using System.Threading.Tasks;
using MapControl.Caching;
namespace MapControl
{
@ -21,7 +20,7 @@ namespace MapControl
}
/// <summary>
/// An ObjectCache instance used to cache tile image data (i.e. ImageCacheItem objects).
/// An ObjectCache instance used to cache tile image data, i.e. (byte[],DateTime) tuples.
/// The default ObjectCache value is MemoryCache.Default.
/// </summary>
public static ObjectCache Cache { get; set; } = MemoryCache.Default;
@ -29,26 +28,23 @@ namespace MapControl
private static async Task LoadCachedTileAsync(Tile tile, Uri uri, string cacheKey)
{
var cacheItem = Cache.Get(cacheKey) as ImageCacheItem;
var buffer = cacheItem?.Buffer;
var cacheItem = Cache.Get(cacheKey) as Tuple<byte[], DateTime>;
var buffer = cacheItem?.Item1;
if (cacheItem == null || cacheItem.Expiration < DateTime.UtcNow)
if (cacheItem == null || cacheItem.Item2 < DateTime.UtcNow)
{
var response = await ImageLoader.GetHttpResponseAsync(uri).ConfigureAwait(false);
if (response != null) // download succeeded
{
buffer = response.Buffer;
buffer = response.Buffer; // may be null or empty when no tile available, but still be cached
cacheItem = new ImageCacheItem
{
Buffer = buffer, // may be null or empty when no tile available, but still be cached
Expiration = GetExpiration(response.MaxAge)
};
cacheItem = Tuple.Create(buffer, GetExpiration(response.MaxAge));
Cache.Set(cacheKey, cacheItem, new CacheItemPolicy { AbsoluteExpiration = cacheItem.Expiration });
Cache.Set(cacheKey, cacheItem, new CacheItemPolicy { AbsoluteExpiration = cacheItem.Item2 });
}
}
else System.Diagnostics.Debug.WriteLine("Cached: " + cacheKey);
if (buffer != null && buffer.Length > 0)
{