Introduce MessagePack serializer

Author: cnblogs-dudu

README.md

@@ -12,7 +12,8 @@ This is a .NET Core client library for Memcached migrated from [EnyimMemcached](
         "Address": "memcached",
         "Port": 11211
       }
-    ]
+    ],
+    "Transcoder": "MessagePackTranscoder"
   }
 }
 ```

sample/SampleWebApp/Controllers/HomeController.cs

@@ -48,7 +48,7 @@ public async Task<IActionResult> Index()
 
         public async Task<IActionResult> Postbody()
         {
-            var postbody = (await _blogPostService.GetRecent(10)).First()?.Body;
+            var postbody = (await _blogPostService.GetRecent(10)).First().Value.FirstOrDefault()?.Body;
             await _postbodyMemcachedClient.AddAsync(PostbodyCacheKey, postbody, 10);
             var result = await _postbodyMemcachedClient.GetAsync<string>(PostbodyCacheKey);
             return result.Success ? Ok() : StatusCode(500);

sample/SampleWebApp/Services/BlogPostService.cs

@@ -8,9 +8,21 @@ namespace Enyim.Caching.SampleWebApp.Services
 {
     public class BlogPostService : IBlogPostService
     {
-        public async ValueTask<IEnumerable<BlogPost>> GetRecent(int itemCount)
+        public async ValueTask<Dictionary<string, List<BlogPost>>> GetRecent(int itemCount)
         {
-            return new List<BlogPost> { new BlogPost { Title = "Hello World", Body = "EnyimCachingCore" } };
+            var dict = new Dictionary<string, List<BlogPost>>();
+            var posts = new List<BlogPost>
+            {
+                new BlogPost
+                {
+                    Title = "Hello World",
+                    Body = "EnyimCachingCore"
+                }
+            };
+
+            dict.Add(DateTime.Today.ToString("yyyy-MM-dd"), posts);
+
+            return dict;
         }
     }
 }

sample/SampleWebApp/Services/IBlogPostService.cs

@@ -8,6 +8,6 @@ namespace Enyim.Caching.SampleWebApp.Services
 {
     public interface IBlogPostService
     {
-        ValueTask<IEnumerable<BlogPost>> GetRecent(int itemCount);
+        ValueTask<Dictionary<string, List<BlogPost>>> GetRecent(int itemCount);
     }
 }

sample/SampleWebApp/appsettings.json

@@ -14,8 +14,8 @@
       "deadTimeout": "00:00:15",
       "queueTimeout": "00:00:00.150"
     },
-    "suppressException": "false"
-    //"Transcoder": "BinaryFormatterTranscoder"
+    "suppressException": "false",
+    "Transcoder": "MessagePackTranscoder"
     //,
     //"KeyTransformer": "Enyim.Caching.Memcached.SHA1KeyTransformer"
     //,
@@ -44,7 +44,7 @@
       "Default": "Warning",
       "System": "Warning",
       "Microsoft": "Warning",
-      "Enyim": "Debug"
+      "Enyim": "Warning"
     }
   }
 }

src/Enyim.Caching/Configuration/MemcachedClientConfiguration.cs

@@ -9,6 +9,7 @@
 using Microsoft.Extensions.Configuration;
 using System.Linq;
 using System.Net.Sockets;
+using Enyim.Caching.Memcached.Transcoders;
 
 namespace Enyim.Caching.Configuration
 {
@@ -150,8 +151,14 @@ public MemcachedClientConfiguration(
             {
                 try
                 {
-                    if (options.Transcoder == "BinaryFormatterTranscoder")
+                    if (options.Transcoder == nameof(BinaryFormatterTranscoder))
+                    {
                         options.Transcoder = "Enyim.Caching.Memcached.Transcoders.BinaryFormatterTranscoder";
+                    }
+                    else if (options.Transcoder == nameof(MessagePackTranscoder))
+                    {
+                        options.Transcoder = "Enyim.Caching.Memcached.Transcoders.MessagePackTranscoder";
+                    }
 
                     var transcoderType = Type.GetType(options.Transcoder);
                     if (transcoderType != null)
@@ -168,7 +175,7 @@ public MemcachedClientConfiguration(
             else if (transcoder != null)
             {
                 _transcoder = transcoder;
-                _logger.LogDebug($"Use Transcoder Type : '{transcoder.ToString()}'");
+                _logger.LogDebug($"Use Transcoder Type : '{transcoder}'");
             }
 
             if (options.NodeLocatorFactory != null)

src/Enyim.Caching/Enyim.Caching.csproj

@@ -42,4 +42,8 @@
       </ItemGroup>
     </Otherwise>
   </Choose>
+
+  <ItemGroup>
+    <PackageReference Include="MessagePack" Version="2.4.59" />
+  </ItemGroup>
 </Project>

src/Enyim.Caching/IMemcachedClient.cs

@@ -29,15 +29,18 @@ public interface IMemcachedClient : IDisposable
         Task<bool> ReplaceAsync(string key, object value, uint cacheSeconds);
         Task<bool> ReplaceAsync(string key, object value, TimeSpan timeSpan);
 
+        [Obsolete("Use GetAsync<T> instead")]
         Task<IGetOperationResult> GetAsync(string key);
         Task<IGetOperationResult<T>> GetAsync<T>(string key);
         Task<T> GetValueAsync<T>(string key);
         Task<T> GetValueOrCreateAsync<T>(string key, int cacheSeconds, Func<Task<T>> generator);
+        [Obsolete("Use Get<T> instead")]
         object Get(string key);
         T Get<T>(string key);
         IDictionary<string, T> Get<T>(IEnumerable<string> keys);
         Task<IDictionary<string, T>> GetAsync<T>(IEnumerable<string> keys);
 
+        [Obsolete("Use TryGet<T> instead")]
         bool TryGet(string key, out object value);
         bool TryGet<T>(string key, out T value);
         bool TryGetWithCas(string key, out CasResult<object> value);

src/Enyim.Caching/Memcached/Transcoders/MessagePackTranscoder.cs

@@ -0,0 +1,77 @@
+using MessagePack;
+using MessagePack.Resolvers;
+using Microsoft.Extensions.Options;
+using Newtonsoft.Json.Bson;
+using Newtonsoft.Json.Linq;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.IO;
+using System.Reflection;
+using System.Runtime.CompilerServices;
+using System.Text;
+
+namespace Enyim.Caching.Memcached.Transcoders
+{
+    public class MessagePackTranscoder : DefaultTranscoder
+    {
+        private readonly MessagePackSerializerOptions _options;
+
+        public MessagePackTranscoder() : this(CreateDefaultOptions())
+        {
+        }
+
+        public MessagePackTranscoder(MessagePackSerializerOptions options)
+        {
+            _options = options ?? CreateDefaultOptions();
+        }
+
+        protected override ArraySegment<byte> SerializeObject(object value)
+        {
+            var bytes = MessagePackSerializer.Serialize(value, _options);
+            return new ArraySegment<byte>(bytes, 0, bytes.Length);
+        }
+
+        protected override object DeserializeObject(ArraySegment<byte> value)
+        {
+            throw new NotSupportedException("Does not support typeless deserialization. Please use generic api.");
+        }
+
+        public override T Deserialize<T>(CacheItem item)
+        {
+            if (typeof(T).GetTypeCode() != TypeCode.Object || typeof(T) == typeof(byte[]))
+            {
+                var value = Deserialize(item);
+                if (value != null)
+                {
+                    if (typeof(T) == typeof(Guid))
+                    {
+                        return (T)(object)new Guid((string)value);
+                    }
+                    else
+                    {
+                        return (T)value;
+                    }
+                }
+                else
+                {
+                    return default;
+                }
+            }
+
+            return MessagePackSerializer.Deserialize<T>(item.Data, _options);
+        }
+
+        private static MessagePackSerializerOptions CreateDefaultOptions()
+        {
+            var resolver = CompositeResolver.Create(
+                NativeDateTimeResolver.Instance,
+                NativeGuidResolver.Instance,
+                NativeDecimalResolver.Instance,
+                ContractlessStandardResolverAllowPrivate.Instance,
+                ContractlessStandardResolver.Instance);
+            return MessagePackSerializerOptions.Standard.WithResolver(resolver);
+        }
+    }
+}

test/DistributedCacheTests/appsettings.json

@@ -5,6 +5,7 @@
         "Address": "memcached",
         "Port": 11211
       }
-    ]
+    ],
+    "Transcoder": "MessagePackTranscoder"
   }
 }